{
"description": "Data elements for the Smart Health Cards Core Data Set.",
"_filename": "StructureDefinition-CertSHC.json",
"package_name": "who.ddcc",
"date": "2024-10-15T11:00:36+02:00",
"derivation": "specialization",
"publisher": "WHO",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"name": "CertSHC",
"abstract": true,
"type": "http://smart.who.int/ddcc/StructureDefinition/CertSHC",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Certificate - Smart Health Card's JSon Web Token Logical Model",
"package_version": "1.0.0",
"snapshot": {
"element": [ {
"id": "CertSHC",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Base"
},
"path": "CertSHC",
"short": "Certificate - Smart Health Card's JSon Web Token Logical Model",
"definition": "Data elements for the Smart Health Cards Core Data Set.",
"isModifier": false
}, {
"id": "CertSHC.iss",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.iss"
},
"path": "CertSHC.iss",
"type": [ {
"code": "string"
} ],
"short": "Issuer",
"definition": "Issuer"
}, {
"id": "CertSHC.sub",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.sub"
},
"path": "CertSHC.sub",
"type": [ {
"code": "string"
} ],
"short": "Subject",
"definition": "Subject"
}, {
"id": "CertSHC.aud",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.aud"
},
"path": "CertSHC.aud",
"type": [ {
"code": "string"
} ],
"short": "Audience",
"definition": "Audience"
}, {
"id": "CertSHC.exp",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.exp"
},
"path": "CertSHC.exp",
"type": [ {
"code": "decimal"
} ],
"short": "Expiration Date",
"definition": "Expiration Date"
}, {
"id": "CertSHC.nbf",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.nbf"
},
"path": "CertSHC.nbf",
"type": [ {
"code": "decimal"
} ],
"short": "Not before Date",
"definition": "Not before Date"
}, {
"id": "CertSHC.iat",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.iat"
},
"path": "CertSHC.iat",
"type": [ {
"code": "decimal"
} ],
"short": "Issued at Date",
"definition": "Issued at Date"
}, {
"id": "CertSHC.jti",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.jti"
},
"path": "CertSHC.jti",
"type": [ {
"code": "string"
} ],
"short": "Credential's Unique Identifier",
"definition": "Credential's Unique Identifier"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CertSHC.vc",
"min": 0,
"definition": "VC - verifiable credential",
"short": "VC - verifiable credential",
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "CertSHC.vc",
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.vc"
}
}, {
"path": "CertSHC.vc.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CertSHC.vc.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CertSHC.vc.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CertSHC.vc.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CertSHC.vc.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CertSHC.vc.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "CertSHC.vc.type",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CertSHC.vc.type"
},
"path": "CertSHC.vc.type",
"type": [ {
"code": "string"
} ],
"short": "Credential Type",
"definition": "Credential Type"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CertSHC.vc.credentialSubject",
"min": 0,
"definition": "Credential Subject",
"short": "Credential Subject",
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "CertSHC.vc.credentialSubject",
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.vc.credentialSubject"
}
}, {
"path": "CertSHC.vc.credentialSubject.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CertSHC.vc.credentialSubject.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CertSHC.vc.credentialSubject.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CertSHC.vc.credentialSubject.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CertSHC.vc.credentialSubject.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CertSHC.vc.credentialSubject.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "CertSHC.vc.credentialSubject.fhirVersion",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.vc.credentialSubject.fhirVersion"
},
"path": "CertSHC.vc.credentialSubject.fhirVersion",
"type": [ {
"code": "string"
} ],
"short": "Fhir Version",
"definition": "Fhir Version"
}, {
"id": "CertSHC.vc.credentialSubject.fhirBundle",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CertSHC.vc.credentialSubject.fhirBundle"
},
"path": "CertSHC.vc.credentialSubject.fhirBundle",
"type": [ {
"code": "Bundle"
} ],
"short": "Fhir Bundle with the signed objects",
"definition": "Fhir Bundle with the signed objects"
} ]
},
"status": "draft",
"id": "5e06dff2-a253-471a-ae4f-ef17edf7be93",
"kind": "logical",
"url": "http://smart.who.int/ddcc/StructureDefinition/CertSHC",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "CertSHC",
"path": "CertSHC",
"short": "Certificate - Smart Health Card's JSon Web Token Logical Model",
"definition": "Data elements for the Smart Health Cards Core Data Set."
}, {
"id": "CertSHC.iss",
"max": "1",
"min": 0,
"path": "CertSHC.iss",
"type": [ {
"code": "string"
} ],
"short": "Issuer",
"definition": "Issuer"
}, {
"id": "CertSHC.sub",
"max": "1",
"min": 0,
"path": "CertSHC.sub",
"type": [ {
"code": "string"
} ],
"short": "Subject",
"definition": "Subject"
}, {
"id": "CertSHC.aud",
"max": "1",
"min": 0,
"path": "CertSHC.aud",
"type": [ {
"code": "string"
} ],
"short": "Audience",
"definition": "Audience"
}, {
"id": "CertSHC.exp",
"max": "1",
"min": 0,
"path": "CertSHC.exp",
"type": [ {
"code": "decimal"
} ],
"short": "Expiration Date",
"definition": "Expiration Date"
}, {
"id": "CertSHC.nbf",
"max": "1",
"min": 0,
"path": "CertSHC.nbf",
"type": [ {
"code": "decimal"
} ],
"short": "Not before Date",
"definition": "Not before Date"
}, {
"id": "CertSHC.iat",
"max": "1",
"min": 0,
"path": "CertSHC.iat",
"type": [ {
"code": "decimal"
} ],
"short": "Issued at Date",
"definition": "Issued at Date"
}, {
"id": "CertSHC.jti",
"max": "1",
"min": 0,
"path": "CertSHC.jti",
"type": [ {
"code": "string"
} ],
"short": "Credential's Unique Identifier",
"definition": "Credential's Unique Identifier"
}, {
"id": "CertSHC.vc",
"max": "1",
"min": 0,
"path": "CertSHC.vc",
"type": [ {
"code": "BackboneElement"
} ],
"short": "VC - verifiable credential",
"definition": "VC - verifiable credential"
}, {
"id": "CertSHC.vc.type",
"max": "*",
"min": 0,
"path": "CertSHC.vc.type",
"type": [ {
"code": "string"
} ],
"short": "Credential Type",
"definition": "Credential Type"
}, {
"id": "CertSHC.vc.credentialSubject",
"max": "1",
"min": 0,
"path": "CertSHC.vc.credentialSubject",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Credential Subject",
"definition": "Credential Subject"
}, {
"id": "CertSHC.vc.credentialSubject.fhirVersion",
"max": "1",
"min": 0,
"path": "CertSHC.vc.credentialSubject.fhirVersion",
"type": [ {
"code": "string"
} ],
"short": "Fhir Version",
"definition": "Fhir Version"
}, {
"id": "CertSHC.vc.credentialSubject.fhirBundle",
"max": "1",
"min": 0,
"path": "CertSHC.vc.credentialSubject.fhirBundle",
"type": [ {
"code": "Bundle"
} ],
"short": "Fhir Bundle with the signed objects",
"definition": "Fhir Bundle with the signed objects"
} ]
},
"contact": [ {
"name": "WHO",
"telecom": [ {
"value": "http://who.int",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base"
}