HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
1.0.0 - STU1 International flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/patient-admin-ig/ and changes regularly. See the Directory of published versions

Resource Profile: PTPatient - Mappings

Active as of 2025-10-09

Mappings for the Patient-Pt resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameRIM MappingCDA (R2)FiveWs Pattern MappingHL7 v2 MappingLOINC code for the elementdoco
.. Patient
Patient[classCode=PAT]
ClinicalDocument.recordTarget.patientRole
administrative.individual
... id
... meta
... implicitRules
... text
Act.text?
... contained
N/A
... Slices for extension
.... extension:occupation
N/A
.... extension:patient-record-type
N/A
.... extension:patient-enrollment-category-primarycare
N/A
.... extension:nationality
.... extension:birthplace
N/A
... modifierExtension
N/A
... Slices for identifier
id
.id
FiveWs.identifier
PID-3
.... identifier:All Slices
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:residentCardNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:citizenshipCardNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:taxIdNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:socialSecurityNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:healthCardNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:passportNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:patientInternalIdentifier
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:militaryIDNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:medicalRecordNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:familyRecordNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
.... identifier:birthRegistryNumber
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
...... id
n/a
...... extension
...... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
... active
statusCode
n/a
FiveWs.status
... name
name
.patient.name
  • PID-5
  • PID-9
... telecom
telecom
.telecom
  • PID-13
  • PID-14
  • PID-40
... gender
player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
.patient.administrativeGenderCode
PID-8
... birthDate
player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
.patient.birthTime
PID-7
21112-8
... deceased[x]
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
n/a
PID-30 (bool) and PID-29 (datetime)
... address
addr
.addr
PID-11
.... id
n/a
.... Slices for extension
n/a
..... extension:addressType
..... extension:municipality
..... extension:county
..... extension:parish
..... extension:nuts
.... use
unique(./use)
XAD.7
.... type
unique(./use)
XAD.18
.... text
./formatted
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
.... line
AD.part[parttype = AL]
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
.... city
AD.part[parttype = CTY]
XAD.3
.... district
AD.part[parttype = CNT | CPA]
XAD.9
.... state
AD.part[parttype = STA]
XAD.4
.... postalCode
AD.part[parttype = ZIP]
XAD.5
.... country
AD.part[parttype = CNT]
XAD.6
.... period
./usablePeriod[type="IVL<TS>"]
XAD.12 / XAD.13 + XAD.14
... maritalStatus
player[classCode=PSN]/maritalStatusCode
.patient.maritalStatusCode
PID-16
... multipleBirth[x]
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
n/a
  • PID-24 (bool)
  • PID-25 (integer)
... photo
player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
n/a
OBX-5 - needs a profile
... contact
player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
n/a
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... relationship
code
n/a
  • NK1-7
  • NK1-3
.... name
name
n/a
NK1-2
.... telecom
telecom
n/a
  • NK1-5
  • NK1-6
  • NK1-40
.... address
addr
n/a
NK1-4
..... id
n/a
..... Slices for extension
n/a
...... extension:addressType
...... extension:municipality
...... extension:county
...... extension:parish
...... extension:nuts
..... use
unique(./use)
XAD.7
..... type
unique(./use)
XAD.18
..... text
./formatted
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
..... line
AD.part[parttype = AL]
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
..... city
AD.part[parttype = CTY]
XAD.3
..... district
AD.part[parttype = CNT | CPA]
XAD.9
..... state
AD.part[parttype = STA]
XAD.4
..... postalCode
AD.part[parttype = ZIP]
XAD.5
..... country
AD.part[parttype = CNT]
XAD.6
..... period
./usablePeriod[type="IVL<TS>"]
XAD.12 / XAD.13 + XAD.14
.... gender
player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
n/a
NK1-15
.... organization
scoper
n/a
  • NK1-13
  • NK1-30
  • NK1-31
  • NK1-32
  • NK1-41
.... period
effectiveTime
n/a
... communication
LanguageCommunication
patient.languageCommunication
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... language
player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
.languageCode
  • PID-15
  • LAN-2
.... preferred
preferenceInd
.preferenceInd
PID-15
... generalPractitioner
subjectOf.CareEvent.performer.AssignedEntity
n/a
PD1-4
.... id
n/a
.... Slices for extension
n/a
..... extension:patient-primary-care-period
N/A
.... reference
N/A
.... type
N/A
.... identifier
.identifier
.... display
N/A
... managingOrganization
scoper
.providerOrganization
... link
outboundLink
n/a
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... other
id
n/a
  • PID-3
  • MRG-1
.... type
typeCode
n/a

doco Documentation for this format