SMART Health Cards: Vaccination & Testing Implementation Guide
1.0.0 - STU1

SMART Health Cards: Vaccination &amp; Testing Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-shc-vaccination-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Patient Profile - General - Data Minimization

Official URL: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-patient-general-dm | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 4 | Computable Name: SHCPatientGeneralDM

Defines a primary (DM) profile representing a patient in a health card related to infectious disease vaccination and testing issued in jurisdictions where no jurisdiction-specific profile is available.

See here for implementation details.

↓ Start here!

Usages:

- Derived from this Profile: Patient Profile - United States - Data Minimization
- Use this Profile: COVID-19-specific Laboratory Test Results Bundle - Data Minimization, Infectious Disease (Generic) Laboratory Test Results Bundle - Data Minimization and Vaccination Bundle - Data Minimization

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | SHCPatientGeneralAD | Information about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
name | S Σ C | 1..1 | HumanName | Official name (i.e., legal name) of patient Constraints: vc-name-invariant
extension |  | 0..0 |  |
family | S Σ | 0..1 | string | Family name (often called 'Surname')
given | S Σ | 0..* | string | Parts of patient's name other than their family name that appear on photo ID; e.g., first and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
birthDate | S Σ | 0..1 | date | The date of birth for the individual
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vc-name-invariant | error | Patient.name | Require one of the key name elements to be filled. Allows for `text` for names that cannot be cleanly categorized into `family` and `given` (https://www.nature.com/articles/d41586-020-02761-z). : (family.exists() and given.exists()) xor text.exists() |

This structure is derived from SHCPatientGeneralAD

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  |  | SHCPatientGeneralAD |
id |  | 0..0 |  |
meta |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
active |  | 0..0 |  |
name |  | 1..1 | HumanName | Official name (i.e., legal name) of patient
id |  | 0..0 |  |
extension |  | 0..0 |  |
use |  | 0..0 |  |
telecom |  | 0..0 |  |
deceased[x] |  | 0..0 |  |
address |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
multipleBirth[x] |  | 0..0 |  |
communication |  | 0..0 |  |
generalPractitioner |  | 0..0 |  |
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | SHCPatientGeneralAD | Information about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
identifier | Σ | 0..* | Identifier | An identifier for this patient
name | S Σ C | 1..1 | HumanName | Official name (i.e., legal name) of patient Constraints: vc-name-invariant
extension |  | 0..0 |  |
text | Σ | 0..1 | string | Use instead of `family` and `given` if the patient's name cannot be easily split into these elements
family | S Σ | 0..1 | string | Family name (often called 'Surname')
given | S Σ | 0..* | string | Parts of patient's name other than their family name that appear on photo ID; e.g., first and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
gender | Σ C | 0..1 | code | Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Constraints: use-only-if-required-by-law
birthDate | S Σ | 0..1 | date | The date of birth for the individual
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
use-only-if-required-by-law | warning | Patient.gender | SHALL be omitted UNLESS required by law in jurisdiction where SHC is issued : $this.length() = 0 |
vc-name-invariant | error | Patient.name | Require one of the key name elements to be filled. Allows for `text` for names that cannot be cleanly categorized into `family` and `given` (https://www.nature.com/articles/d41586-020-02761-z). : (family.exists() and given.exists()) xor text.exists() |
vc-should-be-omitted-privacy | warning | Patient.telecom.value, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode | SHOULD be omitted to protect privacy and for data minimization. : $this.length() = 0 |

This structure is derived from SHCPatientGeneralAD

Summary

Prohibited: 21 elements

Maturity: 4

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | SHCPatientGeneralAD | Information about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
name | S Σ C | 1..1 | HumanName | Official name (i.e., legal name) of patient Constraints: vc-name-invariant
extension |  | 0..0 |  |
family | S Σ | 0..1 | string | Family name (often called 'Surname')
given | S Σ | 0..* | string | Parts of patient's name other than their family name that appear on photo ID; e.g., first and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
birthDate | S Σ | 0..1 | date | The date of birth for the individual
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vc-name-invariant | error | Patient.name | Require one of the key name elements to be filled. Allows for `text` for names that cannot be cleanly categorized into `family` and `given` (https://www.nature.com/articles/d41586-020-02761-z). : (family.exists() and given.exists()) xor text.exists() |

Differential View

This structure is derived from SHCPatientGeneralAD

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  |  | SHCPatientGeneralAD |
id |  | 0..0 |  |
meta |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
active |  | 0..0 |  |
name |  | 1..1 | HumanName | Official name (i.e., legal name) of patient
id |  | 0..0 |  |
extension |  | 0..0 |  |
use |  | 0..0 |  |
telecom |  | 0..0 |  |
deceased[x] |  | 0..0 |  |
address |  | 0..0 |  |
maritalStatus |  | 0..0 |  |
multipleBirth[x] |  | 0..0 |  |
communication |  | 0..0 |  |
generalPractitioner |  | 0..0 |  |
managingOrganization |  | 0..0 |  |
link |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | SHCPatientGeneralAD | Information about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
identifier | Σ | 0..* | Identifier | An identifier for this patient
name | S Σ C | 1..1 | HumanName | Official name (i.e., legal name) of patient Constraints: vc-name-invariant
extension |  | 0..0 |  |
text | Σ | 0..1 | string | Use instead of `family` and `given` if the patient's name cannot be easily split into these elements
family | S Σ | 0..1 | string | Family name (often called 'Surname')
given | S Σ | 0..* | string | Parts of patient's name other than their family name that appear on photo ID; e.g., first and middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
gender | Σ C | 0..1 | code | Administrative gender Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. Constraints: use-only-if-required-by-law
birthDate | S Σ | 0..1 | date | The date of birth for the individual
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
use-only-if-required-by-law | warning | Patient.gender | SHALL be omitted UNLESS required by law in jurisdiction where SHC is issued : $this.length() = 0 |
vc-name-invariant | error | Patient.name | Require one of the key name elements to be filled. Allows for `text` for names that cannot be cleanly categorized into `family` and `given` (https://www.nature.com/articles/d41586-020-02761-z). : (family.exists() and given.exists()) xor text.exists() |
vc-should-be-omitted-privacy | warning | Patient.telecom.value, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode | SHOULD be omitted to protect privacy and for data minimization. : $this.length() = 0 |

This structure is derived from SHCPatientGeneralAD

Summary

Prohibited: 21 elements

Maturity: 4

Other representations of profile: CSV, Excel, Schematron