SMART Health Cards: Vaccination & Testing Implementation Guide
0.6.2 - STU 1 (Ballot Version) International flag

SMART Health Cards: Vaccination & Testing Implementation Guide, published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 0.6.2). 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 - United States - Data Minimization

Official URL: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-patient-us-dm Version: 0.6.2
Active as of 2022-06-27 Computable Name: SHCPatientUnitedStatesDM

Only elements necessary for Verifiers can be populated. For use in the United States.

Start here!
Profile Group: Patient

Description:

For representing the minimal information needed to identify a patient in a SMART Health Card.

Primary profile (DM) Fallback profile (AD) Scope of profile pair
Patient - General Fallback For general use where no geographic-specific profile exists
Patient - United States Fallback United States only
For more information about the types of profiles in this IG, see the profiles page.

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.

This structure is derived from SHCPatientGeneralDM

Summary

Prohibited: 1 element

This structure is derived from SHCPatientGeneralDM

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... identifier 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... name SΣI1..1HumanNameOfficial name (i.e., legal name) of patient
.... extension 0..0
.... text Σ0..1stringUse instead of `family` and `given` if the patient's name cannot be easily split into these elements
.... family SΣ0..1stringFamily name (often called 'Surname')
.... given SΣ0..*stringParts 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 Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... gender ΣI0..1codeAdministrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date of birth for the individual

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... name ΣI1..1HumanNameOfficial name (i.e., legal name) of patient
.... family Σ0..1stringFamily name (often called 'Surname')
.... given Σ0..*stringParts 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
... birthDate Σ0..1dateThe date of birth for the individual

doco Documentation for this format

This structure is derived from SHCPatientGeneralDM

Summary

Prohibited: 1 element

Differential View

This structure is derived from SHCPatientGeneralDM

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... identifier 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... name SΣI1..1HumanNameOfficial name (i.e., legal name) of patient
.... extension 0..0
.... text Σ0..1stringUse instead of `family` and `given` if the patient's name cannot be easily split into these elements
.... family SΣ0..1stringFamily name (often called 'Surname')
.... given SΣ0..*stringParts 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 Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... gender ΣI0..1codeAdministrative gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date of birth for the individual

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.link.typerequiredLinkType

Constraints

IdGradePathDetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorPatient.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-name-invarianterrorPatient.nameRequire 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()
ele-1errorPatient.name.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.name.familyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.name.givenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.name.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.name.suffixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.name.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacywarningPatient.telecom.valueSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1errorPatient.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.telecom.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
use-only-if-required-by-lawwarningPatient.genderSHALL be omitted UNLESS required by law in jurisdiction where SHC is issued
: $this.length() = 0
ele-1errorPatient.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacywarningPatient.address.citySHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1errorPatient.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacywarningPatient.address.districtSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1errorPatient.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacywarningPatient.address.stateSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1errorPatient.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacywarningPatient.address.postalCodeSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1errorPatient.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.contact.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.link.otherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.link.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())