SMART Health Cards: Vaccination & 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: Patient Profile - United States - Data Minimization

Defines a primary (DM) profile representing a patient in a health card related to infectious disease vaccination and testing issued in the United States.

See here for implementation details.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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

This structure is derived from SHCPatientGeneralDM

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	SHCPatientGeneralDM	Information about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
identifier		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	SHCPatientGeneralDM	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 vc-name-invariant: 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).
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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()

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	SHCPatientGeneralDM	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 vc-name-invariant: 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).
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. use-only-if-required-by-law: SHALL be omitted UNLESS required by law in jurisdiction where SHC is issued
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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 SHCPatientGeneralDM

Summary

Prohibited: 1 element

Differential View

This structure is derived from SHCPatientGeneralDM

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	SHCPatientGeneralDM	Information about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
identifier		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	SHCPatientGeneralDM	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 vc-name-invariant: 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).
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	SHCPatientGeneralDM	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 vc-name-invariant: 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).
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. use-only-if-required-by-law: SHALL be omitted UNLESS required by law in jurisdiction where SHC is issued
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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 SHCPatientGeneralDM

Summary

Prohibited: 1 element

Other representations of profile: CSV, Excel, Schematron