SMART Health Cards: Vaccination & Testing Implementation Guide
0.5.0-rc - ci-build

SMART Health Cards: Vaccination & Testing Implementation Guide, published by vci.org. This is not an authorized publication; it is the continuous build for version 0.5.0-rc). This version is based on the current content of https://github.com/dvci/vaccine-credential-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Patient Profile - Data Minimization

Defining URL:http://hl7.org/fhir/uv/smarthealthcards-vaccination/StructureDefinition/vaccination-credential-patient-dm
Version:0.5.0-rc
Name:VaccinationCredentialPatientDM
Title:Patient Profile - Data Minimization
Status:Active as of 2021-05-15T19:35:22+00:00
Definition:

Only elements necessary for Verifiers can be populated.

Publisher:vci.org
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/smarthealthcards-vaccination/StructureDefinition/vaccination-credential-patient-dm

Note This is a “data minimization” profile. The corresponding “allowable data” profile is here.

Formal Views of Profile Content

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

This structure is derived from VaccinationCredentialPatient

Summary

Prohibited: 25 elements

This structure is derived from VaccinationCredentialPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*VaccinationCredentialPatientInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... id 0..0
... meta
.... versionId 0..0
.... lastUpdated 0..0
.... source 0..0
.... profile 0..0
.... tag 0..0
... implicitRules 0..0
... text 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... active 0..0
... name 1..1HumanNameOfficial 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*VaccinationCredentialPatientInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... name SΣI1..1HumanNameOfficial name (i.e., legal name) of patient
.... extension 0..0
.... text Σ0..1stringText representation of the full name
.... family SΣ0..1stringFamily name (often called 'Surname')
.... given SΣ0..*stringGiven names (not always 'first'). Includes 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
... birthDate SΣ0..1dateThe date of birth for the individual

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*VaccinationCredentialPatientInformation 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..*stringGiven names (not always 'first'). Includes 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 VaccinationCredentialPatient

Summary

Prohibited: 25 elements

Differential View

This structure is derived from VaccinationCredentialPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*VaccinationCredentialPatientInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... id 0..0
... meta
.... versionId 0..0
.... lastUpdated 0..0
.... source 0..0
.... profile 0..0
.... tag 0..0
... implicitRules 0..0
... text 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... active 0..0
... name 1..1HumanNameOfficial 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*VaccinationCredentialPatientInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... name SΣI1..1HumanNameOfficial name (i.e., legal name) of patient
.... extension 0..0
.... text Σ0..1stringText representation of the full name
.... family SΣ0..1stringFamily name (often called 'Surname')
.... given SΣ0..*stringGiven names (not always 'first'). Includes 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
... birthDate SΣ0..1dateThe date of birth for the individual

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

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

Constraints

IdPathDetailsRequirements
dom-2PatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PatientIf 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-4PatientIf 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-5PatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1Patient.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.meta.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.meta.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.meta.securityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-name-invariantPatient.nameRequire one of the key name elements to be filled. Allows for `text` for names that cannot be cleanly categorized into `family` or `given` (https://www.nature.com/articles/d41586-020-02761-z).
: (family.exists() or given.exists()) xor text.exists()
ele-1Patient.name.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.familyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.givenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.suffixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.name.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacyPatient.telecom.valueSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1Patient.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.telecom.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacyPatient.address.citySHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1Patient.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacyPatient.address.districtSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1Patient.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacyPatient.address.stateSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1Patient.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-omitted-privacyPatient.address.postalCodeSHOULD be omitted to protect privacy and for data minimization.
: $this.length() = 0
ele-1Patient.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.contact.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.contact.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Patient.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Patient.link.otherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.link.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())