Skip to content

Commit

Permalink
added SHL data models
Browse files Browse the repository at this point in the history
  • Loading branch information
litlfred committed Apr 25, 2024
1 parent 0b512fe commit f001541
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
13 changes: 13 additions & 0 deletions input/fsh/models/SmartHealthLink.fsh
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Logical: SmartHealthLink
Title: "Smart Health Link (DRAFT)"
Description: "Smart Health Link URI (DRAFT)

Logical Model to represent a SMART Health Link as its URI. It is generated from the content of the SMART Health Link Payload.


"

* ^url = "http://smart.who.int/trust/StructureDefinition/SmartHealthLink"
* ^version = "RC2"
* ^status = #draft
* u 1..1 string "URI" "URI of the Smart Health Link. Should look like 'shlink:/eyJ1cmwiOiJodHRwczovL2Vo....' "
24 changes: 24 additions & 0 deletions input/fsh/models/SmartHealthLinkPayload.fsh
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Logical: SmartHealthLinkPayload
Title: "Smart Health Link Payload (DRAFT)"
Description: "Smart Health Link Payload (DRAFT)

This logical model was taken from the SMART Health Link documentation <https://docs.smarthealthit.org/smart-health-links/spec#construct-a-shlink-payload> as if 30 November 2023.

A [[ SMART Health Link]] is generated from this payload according to the algorithm documented here <https://docs.smarthealthit.org/smart-health-links/spec#example-shlink-generation> to create a

It is generated

"

* ^url = "http://smart.who.int/trust/StructureDefinition/SmartHealthLinkPayload"
* ^version = "RC2"
* ^status = #draft
* url 1..1 string "url" "Manifest URL for this SHLink"
* key 1..1 string "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded."
* exp 0..1 string "Optional. Number representing expiration time in Epoch seconds, as a hint to help the SHL Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)"
* flag 0..1 string "Optional. String created by concatenating single-character flags in alphabetical order
L Indicates the SHLink is intended for long-term use and manifest content can evolve over time
P Indicates the SHLink requires a Passcode to resolves
U Indicates the SHLink's url resolves to a single encrypted file accessible via GET, bypassing the manifest. SHALL NOT be used in combination with P."
* label 0..1 string "Optional. String no longer than 80 characters that provides a short description of the data behind the SHLink."
* v 0..1 string "Optional. Integer representing the SHLinks protocol version this SHLink conforms to. MAY be omitted when the default value (1) applies."
3 changes: 1 addition & 2 deletions input/fsh/models/hcert.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ Alias: $IPS = http://hl7.org/fhir/uv/ips/StructureDefinition/Bundle-uv-ips
Alias: $HCertDCC = http://smart.who.int/ddcc/StructureDefinition/HCertDCC
Alias: $DDCCVS = http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet.VS
Alias: $DDCCTR = http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet.TR
Alias: $SmartHealthLink = http://smart.who.int/ips-pilgrimage/StructureDefinition/SmartHealthLink

Logical: HCert
Title: "Health Certificate"
Expand All @@ -27,6 +26,6 @@ Description: "Logical Model for the HCERT"
//* 2 0..* $RACSEL_DDVC "RACSEL Vaccination Certficate Data Set claim" "RACSEL Vaccination Certificate (PROPOSED)"
* 3 0..* $DDCCVS "Vaccination Core Data Set claim" "DDCC Vaccination claim (PROPOSED)"
* 4 0..* $DDCCTR "Test Result Core Data Set claim" "DDCC Test Result claim (PROPOSED)"
* 5 0..* $SmartHealthLink "SMART Health Link claim" "SMART Health Link"
* 5 0..* SmartHealthLink "SMART Health Link claim" "SMART Health Link"
//* 6 0..* $IPS "IPS" "IPS Bundle (EXAMPLE)"

0 comments on commit f001541

Please sign in to comment.