v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: PID (Segment) ( Experimental )

Official URL: http://hl7.org/fhir/StructureDefinition/PID Version: 2.9
Draft as of 2023-08-09 Responsible: FO Computable Name: PID

Copyright/Legal: FO

Patient Identification

Usage:

  • This Logical Model 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 DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. PID 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... setID-PID 0..1SIsetID-PID
Max Length: 4
... patientID 0..1-patientID
... patientIdentifierList S1..*CXpatientIdentifierList
... alternatePatientID-PID 0..1-alternatePatientID-PID
... patientName S1..*XPNpatientName
... mothersMaidenName 0..*XPNmothersMaidenName
... dateTimeofBirth 0..1DTMdateTimeofBirth
... administrativeSex 0..1CWEadministrativeSex
... patientAlias 0..1-patientAlias
... race 0..*CWErace
... patientAddress 0..*XADpatientAddress
... countyCode 0..1-countyCode
... phoneNumber-Home 0..*XTNphoneNumber-Home
... phoneNumber-Business 0..*XTNphoneNumber-Business
... primaryLanguage 0..1CWEprimaryLanguage
... maritalStatus 0..1CWEmaritalStatus
... religion 0..1CWEreligion
... patientAccountNumber 0..1CXpatientAccountNumber
... sSNNumber-Patient 0..1-sSNNumber-Patient
... driversLicenseNumber-Patient 0..1-driversLicenseNumber-Patient
... mothersIdentifier 0..*CXmothersIdentifier
... ethnicGroup 0..*CWEethnicGroup
... birthPlace 0..1STbirthPlace
... multipleBirthIndicator 0..1IDmultipleBirthIndicator
Max Length: 1
... birthOrder 0..1NMbirthOrder
... citizenship 0..*CWEcitizenship
... veteransMilitaryStatus 0..1CWEveteransMilitaryStatus
... nationality 0..1CWEnationality
... patientDeathDateandTime 0..1DTMpatientDeathDateandTime
... patientDeathIndicator 0..1IDpatientDeathIndicator
Max Length: 1
... identityUnknownIndicator 0..1IDidentityUnknownIndicator
Max Length: 1
... identityReliabilityCode 0..*CWEidentityReliabilityCode
... lastUpdateDateTime 0..1DTMlastUpdateDateTime
... lastUpdateFacility 0..1HDlastUpdateFacility
... taxonomicClassificationCode 0..1CWEtaxonomicClassificationCode
... breedCode 0..1CWEbreedCode
... strain 0..1STstrain
... productionClassCode 0..1CWEproductionClassCode
... tribalCitizenship 0..*CWEtribalCitizenship
... patientTelecommunicationInformation 0..*XTNpatientTelecommunicationInformation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PID 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... setID-PID 0..1SIsetID-PID
Max Length: 4
... patientID 0..1-patientID
... patientIdentifierList S1..*CXpatientIdentifierList
... alternatePatientID-PID 0..1-alternatePatientID-PID
... patientName S1..*XPNpatientName
... mothersMaidenName 0..*XPNmothersMaidenName
... dateTimeofBirth 0..1DTMdateTimeofBirth
... administrativeSex 0..1CWEadministrativeSex
... patientAlias 0..1-patientAlias
... race 0..*CWErace
... patientAddress 0..*XADpatientAddress
... countyCode 0..1-countyCode
... phoneNumber-Home 0..*XTNphoneNumber-Home
... phoneNumber-Business 0..*XTNphoneNumber-Business
... primaryLanguage 0..1CWEprimaryLanguage
... maritalStatus 0..1CWEmaritalStatus
... religion 0..1CWEreligion
... patientAccountNumber 0..1CXpatientAccountNumber
... sSNNumber-Patient 0..1-sSNNumber-Patient
... driversLicenseNumber-Patient 0..1-driversLicenseNumber-Patient
... mothersIdentifier 0..*CXmothersIdentifier
... ethnicGroup 0..*CWEethnicGroup
... birthPlace 0..1STbirthPlace
... multipleBirthIndicator 0..1IDmultipleBirthIndicator
Max Length: 1
... birthOrder 0..1NMbirthOrder
... citizenship 0..*CWEcitizenship
... veteransMilitaryStatus 0..1CWEveteransMilitaryStatus
... nationality 0..1CWEnationality
... patientDeathDateandTime 0..1DTMpatientDeathDateandTime
... patientDeathIndicator 0..1IDpatientDeathIndicator
Max Length: 1
... identityUnknownIndicator 0..1IDidentityUnknownIndicator
Max Length: 1
... identityReliabilityCode 0..*CWEidentityReliabilityCode
... lastUpdateDateTime 0..1DTMlastUpdateDateTime
... lastUpdateFacility 0..1HDlastUpdateFacility
... taxonomicClassificationCode 0..1CWEtaxonomicClassificationCode
... breedCode 0..1CWEbreedCode
... strain 0..1STstrain
... productionClassCode 0..1CWEproductionClassCode
... tribalCitizenship 0..*CWEtribalCitizenship
... patientTelecommunicationInformation 0..*XTNpatientTelecommunicationInformation

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPIDIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPIDIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPIDIf 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-5errorPIDIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePIDA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PID 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... setID-PID 0..1SIsetID-PID
Max Length: 4
... patientID 0..1-patientID
... patientIdentifierList S1..*CXpatientIdentifierList
... alternatePatientID-PID 0..1-alternatePatientID-PID
... patientName S1..*XPNpatientName
... mothersMaidenName 0..*XPNmothersMaidenName
... dateTimeofBirth 0..1DTMdateTimeofBirth
... administrativeSex 0..1CWEadministrativeSex
... patientAlias 0..1-patientAlias
... race 0..*CWErace
... patientAddress 0..*XADpatientAddress
... countyCode 0..1-countyCode
... phoneNumber-Home 0..*XTNphoneNumber-Home
... phoneNumber-Business 0..*XTNphoneNumber-Business
... primaryLanguage 0..1CWEprimaryLanguage
... maritalStatus 0..1CWEmaritalStatus
... religion 0..1CWEreligion
... patientAccountNumber 0..1CXpatientAccountNumber
... sSNNumber-Patient 0..1-sSNNumber-Patient
... driversLicenseNumber-Patient 0..1-driversLicenseNumber-Patient
... mothersIdentifier 0..*CXmothersIdentifier
... ethnicGroup 0..*CWEethnicGroup
... birthPlace 0..1STbirthPlace
... multipleBirthIndicator 0..1IDmultipleBirthIndicator
Max Length: 1
... birthOrder 0..1NMbirthOrder
... citizenship 0..*CWEcitizenship
... veteransMilitaryStatus 0..1CWEveteransMilitaryStatus
... nationality 0..1CWEnationality
... patientDeathDateandTime 0..1DTMpatientDeathDateandTime
... patientDeathIndicator 0..1IDpatientDeathIndicator
Max Length: 1
... identityUnknownIndicator 0..1IDidentityUnknownIndicator
Max Length: 1
... identityReliabilityCode 0..*CWEidentityReliabilityCode
... lastUpdateDateTime 0..1DTMlastUpdateDateTime
... lastUpdateFacility 0..1HDlastUpdateFacility
... taxonomicClassificationCode 0..1CWEtaxonomicClassificationCode
... breedCode 0..1CWEbreedCode
... strain 0..1STstrain
... productionClassCode 0..1CWEproductionClassCode
... tribalCitizenship 0..*CWEtribalCitizenship
... patientTelecommunicationInformation 0..*XTNpatientTelecommunicationInformation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PID.languagerequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPIDIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPIDIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPIDIf 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-5errorPIDIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePIDA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 2 elements

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. PID 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... setID-PID 0..1SIsetID-PID
Max Length: 4
... patientID 0..1-patientID
... patientIdentifierList S1..*CXpatientIdentifierList
... alternatePatientID-PID 0..1-alternatePatientID-PID
... patientName S1..*XPNpatientName
... mothersMaidenName 0..*XPNmothersMaidenName
... dateTimeofBirth 0..1DTMdateTimeofBirth
... administrativeSex 0..1CWEadministrativeSex
... patientAlias 0..1-patientAlias
... race 0..*CWErace
... patientAddress 0..*XADpatientAddress
... countyCode 0..1-countyCode
... phoneNumber-Home 0..*XTNphoneNumber-Home
... phoneNumber-Business 0..*XTNphoneNumber-Business
... primaryLanguage 0..1CWEprimaryLanguage
... maritalStatus 0..1CWEmaritalStatus
... religion 0..1CWEreligion
... patientAccountNumber 0..1CXpatientAccountNumber
... sSNNumber-Patient 0..1-sSNNumber-Patient
... driversLicenseNumber-Patient 0..1-driversLicenseNumber-Patient
... mothersIdentifier 0..*CXmothersIdentifier
... ethnicGroup 0..*CWEethnicGroup
... birthPlace 0..1STbirthPlace
... multipleBirthIndicator 0..1IDmultipleBirthIndicator
Max Length: 1
... birthOrder 0..1NMbirthOrder
... citizenship 0..*CWEcitizenship
... veteransMilitaryStatus 0..1CWEveteransMilitaryStatus
... nationality 0..1CWEnationality
... patientDeathDateandTime 0..1DTMpatientDeathDateandTime
... patientDeathIndicator 0..1IDpatientDeathIndicator
Max Length: 1
... identityUnknownIndicator 0..1IDidentityUnknownIndicator
Max Length: 1
... identityReliabilityCode 0..*CWEidentityReliabilityCode
... lastUpdateDateTime 0..1DTMlastUpdateDateTime
... lastUpdateFacility 0..1HDlastUpdateFacility
... taxonomicClassificationCode 0..1CWEtaxonomicClassificationCode
... breedCode 0..1CWEbreedCode
... strain 0..1STstrain
... productionClassCode 0..1CWEproductionClassCode
... tribalCitizenship 0..*CWEtribalCitizenship
... patientTelecommunicationInformation 0..*XTNpatientTelecommunicationInformation

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PID 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... setID-PID 0..1SIsetID-PID
Max Length: 4
... patientID 0..1-patientID
... patientIdentifierList S1..*CXpatientIdentifierList
... alternatePatientID-PID 0..1-alternatePatientID-PID
... patientName S1..*XPNpatientName
... mothersMaidenName 0..*XPNmothersMaidenName
... dateTimeofBirth 0..1DTMdateTimeofBirth
... administrativeSex 0..1CWEadministrativeSex
... patientAlias 0..1-patientAlias
... race 0..*CWErace
... patientAddress 0..*XADpatientAddress
... countyCode 0..1-countyCode
... phoneNumber-Home 0..*XTNphoneNumber-Home
... phoneNumber-Business 0..*XTNphoneNumber-Business
... primaryLanguage 0..1CWEprimaryLanguage
... maritalStatus 0..1CWEmaritalStatus
... religion 0..1CWEreligion
... patientAccountNumber 0..1CXpatientAccountNumber
... sSNNumber-Patient 0..1-sSNNumber-Patient
... driversLicenseNumber-Patient 0..1-driversLicenseNumber-Patient
... mothersIdentifier 0..*CXmothersIdentifier
... ethnicGroup 0..*CWEethnicGroup
... birthPlace 0..1STbirthPlace
... multipleBirthIndicator 0..1IDmultipleBirthIndicator
Max Length: 1
... birthOrder 0..1NMbirthOrder
... citizenship 0..*CWEcitizenship
... veteransMilitaryStatus 0..1CWEveteransMilitaryStatus
... nationality 0..1CWEnationality
... patientDeathDateandTime 0..1DTMpatientDeathDateandTime
... patientDeathIndicator 0..1IDpatientDeathIndicator
Max Length: 1
... identityUnknownIndicator 0..1IDidentityUnknownIndicator
Max Length: 1
... identityReliabilityCode 0..*CWEidentityReliabilityCode
... lastUpdateDateTime 0..1DTMlastUpdateDateTime
... lastUpdateFacility 0..1HDlastUpdateFacility
... taxonomicClassificationCode 0..1CWEtaxonomicClassificationCode
... breedCode 0..1CWEbreedCode
... strain 0..1STstrain
... productionClassCode 0..1CWEproductionClassCode
... tribalCitizenship 0..*CWEtribalCitizenship
... patientTelecommunicationInformation 0..*XTNpatientTelecommunicationInformation

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPIDIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPIDIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPIDIf 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-5errorPIDIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePIDA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PID 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... setID-PID 0..1SIsetID-PID
Max Length: 4
... patientID 0..1-patientID
... patientIdentifierList S1..*CXpatientIdentifierList
... alternatePatientID-PID 0..1-alternatePatientID-PID
... patientName S1..*XPNpatientName
... mothersMaidenName 0..*XPNmothersMaidenName
... dateTimeofBirth 0..1DTMdateTimeofBirth
... administrativeSex 0..1CWEadministrativeSex
... patientAlias 0..1-patientAlias
... race 0..*CWErace
... patientAddress 0..*XADpatientAddress
... countyCode 0..1-countyCode
... phoneNumber-Home 0..*XTNphoneNumber-Home
... phoneNumber-Business 0..*XTNphoneNumber-Business
... primaryLanguage 0..1CWEprimaryLanguage
... maritalStatus 0..1CWEmaritalStatus
... religion 0..1CWEreligion
... patientAccountNumber 0..1CXpatientAccountNumber
... sSNNumber-Patient 0..1-sSNNumber-Patient
... driversLicenseNumber-Patient 0..1-driversLicenseNumber-Patient
... mothersIdentifier 0..*CXmothersIdentifier
... ethnicGroup 0..*CWEethnicGroup
... birthPlace 0..1STbirthPlace
... multipleBirthIndicator 0..1IDmultipleBirthIndicator
Max Length: 1
... birthOrder 0..1NMbirthOrder
... citizenship 0..*CWEcitizenship
... veteransMilitaryStatus 0..1CWEveteransMilitaryStatus
... nationality 0..1CWEnationality
... patientDeathDateandTime 0..1DTMpatientDeathDateandTime
... patientDeathIndicator 0..1IDpatientDeathIndicator
Max Length: 1
... identityUnknownIndicator 0..1IDidentityUnknownIndicator
Max Length: 1
... identityReliabilityCode 0..*CWEidentityReliabilityCode
... lastUpdateDateTime 0..1DTMlastUpdateDateTime
... lastUpdateFacility 0..1HDlastUpdateFacility
... taxonomicClassificationCode 0..1CWEtaxonomicClassificationCode
... breedCode 0..1CWEbreedCode
... strain 0..1STstrain
... productionClassCode 0..1CWEproductionClassCode
... tribalCitizenship 0..*CWEtribalCitizenship
... patientTelecommunicationInformation 0..*XTNpatientTelecommunicationInformation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PID.languagerequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPIDIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPIDIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPIDIf 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-5errorPIDIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePIDA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 2 elements

 

Other representations of profile: CSV, Excel