{ "description": "Verifiable Health Link Payload (DRAFT)\\n\\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\\n", "_filename": "StructureDefinition-VerifiableHealthLinkPayload.json", "package_name": "smart.who.int.trust-phw", "date": "2025-10-07T06:40:24+00:00", "derivation": "specialization", "publisher": "WHO", "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "001", "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "display": "World" } ] } ], "name": "VerifiableHealthLinkPayload", "abstract": false, "type": "http://smart.who.int/trust-phw/StructureDefinition/VerifiableHealthLinkPayload", "experimental": null, "resourceType": "StructureDefinition", "title": "Verifiable Health Link Payload (DRAFT)", "package_version": "0.1.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics", "valueCode": "can-be-target" } ], "snapshot": { "element": [ { "id": "VerifiableHealthLinkPayload", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "Base" }, "path": "VerifiableHealthLinkPayload", "short": "Verifiable Health Link Payload (DRAFT)", "definition": "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n", "isModifier": false }, { "id": "VerifiableHealthLinkPayload.url", "max": "1", "min": 1, "base": { "max": "1", "min": 1, "path": "HealthLinkPayload.url" }, "path": "VerifiableHealthLinkPayload.url", "type": [ { "code": "string" } ], "short": "url", "definition": "Manifest URL for this Health Link" }, { "id": "VerifiableHealthLinkPayload.key", "max": "1", "min": 1, "base": { "max": "1", "min": 1, "path": "HealthLinkPayload.key" }, "path": "VerifiableHealthLinkPayload.key", "type": [ { "code": "string" } ], "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." }, { "id": "VerifiableHealthLinkPayload.exp", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "HealthLinkPayload.exp" }, "path": "VerifiableHealthLinkPayload.exp", "type": [ { "code": "string" } ], "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.)" }, { "id": "VerifiableHealthLinkPayload.flag", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "HealthLinkPayload.flag" }, "path": "VerifiableHealthLinkPayload.flag", "type": [ { "code": "string" } ], "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." }, { "id": "VerifiableHealthLinkPayload.label", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "HealthLinkPayload.label" }, "path": "VerifiableHealthLinkPayload.label", "type": [ { "code": "string" } ], "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." }, { "id": "VerifiableHealthLinkPayload.v", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "HealthLinkPayload.v" }, "path": "VerifiableHealthLinkPayload.v", "type": [ { "code": "string" } ], "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." }, { "path": "VerifiableHealthLinkPayload.type", "min": 1, "definition": "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.", "short": "Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link.", "type": [ { "code": "code" } ], "binding": { "strength": "preferred", "valueSet": "http://smart.who.int/trust-phw/ValueSet/HL.TYPE" }, "max": "1", "id": "VerifiableHealthLinkPayload.type", "base": { "max": "1", "min": 0, "path": "HealthLinkPayload.type" } } ], "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "0.1.0" } ] }, "status": "active", "id": "fba54e13-018e-4174-97cb-c1118ca546dd", "kind": "logical", "url": "http://smart.who.int/trust-phw/StructureDefinition/VerifiableHealthLinkPayload", "version": "0.1.0", "differential": { "element": [ { "id": "VerifiableHealthLinkPayload", "path": "VerifiableHealthLinkPayload", "short": "Verifiable Health Link Payload (DRAFT)", "definition": "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n" }, { "id": "VerifiableHealthLinkPayload.type", "min": 1, "path": "VerifiableHealthLinkPayload.type", "binding": { "strength": "preferred", "valueSet": "http://smart.who.int/trust-phw/ValueSet/HL.TYPE" } } ] }, "contact": [ { "name": "WHO", "telecom": [ { "value": "http://who.int", "system": "url" } ] } ], "baseDefinition": "http://smart.who.int/trust-phw/StructureDefinition/HealthLinkPayload" }