This page is part of the HL7 Version 2 to FHIR (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/v2mappings/segment-pid-to-patient | Version: 1.0.0-ballot | |||
Active as of 2023-12-19 | Computable Name: SegmentPIDToPatient | |||
Copyright/Legal: Copyright (c) 2020, HL7 International, Inc., All Rights Reserved. |
This ConceptMap represents a mapping from the HL7 V2 Segment PID to the FHIR Patient Resource.
This ConceptMap represents the mapping from the HL7 V2 PID Segment to the FHIR Patient Resource. See also the FHIR Shorthand or the CSV Source.
HL7 v2 | Condition (IF True, args) | HL7 FHIR | Comments | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sort Order | Identifier | Name | Data Type | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | FHIR Attribute | Extension | Data Type | Cardinality - Min | Cardinality - Max | Data Type Mapping | Assignment | Vocabulary Mapping (IS, ID, CE, CEN, CWE) | |
1 | PID-1 | Set ID - PID | SI | 0 | 1 | ||||||||||||
2 | PID-2 | Patient ID | CX | 0 | 1 | Patient.identifier | Patient.Identifier | 0 | -1 | CX[Identifier] | |||||||
3 | PID-3 | Patient Identifier List | CX | 1 | -1 | Patient.identifier | Patient.Identifier | 0 | -1 | CX[Identifier] | |||||||
4 | PID-4 | Alternate Patient ID - PID | CX | 0 | 1 | Patient.identifier | Patient.Identifier | 0 | -1 | CX[Identifier] | |||||||
5 | PID-5 | Patient Name | XPN | 1 | -1 | Patient.name | Patient.HumanName | 0 | -1 | XPN[HumanName] | |||||||
6 | PID-6 | Mother's Maiden Name | XPN | 0 | -1 | Patient.extension.url | Patient.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||||
6 | PID-6 | Mother's Maiden Name | XPN | 0 | -1 | Patient.extension.valueString | Patient.string | 1 | 1 | XPN[String] | |||||||
7 | PID-7 | Date/Time of Birth | DTM | 0 | 1 | Patient.birthDate | Patient.date | 0 | 1 | ||||||||
7 | PID-7 | Date/Time of Birth | DTM | 0 | 1 | IF PID-7 LENGTH GREATER THAN 8 | Patient.birthDate.extension.url | Patient.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | ||||||
7 | PID-7 | Date/Time of Birth | DTM | 0 | 1 | IF PID-7 LENGTH GREATER THAN 8 | Patient.birthDate.extension.valueDateTime | Patient.dateTime | 1 | 1 | |||||||
8 | PID-8 | Administrative Sex | CWE | 0 | 1 | Patient.gender | Patient.code | 0 | 1 | CWE[code] | Gender | ||||||
9 | PID-9 | Patient Alias | XPN | 0 | -1 | Patient.name | Patient.HumanName | 0 | -1 | XPN[HumanName] | |||||||
10 | PID-10 | Race | CWE | 0 | -1 | PID-10 is may map different based on local requirements and should use the local extension, e.g., US = US Core Race Extension, AUS = indiginous extension. | local implementation | ||||||||||
11 | PID-11 | Patient Address | XAD | 0 | -1 | Patient.address | Patient.Address | 0 | -1 | XAD[Address] | |||||||
12 | PID-12 | County Code | ID | 0 | 1 | IF PID-11 LST.COUNT EQUALS 1 AND PID-11.9 IS NOT VALUED | Patient.address.district | Patient.string | 0 | 1 | ID[String] | ||||||
12 | PID-12 | County Code | ID | 0 | 1 | IF PID-11 LST.COUNT EQUALS 1 AND PID-11.9 IS VALUED NOT EQUAL PID-12 | Patient.address.district | Patient.string | ID[String] | ||||||||
12 | PID-12 | County Code | ID | 0 | 1 | IF PID-11 LST.COUNT GREATER THAN 1 | Patient.address.district | Patient.string | 0 | 1 | ID[String] | ||||||
12 | PID-12 | County Code | ID | 0 | 1 | IF PID-11 IS NOT VALUED | Patient.address.district | Patient.string | 0 | 1 | ID[String] | ||||||
13 | PID-13 | Phone Number - Home | XTN | 0 | -1 | Patient.telecom | Patient.ContactPoint | 0 | -1 | XTN[ContactPoint] | |||||||
13 | PID-13 | Phone Number - Home | XTN | 0 | -1 | IF PID-13.2 IS NOT VALUED | Patient.telecom.use | "home" | |||||||||
14 | PID-14 | Phone Number - Business | XTN | 0 | -1 | Patient.telecom | Patient.ContactPoint | 0 | -1 | XTN[ContactPoint] | |||||||
14 | PID-14 | Phone Number - Business | XTN | 0 | -1 | IF PID-14.2 IS NOT VALUED | Patient.telecom.use | "work" | |||||||||
15 | PID-15 | Primary Language | CWE | 0 | 1 | Patient.communication.language | Patient.CodeableConcept | 0 | -1 | CWE[CodeableConcept] | Language | ||||||
16 | PID-16 | Marital Status | CWE | 0 | 1 | Patient.maritalStatus | Patient.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | MaritalStatus | ||||||
17 | PID-17 | Religion | CWE | 0 | 1 | Patient.extension.url | Patient.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-religion" | |||||||
17 | PID-17 | Religion | CWE | 0 | 1 | Patient.extension.valueCodeableConcept | Patient.CodeableConcept | 1 | 1 | CWE[CodeableConcept] | Religion | ||||||
18 | PID-18 | Patient Account Number | CX | 0 | 1 | ||||||||||||
19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | Patient.identifier.value | Patient.string | 0 | 1 | ||||||||
19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | If in the US and various other jurisdictions | Patient.identifier.type.coding.code | Patient.code | 0 | 1 | "SS" | ||||||
19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | If outside the US for certain jurisdictions | Patient.identifier.type.coding.code | Patient.code | 0 | 1 | "SB" | ||||||
19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | Patient.identifier.type.coding.system | Patient.uri | 0 | 1 | "http://terminology.hl7.org/CodeSystem/v2-0203" | |||||||
19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | Patient.identifier.system | Patient.uri | 0 | 1 | "http://hl7.org/fhir/sid/us-ssn." | |||||||
20 | PID-20 | Driver's License Number - Patient | DLN | 0 | 1 | Patient.identifier | Patient.Identifier | 0 | 1 | DLN[Identifier] | |||||||
21 | PID-21 | Mother's Identifier | CX | 0 | -1 | Patient.$this | CX[RelatedPerson-Mother] | ||||||||||
22 | PID-22 | Ethnic Group | CWE | 0 | -1 | If PID-22 is for administrative purposes use, then use your local extension, e.g., for US = US Core Ethnicity. | local implementation | ||||||||||
23 | PID-23 | Birth Place | ST | 0 | 1 | Patient.extension.url | Patient.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||||
23 | PID-23 | Birth Place | ST | 0 | 1 | Patient.extension.valueAddress.text | Patient.string | 0 | 1 | ||||||||
24 | PID-24 | Multiple Birth Indicator | ID | 0 | 1 | IF PID-25 NOT VALUED | Patient.multipleBirthBoolean | Patient.boolean | 0 | 1 | ID[Boolean] | Yes/No | |||||
25 | PID-25 | Birth Order | NM | 0 | 1 | Patient.multipleBirthInteger | Patient.integer | 0 | 1 | ||||||||
26 | PID-26 | Citizenship | CWE | 0 | -1 | Patient.extension.url | Patient.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||||
26 | PID-26 | Citizenship | CWE | 0 | -1 | Patient.extension.extension.url | Patient.uri | 1 | 1 | "code" | |||||||
26 | PID-26 | Citizenship | CWE | 0 | -1 | Patient.extension.extension.valueCodeableConcept | Patient.CodeableConcept | 1 | 1 | CWE[CodeableConcept] | |||||||
27 | PID-27 | Veterans Military Status | CWE | 0 | 1 | extension??-veteranMilitaryStatus | Patient.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||
28 | PID-28 | Nationality | CWE | 0 | 1 | Patient.extension.url | Patient.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |||||||
28 | PID-28 | Nationality | CWE | 0 | 1 | Patient.extension.extension.url | Patient.uri | 1 | 1 | "code" | |||||||
28 | PID-28 | Nationality | CWE | 0 | 1 | Patient.extension.extension.valueCodeableConcept | Patient.CodeableConcept | 1 | 1 | CWE[CodeableConcept] | |||||||
29 | PID-29 | Patient Death Date and Time | DTM | 0 | 1 | Patient.deceasedDateTime | Patient.dateTime | 0 | 1 | ||||||||
30 | PID-30 | Patient Death Indicator | ID | 0 | 1 | IF PID-29 NOT VALUED | Patient.deceasedBoolean | Patient.boolean | 0 | 1 | ID[Boolean] | Yes/No | |||||
31 | PID-31 | Identity Unknown Indicator | ID | 0 | 1 | extension??-identityUnknown | Patient.boolean | 0 | 1 | ID[Boolean] | Yes/No | ||||||
32 | PID-32 | Identity Reliability Code | CWE | 0 | -1 | ||||||||||||
33 | PID-33 | Last Update Date/Time | DTM | 0 | 1 | meta.lastUpdated | Patient.instant | 0 | 1 | ||||||||
34 | PID-34 | Last Update Facility | HD | 0 | 1 | Meta.extension??-lastUpdatedFacility(Organization) | Reference(Patient.Organization) | 0 | 1 | ||||||||
35 | PID-35 | Taxonomic Classification Code | CWE | 0 | 1 | Patient.extension.url | Patient.uri | 0 | -1 | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |||||||
35 | PID-35 | Taxonomic Classification Code | CWE | 0 | 1 | Patient.extension.extension.url | Patient.uri | 0 | 1 | "species" | |||||||
35 | PID-35 | Taxonomic Classification Code | CWE | 0 | 1 | Patient.extension.extension.valueCodeableConcept | Patient.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||
36 | PID-36 | Breed Code | CWE | 0 | 1 | Patient.extension.url | Patient.uri | 0 | -1 | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |||||||
36 | PID-36 | Breed Code | CWE | 0 | 1 | Patient.extension.extension.url | Patient.uri | 0 | 1 | "breed" | |||||||
36 | PID-36 | Breed Code | CWE | 0 | 1 | Patient.extension.extension.valueCodeableConcept | Patient.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||
37 | PID-37 | Strain | ST | 0 | 1 | ||||||||||||
38 | PID-38 | Production Class Code | CWE | 0 | 2 | ||||||||||||
39 | PID-39 | Tribal Citizenship | CWE | 0 | -1 | Patient.extension.url | Patient.uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||||
39 | PID-39 | Tribal Citizenship | CWE | 0 | -1 | Patient.extension.extension.url | Patient.uri | 1 | 1 | "code" | |||||||
39 | PID-39 | Tribal Citizenship | CWE | 0 | -1 | Patient.extension.extension.valueCodeableConcept | Patient.CodeableConcept | 1 | 1 | CWE[CodeableConcept] | |||||||
40 | PID-40 | Patient Telecommunication Information | XTN | 0 | -1 | Patient.telecom | Patient.ContactPoint | 0 | -1 | XTN[ContactPoint] |
Mapping from PID to Patient
ACTIVE (not intended for production usage). Published on 2023-12-19 by HL7 International / Orders and Observations (HL7 Orders and Observations Workgroup: http://www.hl7.org/Special/com..., Keith W. Boone: kboone@ainq.com, Rob Hausam: rrhausam@gmail.com). Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.
This ConceptMap represents a mapping from the HL7 V2 Segment PID to the FHIR Patient Resource.
Group 1Mapping from unspecified code system
to unspecified code system
Source Concept Details | Relationship | Target Concept Details | Properties | ||||||||||
Codes from | vocabularymap | datatypemap | value | Codes from | antlr | narrative | |||||||
PID-2 | Patient ID | CX[Identifier] | is equivalent to | identifier[1] | identifier[1] | ||||||||
PID-3 | Patient Identifier List | CX[Identifier] | is equivalent to | identifier[2] | identifier[2] | ||||||||
PID-4 | Alternate Patient ID - PID | CX[Identifier] | is equivalent to | identifier[3] | identifier[3] | ||||||||
PID-5 | Patient Name | XPN[HumanName] | is equivalent to | name[1] | name[1] | ||||||||
PID-6 | Mother's Maiden Name | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | is equivalent to | extension[1].url | extension[1].url | ||||||||
PID-6 | Mother's Maiden Name | XPN[String] | is equivalent to | extension[1].valueString | extension[1].valueString | ||||||||
PID-7 | Date/Time of Birth | is equivalent to | birthDate | birthDate | |||||||||
PID-7 | Date/Time of Birth | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | is equivalent to | birthDate.extension[1].url | birthDate.extension[1].url | IF PID-7 LENGTH GREATER THAN 8 | |||||||
PID-7 | Date/Time of Birth | is equivalent to | birthDate.extension[1].valueDateTime | birthDate.extension[1].valueDateTime | IF PID-7 LENGTH GREATER THAN 8 | ||||||||
PID-8 | Administrative Sex | Gender | CWE[code] | is equivalent to | gender | gender | |||||||
PID-9 | Patient Alias | XPN[HumanName] | is equivalent to | name[2] | name[2] | ||||||||
PID-11 | Patient Address | XAD[Address] | is equivalent to | address[1] | address[1] | ||||||||
PID-12 | County Code | ID[String] | is equivalent to | address[1].district | address[1].district | IF PID-11 LST.COUNT EQUALS 1 AND PID-11.9 IS NOT VALUED | |||||||
PID-12 | County Code | ID[String] | is equivalent to | address[2].district | address[2].district | IF PID-11 LST.COUNT EQUALS 1 AND PID-11.9 IS VALUED NOT EQUAL PID-12 | |||||||
PID-12 | County Code | ID[String] | is equivalent to | address[2].district | address[2].district | IF PID-11 LST.COUNT GREATER THAN 1 | |||||||
PID-12 | County Code | ID[String] | is equivalent to | address[1].district | address[1].district | IF PID-11 IS NOT VALUED | |||||||
PID-13 | Phone Number - Home | XTN[ContactPoint] | is equivalent to | telecom[1] | telecom[1] | ||||||||
PID-13 | Phone Number - Home | "home" | is equivalent to | telecom[1].use | telecom[1].use | IF PID-13.2 IS NOT VALUED | |||||||
PID-14 | Phone Number - Business | XTN[ContactPoint] | is equivalent to | telecom[2] | telecom[2] | ||||||||
PID-14 | Phone Number - Business | "work" | is equivalent to | telecom[2].use | telecom[2].use | IF PID-14.2 IS NOT VALUED | |||||||
PID-15 | Primary Language | Language | CWE[CodeableConcept] | is equivalent to | communication.language | communication.language | |||||||
PID-16 | Marital Status | MaritalStatus | CWE[CodeableConcept] | is equivalent to | maritalStatus | maritalStatus | |||||||
PID-17 | Religion | "http://hl7.org/fhir/StructureDefinition/patient-religion" | is equivalent to | extension[2].url | extension[2].url | ||||||||
PID-17 | Religion | Religion | CWE[CodeableConcept] | is equivalent to | extension[2].valueCodeableConcept | extension[2].valueCodeableConcept | |||||||
PID-19 | SSN Number - Patient | is equivalent to | identifier[4].value | identifier[4].value | |||||||||
PID-19 | SSN Number - Patient | "SS" | is equivalent to | identifier[4].type.coding.code | identifier[4].type.coding.code | If in the US and various other jurisdictions | |||||||
PID-19 | SSN Number - Patient | "SB" | is equivalent to | identifier[4].type.coding.code | identifier[4].type.coding.code | If outside the US for certain jurisdictions | |||||||
PID-19 | SSN Number - Patient | "http://terminology.hl7.org/CodeSystem/v2-0203" | is equivalent to | identifier[4].type.coding.system | identifier[4].type.coding.system | ||||||||
PID-19 | SSN Number - Patient | "http://hl7.org/fhir/sid/us-ssn." | is equivalent to | identifier[4].system | identifier[4].system | ||||||||
PID-20 | Driver's License Number - Patient | DLN[Identifier] | is equivalent to | identifier[5] | identifier[5] | ||||||||
PID-21 | Mother's Identifier | CX[RelatedPerson-Mother] | is equivalent to | $this | $this | ||||||||
PID-23 | Birth Place | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | is equivalent to | extension[3].url | extension[3].url | ||||||||
PID-23 | Birth Place | is equivalent to | extension[3].valueAddress.text | extension[3].valueAddress.text | |||||||||
PID-24 | Multiple Birth Indicator | Yes/No | ID[Boolean] | is equivalent to | multipleBirthBoolean | multipleBirthBoolean | IF PID-25 NOT VALUED | ||||||
PID-25 | Birth Order | is equivalent to | multipleBirthInteger | multipleBirthInteger | |||||||||
PID-26 | Citizenship | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | is equivalent to | extension[4].url | extension[4].url | ||||||||
PID-26 | Citizenship | "code" | is equivalent to | extension[4].extension[1].url | extension[4].extension[1].url | ||||||||
PID-26 | Citizenship | CWE[CodeableConcept] | is equivalent to | extension[4].extension[1].valueCodeableConcept | extension[4].extension[1].valueCodeableConcept | ||||||||
PID-28 | Nationality | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | is equivalent to | extension[5].url | extension[5].url | ||||||||
PID-28 | Nationality | "code" | is equivalent to | extension[5].extension[1].url | extension[5].extension[1].url | ||||||||
PID-28 | Nationality | CWE[CodeableConcept] | is equivalent to | extension[5].extension[1].valueCodeableConcept | extension[5].extension[1].valueCodeableConcept | ||||||||
PID-29 | Patient Death Date and Time | is equivalent to | deceasedDateTime | deceasedDateTime | |||||||||
PID-30 | Patient Death Indicator | Yes/No | ID[Boolean] | is equivalent to | deceasedBoolean | deceasedBoolean | IF PID-29 NOT VALUED | ||||||
PID-33 | Last Update Date/Time | is equivalent to | meta.lastUpdated | meta.lastUpdated | |||||||||
PID-35 | Taxonomic Classification Code | "http://hl7.org/fhir/StructureDefinition/patient-animal" | is equivalent to | extension[6].url | extension[6].url | ||||||||
PID-35 | Taxonomic Classification Code | "species" | is equivalent to | extension[6].extension[1].url | extension[6].extension[1].url | ||||||||
PID-35 | Taxonomic Classification Code | CWE[CodeableConcept] | is equivalent to | extension[6].extension[1].valueCodeableConcept | extension[6].extension[1].valueCodeableConcept | ||||||||
PID-36 | Breed Code | "http://hl7.org/fhir/StructureDefinition/patient-animal" | is equivalent to | extension[6].url | extension[6].url | ||||||||
PID-36 | Breed Code | "breed" | is equivalent to | extension[6].extension[2].url | extension[6].extension[2].url | ||||||||
PID-36 | Breed Code | CWE[CodeableConcept] | is equivalent to | extension[6].extension[2].valueCodeableConcept | extension[6].extension[2].valueCodeableConcept | ||||||||
PID-39 | Tribal Citizenship | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | is equivalent to | extension[7].url | extension[7].url | ||||||||
PID-39 | Tribal Citizenship | "code" | is equivalent to | extension[7].extension[1].url | extension[7].extension[1].url | ||||||||
PID-39 | Tribal Citizenship | CWE[CodeableConcept] | is equivalent to | extension[7].extension[1].valueCodeableConcept | extension[7].extension[1].valueCodeableConcept | ||||||||
PID-40 | Patient Telecommunication Information | XTN[ContactPoint] | is equivalent to | telecom[3] | telecom[3] |