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 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions
Mappings for the PTEncounter resource profile.
PT_Encounter |
Encounter | |
meta | |
lastUpdated | EVN-2 |
identifier | |
use | if MRG-5.1 or MRG-6.1 = old |
type | |
coding | |
code | PV1-19.5; PV1-50.5 |
text | Translation to [PT] of the display field |
value | PV1-19.1; PV1-50.1 |
period | |
start | PV1-19.7; PV1-50.7 |
end | PV1-19.8; PV1-50.8 |
assigner | |
display | PV1-19.4; PV1-50.4 |
status | ADT^A01, ADT^A04 = 'arrived'; ADT^A02 = 'in-progress'; ADT^A03 = 'finished'; ADT^A08 (if PV1-2 = URG) = 'triaged'; ADT^A11, ADT^A13 = 'canceled'; ADT^A12 = 'entered-in-error'; |
class | PV1-2 |
code | PV1-2 |
type | PV1-4 |
coding | |
code | PV1-4 |
text | Translation to [PT] of the display field |
serviceType | PV1-10 |
coding | |
code | PV1-10 |
text | Translation to [PT] of the display field |
priority | PV2-25 |
coding | |
code | PV2-25 |
text | Translation to [PT] of the display field |
subject | |
reference | Patient/PID-3 c/ SNS; PID-18.1; PID-3 c/ SONHO |
participant | PV1; ROL; ORC |
type | PV1-7; PV1-8; PV1-9; PV1-17; PV1-52, PV2-13, ROL-3, ORC-12 |
coding | |
code | PV1-7 (code=ATND); PV1-8, PV2-13 (code=REF); PV1-9 (code=CON); PV1-17 (code=ADM); PV1-52, ORC-12 (code=PART); ROL-3 |
display | PV1-7 (display=attender); PV1-8, PV2-13 (display=referrer); PV1-9 (display=consultant); PV1-17 (display=admitter); PV1-52, ORC-12 (display=Participation); ROL-3 |
text | Translation to [PT] of the display field |
period | |
start | ROL-5 |
end | ROL-6 |
period | |
start | PV1-44 |
end | PV1-45 |
length | |
value | Calculation performed through the PV1-44 and PV1-45 field; PV2-11 |
reasonCode | EVN-4; PV2-3 |
coding | |
system | PV2-3.3 |
code | PV2-3.1 |
display | PV2-3.2 |
text | Translation to [PT] of the display field |
diagnosis | |
condition | |
reference | Condition/DG1-3.1; DG1-20.1 |
use | DG1-6 |
coding | |
code | DG1-6 |
text | Translation to [PT] of the display field |
rank | DG1-15 |
hospitalization | |
preAdmissionIdentifier | PV1-5 |
type | PV1-5.5 |
coding | |
code | PV1-5.5 |
text | Translation to [PT] of the display field |
value | PV1-5.1 |
period | |
start | PV1-5.7 |
end | PV1-5.8 |
assigner | |
display | PV1-5.4 |
admitSource | PV1-14 |
coding | |
code | PV1-14 |
text | Translation to [PT] of the display field |
reAdmission | PV1-13 |
coding | |
code | PV1-13 |
text | Translation to [PT] of the display field |
dietPreference | PV1-38 |
coding | |
system | PV1-38.3 |
code | PV1-38.1 |
display | PV1-38.2 |
text | Translation to [PT] of the display field |
specialCourtesy | PV1-16 |
coding | |
code | PV1-16 |
text | Translation to [PT] of the display field |
specialArrangement | |
coding | |
code | PV1-15 (if information about wheelchair) |
text | Translation to [PT] of the display field |
dischargeDisposition | PV1-36 |
coding | |
code | PV1-36 |
text | Translation to [PT] of the display field |
location | |
location | PV1-3, PV1-6, PV1-11, PV1-42, PV1-43 |
reference | Location/PV1-3.(1, 2, 3, 4, 7, 8, 10), PV1-6.(1, 2, 3, 4, 7, 8, 10), PV1-11.(1, 2, 3, 4, 7, 8, 10), PV1-42.(1, 2, 3, 4, 7, 8, 10), PV1-43.(1, 2, 3, 4, 7, 8, 10) |
status | default = active |
physicalType | |
coding | |
code | PV1-3.(1, 2, 3, 4, 7, 8, 10); PV1-6.(1, 2, 3, 4, 7, 8, 10); PV1-11.(1, 2, 3, 4, 7, 8, 10); PV1-42.(1, 2, 3, 4, 7, 8, 10); PV1-43.(1, 2, 3, 4, 7, 8, 10) |
text | Translation to [PT] of the display field |
serviceProvider | |
reference | Organization/EVN-7, MSH-6, ORG-2.1, XON-3 or XON-10 (HL7v2.5); ORC-17.1; ORC-21.3 or ORC-21.10 (HL7v2.5) |
PT_Encounter |
Encounter | Entity. Role, or Act, Encounter[@moodCode='EVN'] |
meta | |
id | n/a |
extension | n/a |
text | Act.text? |
contained | N/A |
extension | N/A |
modifierExtension | N/A |
identifier | .id |
id | n/a |
extension | n/a |
use | Role.code or implied by context |
type | Role.code or implied by context |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
system | II.root or Role.id.root |
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) |
period | Role.effectiveTime or implied by context |
id | n/a |
extension | n/a |
start | ./low |
end | ./high |
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
status | .statusCode |
statusHistory | n/a |
id | n/a |
extension | n/a |
modifierExtension | N/A |
status | n/a |
period | n/a |
class | .inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
classHistory | n/a |
id | n/a |
extension | n/a |
modifierExtension | N/A |
class | n/a |
period | n/a |
type | .code |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
serviceType | n/a |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
priority | .priorityCode |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
subject | .participation[typeCode=SBJ]/role[classCode=PAT] |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
episodeOfCare | n/a |
basedOn | .reason.ClinicalDocument |
participant | .participation[typeCode=PFM] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
type | .functionCode |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
period | .time |
id | n/a |
extension | n/a |
start | ./low |
end | ./high |
individual | .role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
appointment | .outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT] |
period | .effectiveTime (low & high) |
id | n/a |
extension | n/a |
start | ./low |
end | ./high |
length | .lengthOfStayQuantity |
id | n/a |
extension | n/a |
value | PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value |
comparator | IVL properties |
unit | PQ.unit |
system | CO.codeSystem, PQ.translation.codeSystem |
code | PQ.code, MO.currency, PQ.translation.code |
reasonCode | .reasonCode |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
reasonReference | .reasonCode |
diagnosis | .outboundRelationship[typeCode=RSON] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
condition | .outboundRelationship[typeCode=RSON].target |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
use | n/a |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
rank | .outboundRelationship[typeCode=RSON].priority |
account | .pertains.A_Account |
hospitalization | .outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
preAdmissionIdentifier | .id |
id | n/a |
extension | n/a |
use | Role.code or implied by context |
type | Role.code or implied by context |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
system | II.root or Role.id.root |
value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) |
period | Role.effectiveTime or implied by context |
id | n/a |
extension | n/a |
start | ./low |
end | ./high |
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
origin | .participation[typeCode=ORG].role |
admitSource | .admissionReferralSourceCode |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
reAdmission | n/a |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
dietPreference | .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"] |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
specialCourtesy | .specialCourtesiesCode |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
specialArrangement | .specialArrangementCode |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
destination | .participation[typeCode=DST] |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
dischargeDisposition | .dischargeDispositionCode |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
location | .participation[typeCode=LOC] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
location | .role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
status | .role.statusCode |
physicalType | |
id | n/a |
extension | n/a |
coding | union(., ./translation) |
id | n/a |
extension | n/a |
system | ./codeSystem |
version | ./codeSystemVersion |
code | ./code |
display | CV.displayName |
userSelected | CD.codingRationale |
text | ./originalText[mediaType/code="text/plain"]/data |
period | .time |
serviceProvider | .particiaption[typeCode=PFM].role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
partOf | .inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN] |
PT_Encounter |
Encounter | |
identifier | PV1-19 |
use | N/A |
type | CX.5 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
system | CX.4 / EI-2-4 |
value | CX.1 / EI.1 |
period | CX.7 + CX.8 |
start | DR.1 |
end | DR.2 |
assigner | CX.4 / (CX.4,CX.9,CX.10) |
status | No clear equivalent in HL7 v2; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16 |
class | PV1-2 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
type | PV1-4 / PV1-18 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
serviceType | PV1-10 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
priority | PV2-25 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
subject | PID-3 |
episodeOfCare | PV1-54, PV1-53 |
participant | ROL |
type | ROL-3 (or maybe PRT-4) |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
period | ROL-5, ROL-6 (or maybe PRT-5) |
start | DR.1 |
end | DR.2 |
individual | ROL-4 |
appointment | SCH-1 / SCH-2 |
period | PV1-44, PV1-45 |
start | DR.1 |
end | DR.2 |
length | (PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes |
value | SN.2 / CQ - N/A |
comparator | SN.1 / CQ.1 |
unit | (see OBX.6 etc.) / CQ.2 |
system | (see OBX.6 etc.) / CQ.2 |
code | (see OBX.6 etc.) / CQ.2 |
reasonCode | EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations ) |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
reasonReference | EVN-4 / PV2-3 (note: PV2-3 is nominally constrained to inpatient admissions; HL7 v2 makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations ) |
diagnosis | |
condition | Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively. |
use | |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
hospitalization | |
preAdmissionIdentifier | PV1-5 |
use | N/A |
type | CX.5 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
system | CX.4 / EI-2-4 |
value | CX.1 / EI.1 |
period | CX.7 + CX.8 |
start | DR.1 |
end | DR.2 |
assigner | CX.4 / (CX.4,CX.9,CX.10) |
admitSource | PV1-14 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
reAdmission | PV1-13 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
dietPreference | PV1-38 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
specialCourtesy | PV1-16 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
specialArrangement | PV1-15 / OBR-30 / OBR-43 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
destination | PV1-37 |
dischargeDisposition | PV1-36 |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
location | |
location | PV1-3 / PV1-6 / PV1-11 / PV1-42 / PV1-43 |
physicalType | |
coding | C*E.1-8, C*E.10-22 |
system | C*E.3 |
version | C*E.7 |
code | C*E.1 |
display | C*E.2 - but note this is not well followed |
userSelected | Sometimes implied by being first |
text | C*E.9. But note many systems use C*E.2 for this |
serviceProvider | PL.6 & PL.1 |