| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | AA | AB | AC | AD | AE | ||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | HL7 v2 | Condition (IF True) | HL7 FHIR | Comments | ||||||||||||||||||||||||||||
2 | Sort Order | Identifier | Name | Data Type | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | FHIR Attribute | Data Type | Cardinality - Min | Cardinality - Max | Data Type Mapping | Vocabulary Mapping (IS, ID, CE, CNE, CWE) | Assignment | ||||||||||||||||
3 | 1 | PID-1 | Set ID - PID | SI | 0 | 1 | ||||||||||||||||||||||||||
4 | 2 | PID-2 | Patient ID | CX | 0 | 1 | identifier[1] | Identifier | 0 | -1 | CX[Identifier] | |||||||||||||||||||||
5 | 3 | PID-3 | Patient Identifier List | CX | 1 | -1 | identifier[2] | Identifier | 0 | -1 | CX[Identifier] | |||||||||||||||||||||
6 | 4 | PID-4 | Alternate Patient ID - PID | CX | 0 | 1 | identifier[3] | Identifier | 0 | -1 | CX[Identifier] | |||||||||||||||||||||
7 | 5 | PID-5 | Patient Name | XPN | 1 | -1 | name[1] | HumanName | 0 | -1 | XPN[HumanName] | |||||||||||||||||||||
8 | 6 | PID-6 | Mother's Maiden Name | XPN | 0 | -1 | extension[1].url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||||||||||||||||||
9 | 6 | PID-6 | Mother's Maiden Name | XPN | 0 | -1 | extension[1].valueString | string | 1 | 1 | XPN[String] | This may not be the second name if there are repeats in PID-5. ext.patientMothersMaiden (string) also exists if we prefer. | ||||||||||||||||||||
10 | 7 | PID-7 | Date/Time of Birth | DTM | 0 | 1 | birthDate | date | 0 | 1 | PROPOSAL MOVE TO IG IMPLEMENTATION GUIDANCE SECTION: Use ISO 8601 to establish the re-formatting from HL7 v2 data type to HL7 FHIR data type, particularly when mapping a platform datetime to platform date. ADD OTHER REFERENCES ON HOW TO ACHIEVE THESE CONVERSIONS in Java, CSHarp, etc., etc. | |||||||||||||||||||||
11 | 7 | PID-7 | Date/Time of Birth | DTM | 0 | 1 | IF PID-7 LENGTH GREATER THAN 8 | birthDate.extension[1].url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | ||||||||||||||||||||
12 | 7 | PID-7 | Date/Time of Birth | DTM | 0 | 1 | IF PID-7 LENGTH GREATER THAN 8 | birthDate.extension[1].valueDateTime | dateTime | 1 | 1 | |||||||||||||||||||||
13 | 8 | PID-8 | Administrative Sex | CWE | 0 | 1 | gender | code | 0 | 1 | CWE[code] | AdministrativeSex | ||||||||||||||||||||
14 | 9 | PID-9 | Patient Alias | XPN | 0 | -1 | name[2] | HumanName | 0 | -1 | XPN[HumanName] | |||||||||||||||||||||
15 | 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 | For an international document, it may not be possible to come up with a FHIR value set for race. Therefore the appropriate extension for the local implementation should be used based on preferably a country/realm specific extension, e.g., US Core Race Extension for the US or the Indiginous Extension for Australia. | |||||||||||||||||||||||
16 | 11 | PID-11 | Patient Address | XAD | 0 | -1 | address[1] | Address | 0 | -1 | XAD[Address] | |||||||||||||||||||||
17 | 12 | PID-12 | County Code | ID | 0 | 1 | IF PID-11 LST.COUNT EQUALS 1 AND PID-11.9 IS NOT VALUED | address[1].district | string | 0 | 1 | ID[String] | This may not be the second occurrence if PID-11 repeats. Because PID-11 can repeat but PID-12 cannot, it's not appropriate to include PID-12 in an iteration of .address populated from PID-11 | |||||||||||||||||||
18 | 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 | address[2].district | string | ID[String] | ||||||||||||||||||||||
19 | 12 | PID-12 | County Code | ID | 0 | 1 | IF PID-11 LST.COUNT GREATER THAN 1 | address[2].district | string | 0 | 1 | ID[String] | ||||||||||||||||||||
20 | 12 | PID-12 | County Code | ID | 0 | 1 | IF PID-11 IS NOT VALUED | address[1].district | string | 0 | 1 | ID[String] | ||||||||||||||||||||
21 | 13 | PID-13 | Phone Number - Home | XTN | 0 | -1 | telecom[1] | ContactPoint | 0 | -1 | XTN[ContactPoint] | |||||||||||||||||||||
22 | 13 | PID-13 | Phone Number - Home | XTN | 0 | -1 | IF PID-13.2 IS NOT VALUED | telecom[1].use | "home" | |||||||||||||||||||||||
23 | 14 | PID-14 | Phone Number - Business | XTN | 0 | -1 | telecom[2] | ContactPoint | 0 | -1 | XTN[ContactPoint] | |||||||||||||||||||||
24 | 14 | PID-14 | Phone Number - Business | XTN | 0 | -1 | IF PID-14.2 IS NOT VALUED | telecom[2].use | "work" | |||||||||||||||||||||||
25 | 15 | PID-15 | Primary Language | CWE | 0 | 1 | communication.language | CodeableConcept | 0 | -1 | CWE[CodeableConcept] | PrimaryLanguage | During implementation, if you know that the value in PID-15 is the preferred patient language, then Patient.communication.preferred can be set to "true". | |||||||||||||||||||
26 | 16 | PID-16 | Marital Status | CWE | 0 | 1 | maritalStatus | CodeableConcept | 0 | 1 | CWE[CodeableConcept] | MaritalStatus | ||||||||||||||||||||
27 | 17 | PID-17 | Religion | CWE | 0 | 1 | extension[2].url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-religion" | |||||||||||||||||||||
28 | 17 | PID-17 | Religion | CWE | 0 | 1 | extension[2].valueCodeableConcept | CodeableConcept | 1 | 1 | CWE[CodeableConcept] | Religion | ||||||||||||||||||||
29 | 18 | PID-18 | Patient Account Number | CX | 0 | 1 | Mapped in PID[Account]. In some systems, PID-18 may contain a visit identifier. If that is the case for a given implementation, then a mapping to an Encounter may be more appropriate | |||||||||||||||||||||||||
30 | 19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | identifier[4].value | string | 0 | 1 | the value set for Identifier.type doesn't contain SSN but it does have SB (social beneficiary) | |||||||||||||||||||||
31 | 19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | If in the US and various other jurisdictions | identifier[4].type.coding.code | code | 0 | 1 | "SS" | ||||||||||||||||||||
32 | 19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | If outside the US for certain jurisdictions | identifier[4].type.coding.code | code | 0 | 1 | "SB" | ||||||||||||||||||||
33 | 19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | identifier[4].type.coding.system | uri | 0 | 1 | "http://terminology.hl7.org/CodeSystem/v2-0203" | |||||||||||||||||||||
34 | 19 | PID-19 | SSN Number - Patient | ST | 0 | 1 | identifier[4].system | uri | 0 | 1 | "http://hl7.org/fhir/sid/us-ssn." | If working in a jurisdiction other than the US and this field is used for the local SSN equivalent, a different system will need to be identified. | ||||||||||||||||||||
35 | 20 | PID-20 | Driver's License Number - Patient | DLN | 0 | 1 | identifier[5] | Identifier | 0 | 1 | DLN[Identifier] | |||||||||||||||||||||
36 | 21 | PID-21 | Mother's Identifier | CX | 0 | -1 | $this | CX[RelatedPerson-Mother] | ||||||||||||||||||||||||
37 | 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 | For an international document, it may not be possible to come up with a FHIR value set for ethnic group. Therefore the appropriate extension for the local implementation should be used based on preferably a country/realm specific extension, e.g., US Core Ethnicity for the US. | |||||||||||||||||||||||
38 | 23 | PID-23 | Birth Place | ST | 0 | 1 | extension[3].url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||||||||||||||||||
39 | 23 | PID-23 | Birth Place | ST | 0 | 1 | extension[3].valueAddress.text | string | 0 | 1 | ||||||||||||||||||||||
40 | 24 | PID-24 | Multiple Birth Indicator | ID | 0 | 1 | IF PID-25 NOT VALUED | multipleBirthBoolean | boolean | 0 | 1 | ID[Boolean] | Yes/NoIndicator | |||||||||||||||||||
41 | 25 | PID-25 | Birth Order | NM | 0 | 1 | multipleBirthInteger | integer | 0 | 1 | ||||||||||||||||||||||
42 | 26 | PID-26 | Citizenship | CWE | 0 | -1 | extension[4].url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||||||||||||||||||
43 | 26 | PID-26 | Citizenship | CWE | 0 | -1 | extension[4].extension[1].url | uri | 1 | 1 | "code" | |||||||||||||||||||||
44 | 26 | PID-26 | Citizenship | CWE | 0 | -1 | extension[4].extension[1].valueCodeableConcept | CodeableConcept | 1 | 1 | CWE[CodeableConcept] | The standard extension does not include a value set | ||||||||||||||||||||
45 | 27 | PID-27 | Veterans Military Status | CWE | 0 | 1 | extension??-veteranMilitaryStatus | CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||||||||||||||||
46 | 28 | PID-28 | Nationality | CWE | 0 | 1 | extension[5].url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-nationality" | |||||||||||||||||||||
47 | 28 | PID-28 | Nationality | CWE | 0 | 1 | extension[5].extension[1].url | uri | 1 | 1 | "code" | |||||||||||||||||||||
48 | 28 | PID-28 | Nationality | CWE | 0 | 1 | extension[5].extension[1].valueCodeableConcept | CodeableConcept | 1 | 1 | CWE[CodeableConcept] | The standard extension does not include a value set | ||||||||||||||||||||
49 | 29 | PID-29 | Patient Death Date and Time | DTM | 0 | 1 | deceasedDateTime | dateTime | 0 | 1 | ||||||||||||||||||||||
50 | 30 | PID-30 | Patient Death Indicator | ID | 0 | 1 | IF PID-29 NOT VALUED | deceasedBoolean | boolean | 0 | 1 | ID[Boolean] | Yes/NoIndicator | |||||||||||||||||||
51 | 31 | PID-31 | Identity Unknown Indicator | ID | 0 | 1 | extension??-identityUnknown | boolean | 0 | 1 | ID[Boolean] | Yes/NoIndicator | ||||||||||||||||||||
52 | 32 | PID-32 | Identity Reliability Code | CWE | 0 | -1 | ||||||||||||||||||||||||||
53 | 33 | PID-33 | Last Update Date/Time | DTM | 0 | 1 | ||||||||||||||||||||||||||
54 | 34 | PID-34 | Last Update Facility | HD | 0 | 1 | ||||||||||||||||||||||||||
55 | 35 | PID-35 | Taxonomic Classification Code | CWE | 0 | 1 | extension[6].url | uri | 0 | -1 | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |||||||||||||||||||||
56 | 35 | PID-35 | Taxonomic Classification Code | CWE | 0 | 1 | extension[6].extension[1].url | uri | 0 | 1 | "species" | |||||||||||||||||||||
57 | 35 | PID-35 | Taxonomic Classification Code | CWE | 0 | 1 | extension[6].extension[1].valueCodeableConcept | CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||||||||||||||||
58 | 36 | PID-36 | Breed Code | CWE | 0 | 1 | extension[6].url | uri | 0 | -1 | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |||||||||||||||||||||
59 | 36 | PID-36 | Breed Code | CWE | 0 | 1 | extension[6].extension[2].url | uri | 0 | 1 | "breed" | |||||||||||||||||||||
60 | 36 | PID-36 | Breed Code | CWE | 0 | 1 | extension[6].extension[2].valueCodeableConcept | CodeableConcept | 0 | 1 | CWE[CodeableConcept] | |||||||||||||||||||||
61 | 37 | PID-37 | Strain | ST | 0 | 1 | If this is necessary, it should be an update to the existing animal extension | |||||||||||||||||||||||||
62 | 38 | PID-38 | Production Class Code | CWE | 0 | 2 | ||||||||||||||||||||||||||
63 | 39 | PID-39 | Tribal Citizenship | CWE | 0 | -1 | extension[7].url | uri | 1 | 1 | "http://hl7.org/fhir/StructureDefinition/patient-citizenship" | |||||||||||||||||||||
64 | 39 | PID-39 | Tribal Citizenship | CWE | 0 | -1 | extension[7].extension[1].url | uri | 1 | 1 | "code" | |||||||||||||||||||||
65 | 39 | PID-39 | Tribal Citizenship | CWE | 0 | -1 | extension[7].extension[1].valueCodeableConcept | CodeableConcept | 1 | 1 | CWE[CodeableConcept] | The standard extension does not include a value set. Also suggest that the extension should not be limited to "country". Consider adding a .type to the extension to distinguish tribal vs. "country" (or whatever we call it), or otherwise add an extension for tribal citizenship to accommodate the return flow. | ||||||||||||||||||||
66 | 40 | PID-40 | Patient Telecommunication Information | XTN | 0 | -1 | telecom[3] | ContactPoint | 0 | -1 | XTN[ContactPoint] | |||||||||||||||||||||
67 | ||||||||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||||||||
72 | ||||||||||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||||||||
74 | ||||||||||||||||||||||||||||||||
75 | ||||||||||||||||||||||||||||||||
76 | ||||||||||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||||||||
78 | ||||||||||||||||||||||||||||||||
79 | ||||||||||||||||||||||||||||||||
80 | ||||||||||||||||||||||||||||||||
81 | ||||||||||||||||||||||||||||||||
82 | ||||||||||||||||||||||||||||||||
83 | ||||||||||||||||||||||||||||||||
84 | ||||||||||||||||||||||||||||||||
85 | ||||||||||||||||||||||||||||||||
86 | ||||||||||||||||||||||||||||||||
87 | ||||||||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||||||||
100 | ||||||||||||||||||||||||||||||||