Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
Draft as of 2024-07-15 |
Mappings for the Interweave-Encounter resource profile.
InterweaveEncounter | ||
Encounter | Event | |
identifier | Event.identifier | |
identifier (localIdentifier) | Event.identifier | |
status | Event.status | |
type | Event.code | |
serviceType | Event.code | |
subject | Event.subject | |
episodeOfCare | Event.context | |
basedOn | Event.basedOn | |
participant | Event.performer | |
type | Event.performer.function | |
individual | Event.performer.actor | |
appointment | Event.basedOn | |
period | Event.occurrence[x] | |
length | Event.occurrence[x] | |
reasonCode | Event.reasonCode | |
reasonReference | Event.reasonCode | |
diagnosis | ||
condition | Event.reasonReference | |
diagnosis (chiefComplaint) | ||
condition | Event.reasonReference | |
location | ||
location | Event.location | |
serviceProvider | Event.performer.actor | |
partOf | Event.partOf |
InterweaveEncounter | ||
Encounter | Entity. Role, or Act, Encounter[@moodCode='EVN'] | |
meta | ||
extension | n/a | |
tag | ||
tag (Source) | ||
extension | n/a | |
system | ./codeSystem | |
code | ./code | |
display | CV.displayName | |
userSelected | CD.codingRationale | |
tag (Provenance) | ||
extension | n/a | |
system | ./codeSystem | |
code | ./code | |
display | CV.displayName | |
userSelected | CD.codingRationale | |
text | Act.text? | |
contained | 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 | |
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 | |
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
identifier (localIdentifier) | .id | |
id | n/a | |
extension | n/a | |
use | Role.code or implied by context | |
type | Role.code or implied by context | |
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) | |
assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
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 | |
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 | |
id | n/a | |
extension | n/a | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A | |
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 | |
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] | |
id | n/a | |
extension | n/a | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A | |
period | .effectiveTime (low & high) | |
id | n/a | |
extension | n/a | |
start | ./low | |
end | ./high | |
length | .lengthOfStayQuantity | |
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 | |
diagnosis (chiefComplaint) | .outboundRelationship[typeCode=RSON] | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
condition | .outboundRelationship[typeCode=RSON].target | |
use | n/a | |
rank | .outboundRelationship[typeCode=RSON].priority | |
hospitalization | .outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN] | |
id | n/a | |
modifierExtension | N/A | |
preAdmissionIdentifier | .id | |
origin | .participation[typeCode=ORG].role | |
id | n/a | |
extension | n/a | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A | |
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 | |
dietPreference | .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code="diet"] | |
specialCourtesy | .specialCourtesiesCode | |
specialArrangement | .specialArrangementCode | |
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 | |
period | .time | |
serviceProvider | .particiaption[typeCode=PFM].role | |
partOf | .inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN] | |
id | n/a | |
extension | n/a | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A |
InterweaveEncounter | ||
Encounter | ||
identifier | FiveWs.identifier | |
identifier (localIdentifier) | FiveWs.identifier | |
status | FiveWs.status | |
class | FiveWs.class | |
type | FiveWs.class | |
priority | FiveWs.grade | |
subject | FiveWs.subject[x], FiveWs.subject | |
episodeOfCare | FiveWs.context | |
participant | ||
individual | FiveWs.who | |
period | FiveWs.done[x] | |
reasonCode | FiveWs.why[x] | |
reasonReference | FiveWs.why[x] | |
diagnosis | ||
condition | FiveWs.why[x] | |
diagnosis (chiefComplaint) | ||
condition | FiveWs.why[x] | |
location | ||
location | FiveWs.where[x] |
InterweaveEncounter | ||
Encounter | ||
meta | ||
tag | ||
tag (Source) | ||
system | C*E.3 | |
code | C*E.1 | |
display | C*E.2 - but note this is not well followed | |
userSelected | Sometimes implied by being first | |
tag (Provenance) | ||
system | C*E.3 | |
code | C*E.1 | |
display | C*E.2 - but note this is not well followed | |
userSelected | Sometimes implied by being first | |
identifier | PV1-19 | |
use | N/A | |
type | CX.5 | |
system | CX.4 / EI-2-4 | |
value | CX.1 / EI.1 | |
period | CX.7 + CX.8 | |
assigner | CX.4 / (CX.4,CX.9,CX.10) | |
identifier (localIdentifier) | PV1-19 | |
use | N/A | |
type | CX.5 | |
system | CX.4 / EI-2-4 | |
value | CX.1 / EI.1 | |
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) | |
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 | |
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 | |
diagnosis (chiefComplaint) | ||
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. | |
hospitalization | ||
preAdmissionIdentifier | PV1-5 | |
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 | |
dietPreference | PV1-38 | |
specialCourtesy | PV1-16 | |
specialArrangement | PV1-15 / OBR-30 / OBR-43 | |
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 | |
serviceProvider | PL.6 & PL.1 |