{ "resourceType" : "StructureDefinition", "id" : "HealthLinkPayload", "text" : { "status" : "extensions", "div" : "

Generated Narrative: StructureDefinition HealthLinkPayload

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" HealthLinkPayload 0..*BaseHealth Link Payload (DRAFT)
\".\"\".\"\".\" url 1..1stringurl
\".\"\".\"\".\" key 1..1stringDecryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.
\".\"\".\"\".\" exp 0..1stringOptional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)
\".\"\".\"\".\" flag 0..1stringOptional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n</ul>\n
\".\"\".\"\".\" label 0..1stringOptional. String no longer than 80 characters that provides a short description of the data behind the Health Link.
\".\"\".\"\".\" v 0..1stringOptional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.
\".\"\".\"\".\" type 0..1codeClassifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.

\"doco\" Documentation for this format
" }, "url" : "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload", "version" : "1.1.6", "name" : "HealthLinkPayload", "title" : "Health Link Payload (DRAFT)", "status" : "draft", "date" : "2025-02-21T10:09:05+00:00", "publisher" : "WHO", "contact" : [{ "name" : "WHO", "telecom" : [{ "system" : "url", "value" : "http://who.int" }] }], "description" : "Health Link Payload (DRAFT)\n\nA Health Link URI is generated from this payload according to the algorithm documented [here](https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-links-sharing-application-generates-a-smart-health-link-uri)\n\n", "jurisdiction" : [{ "coding" : [{ "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm", "code" : "001" }] }], "fhirVersion" : "4.0.1", "kind" : "logical", "abstract" : false, "type" : "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base", "derivation" : "specialization", "snapshot" : { "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString" : "4.0.1" }], "element" : [{ "id" : "HealthLinkPayload", "path" : "HealthLinkPayload", "short" : "Health Link Payload (DRAFT)", "definition" : "Health Link Payload (DRAFT)\n\nA Health Link URI is generated from this payload according to the algorithm documented [here](https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-links-sharing-application-generates-a-smart-health-link-uri)\n\n", "min" : 0, "max" : "*", "base" : { "path" : "Base", "min" : 0, "max" : "*" }, "isModifier" : false }, { "id" : "HealthLinkPayload.url", "path" : "HealthLinkPayload.url", "short" : "url", "definition" : "Manifest URL for this Health Link", "min" : 1, "max" : "1", "base" : { "path" : "HealthLinkPayload.url", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.key", "path" : "HealthLinkPayload.key", "short" : "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.", "definition" : "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.", "min" : 1, "max" : "1", "base" : { "path" : "HealthLinkPayload.key", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.exp", "path" : "HealthLinkPayload.exp", "short" : "Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)", "definition" : "Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)", "min" : 0, "max" : "1", "base" : { "path" : "HealthLinkPayload.exp", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.flag", "path" : "HealthLinkPayload.flag", "short" : "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n ", "definition" : "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n", "min" : 0, "max" : "1", "base" : { "path" : "HealthLinkPayload.flag", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.label", "path" : "HealthLinkPayload.label", "short" : "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.", "definition" : "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.", "min" : 0, "max" : "1", "base" : { "path" : "HealthLinkPayload.label", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.v", "path" : "HealthLinkPayload.v", "short" : "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.", "definition" : "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.", "min" : 0, "max" : "1", "base" : { "path" : "HealthLinkPayload.v", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.type", "path" : "HealthLinkPayload.type", "short" : "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.", "definition" : "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.", "min" : 0, "max" : "1", "base" : { "path" : "HealthLinkPayload.type", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }] }] }, "differential" : { "element" : [{ "id" : "HealthLinkPayload", "path" : "HealthLinkPayload", "short" : "Health Link Payload (DRAFT)", "definition" : "Health Link Payload (DRAFT)\n\nA Health Link URI is generated from this payload according to the algorithm documented [here](https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-links-sharing-application-generates-a-smart-health-link-uri)\n\n" }, { "id" : "HealthLinkPayload.url", "path" : "HealthLinkPayload.url", "short" : "url", "definition" : "Manifest URL for this Health Link", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.key", "path" : "HealthLinkPayload.key", "short" : "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.", "definition" : "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.exp", "path" : "HealthLinkPayload.exp", "short" : "Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)", "definition" : "Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.flag", "path" : "HealthLinkPayload.flag", "short" : "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n ", "definition" : "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n ", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.label", "path" : "HealthLinkPayload.label", "short" : "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.", "definition" : "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.v", "path" : "HealthLinkPayload.v", "short" : "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.", "definition" : "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "HealthLinkPayload.type", "path" : "HealthLinkPayload.type", "short" : "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.", "definition" : "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.", "min" : 0, "max" : "1", "type" : [{ "code" : "code" }] }] } }