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-Appointment resource profile.
InterweaveAppointment | ||
Appointment | Request | |
identifier | Request.identifier | |
identifier (localIdentifier) | Request.identifier | |
status | Request.status | |
serviceType | Request.code | |
reasonCode | Request.reasonCode | |
reasonReference | Request.reasonReference | |
priority | Request.priority | |
supportingInformation | Request.supportingInfo | |
start | Request.occurrence[x] | |
end | Request.occurrence[x] | |
minutesDuration | Request.occurrence[x] | |
created | Request.authoredOn | |
comment | Request.note | |
basedOn | Request.basedOn | |
participant | Request.performer, Request.subject | |
participant (subject) | Request.performer, Request.subject | |
participant (location) | Request.performer, Request.subject | |
participant (primaryPerformer) | Request.performer, Request.subject | |
requestedPeriod | Request.occurrence[x] |
InterweaveAppointment | ||
Appointment | Entity. Role, or Act, Act[@moodCode <= 'INT'] | |
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 | |
cancelationReason | n/a | |
serviceCategory | n/a, might be inferred from the ServiceDeliveryLocation | |
serviceType | n/a, might be inferred from the ServiceDeliveryLocation | |
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 | |
specialty | .performer.AssignedPerson.code | |
appointmentType | .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 | |
reasonCode | .reasonCode | |
reasonReference | .inboundRelationship[@typeCode = 'RSON'].observation | |
priority | .priorityCode | |
description | .text | |
supportingInformation | .inboundRelationship[@typeCode = 'SPRT'].observation | |
start | .effectiveTime.low | |
end | .effectiveTime.high | |
minutesDuration | .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width | |
slot | .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT'] | |
created | .author.time | |
comment | .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value | |
patientInstruction | .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value | |
basedOn | .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO'] | |
participant | performer | reusableDevice | subject | location | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
type | (performer | reusableDevice | subject | location).@typeCode | |
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 | |
actor | performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation | |
required | (performer | reusableDevice | subject | location).@performInd | |
status | (performer | reusableDevice | subject | location).statusCode | |
period | n/a | |
participant (subject) | performer | reusableDevice | subject | location | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
type | (performer | reusableDevice | subject | location).@typeCode | |
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 | |
actor | performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation | |
id | n/a | |
extension | n/a | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A | |
required | (performer | reusableDevice | subject | location).@performInd | |
status | (performer | reusableDevice | subject | location).statusCode | |
period | n/a | |
participant (location) | performer | reusableDevice | subject | location | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
type | (performer | reusableDevice | subject | location).@typeCode | |
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 | |
actor | performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation | |
id | n/a | |
extension | n/a | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A | |
required | (performer | reusableDevice | subject | location).@performInd | |
status | (performer | reusableDevice | subject | location).statusCode | |
period | n/a | |
participant (primaryPerformer) | performer | reusableDevice | subject | location | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
type | (performer | reusableDevice | subject | location).@typeCode | |
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 | |
actor | performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation | |
id | n/a | |
extension | n/a | |
reference | N/A | |
type | N/A | |
identifier | .identifier | |
display | N/A | |
required | (performer | reusableDevice | subject | location).@performInd | |
status | (performer | reusableDevice | subject | location).statusCode | |
period | n/a | |
requestedPeriod | .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')] |
InterweaveAppointment | ||
Appointment | VEVENT | |
identifier | UID | |
identifier (localIdentifier) | UID | |
status | STATUS | |
serviceCategory | CATEGORIES | |
appointmentType | CLASSIFICATION | |
priority | PRIORITY | |
description | SUMMARY | |
supportingInformation | ATTACH | |
start | DTSTART | |
end | DTEND | |
minutesDuration | DURATION (e.g. PT15M) | |
created | CREATED | |
comment | DESCRIPTION (for internal use) | |
patientInstruction | DESCRIPTION (for patient use) | |
participant | ATTENDEE component to be created | |
type | n/a | |
actor | ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only" | |
required | ROLE=REQ-PARTICIPANT (roleparam) | |
status | ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam) | |
participant (subject) | ATTENDEE component to be created | |
type | n/a | |
actor | ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only" | |
required | ROLE=REQ-PARTICIPANT (roleparam) | |
status | ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam) | |
participant (location) | ATTENDEE component to be created | |
type | n/a | |
actor | ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only" | |
required | ROLE=REQ-PARTICIPANT (roleparam) | |
status | ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam) | |
participant (primaryPerformer) | ATTENDEE component to be created | |
type | n/a | |
actor | ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only" | |
required | ROLE=REQ-PARTICIPANT (roleparam) | |
status | ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam) |
InterweaveAppointment | ||
Appointment | ||
identifier | FiveWs.identifier | |
identifier (localIdentifier) | FiveWs.identifier | |
status | FiveWs.status | |
specialty | FiveWs.class | |
priority | FiveWs.class | |
supportingInformation | FiveWs.context | |
start | FiveWs.init | |
end | FiveWs.done[x] | |
participant | ||
actor | FiveWs.who | |
participant (subject) | ||
actor | FiveWs.who | |
participant (location) | ||
actor | FiveWs.who | |
participant (primaryPerformer) | ||
actor | FiveWs.who |
InterweaveAppointment | ||
Appointment | ||
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 | SCH-1, SCH-2, ARQ-1, ARQ-2 | |
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) | SCH-1, SCH-2, ARQ-1, ARQ-2 | |
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 | SCH-25 | |
serviceType | ||
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 | |
appointmentType | ARQ-7 | |
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 | |
reasonCode | AIS-3, SCH-7 | |
priority | ARQ-12, SCH-11.6 / TQ1-9 | |
description | NTE-3 | |
start | ARQ-11.1, SCH-11.4 / TQ1-7 | |
end | SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9 | |
comment | NTE-3 | |
patientInstruction | NTE-3 | |
participant | PID, AIP, AIG, AIL | |
type | AIP-4, AIG-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 | |
actor | PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3 | |
status | AIP-12, AIG-14 | |
participant (subject) | PID, AIP, AIG, AIL | |
type | AIP-4, AIG-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 | |
actor | PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3 | |
status | AIP-12, AIG-14 | |
participant (location) | PID, AIP, AIG, AIL | |
type | AIP-4, AIG-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 | |
actor | PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3 | |
status | AIP-12, AIG-14 | |
participant (primaryPerformer) | PID, AIP, AIG, AIL | |
type | AIP-4, AIG-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 | |
actor | PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3 | |
status | AIP-12, AIG-14 | |
requestedPeriod | ARQ-11 |