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 PTMedicationDispense resource profile.
PT_MedicationDispense |
MedicationDispense | Entity. Role, or Act, Supply[moodCode=EVN] |
text | Act.text? |
contained | N/A |
extension (regulatedAuthorization) | n/a, 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 |
partOf | .outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN] |
status | .statusCode |
statusReason[x] | .outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="not done reason"].value |
category | .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication dispense"].value |
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 |
medication[x] | .participation[typeCode=PRD].role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
subject | .participation[typeCode=SBJ].role[classCode=PAT] |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
context | .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"] |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
supportingInformation | .outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)] |
performer | .participation[typeCode=PRF] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
function | participation[typeCode=PRF].functionCode |
actor | .role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
location | .participation[typeCode=LOC].role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
authorizingPrescription | .outboundRelationship[typeCode=FLFS].target[moodCode=RQO] |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | 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 |
quantity | .quantity |
id | n/a |
extension | n/a |
value | PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value |
unit | PQ.unit |
system | CO.codeSystem, PQ.translation.codeSystem |
code | PQ.code, MO.currency, PQ.translation.code |
daysSupply | effectiveUseTime |
whenPrepared | .effectiveTime[xmi:type=IVL_TS].low |
whenHandedOver | .effectiveTime[xmi:type=IVL_TS].high |
destination | .participation[typeCode=DST].role |
id | n/a |
extension | n/a |
reference | N/A |
type | N/A |
identifier | .identifier |
display | N/A |
receiver | .participation[typeCode=RCV].role |
note | .inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN] |
id | n/a |
extension | n/a |
author[x] | Act.participant[typeCode=AUT].role |
time | Act.effectiveTime |
text | Act.text |
dosageInstruction | .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
sequence | .text |
text | .text |
additionalInstruction | .text |
patientInstruction | .text |
timing | .effectiveTime |
id | n/a |
extension | n/a |
modifierExtension | N/A |
event | QLIST<TS> |
repeat | Implies PIVL or EIVL |
id | n/a |
extension | n/a |
bounds[x] | IVL(TS) used in a QSI |
count | PIVL.count |
countMax | PIVL.count |
duration | PIVL.phase |
durationMax | PIVL.phase |
durationUnit | PIVL.phase.unit |
frequency | PIVL.phase |
frequencyMax | PIVL.phase |
period | PIVL.phase |
periodMax | PIVL.phase |
periodUnit | PIVL.phase.unit |
dayOfWeek | n/a |
timeOfDay | n/a |
when | EIVL.event |
offset | EIVL.offset |
code | QSC.code |
asNeeded[x] | .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept |
site | .approachSiteCode |
route | .routeCode |
method | .doseQuantity |
doseAndRate | |
id | n/a |
extension | n/a |
dose[x] | .doseQuantity |
rate[x] | .rateQuantity |
maxDosePerPeriod | .maxDoseQuantity |
maxDosePerAdministration | not supported |
maxDosePerLifetime | not supported |
substitution | .outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN] |
id | n/a |
extension | n/a |
modifierExtension | N/A |
wasSubstituted | .actionNegationInd |
type | .code |
reason | .reasonCode |
responsibleParty | .participation[typeCode=PFM].role[classCode=ASSIGN] |
detectedIssue | .inboundRelationship[typeCode=SUBJ]/source[classCode=ALRT,moodCode=EVN].value |
eventHistory | .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN] |
PT_MedicationDispense |
MedicationDispense | |
identifier | CombinedMedicationDispense.id |
status | CombinedMedicationDispense.SupplyEvent.statusCode |
medication[x] | CombinedMedicationRequest.component1.AdministrationRequest.consumable |
authorizingPrescription | CombinedMedicationDispense.inFulfillmentOf |
type | CombinedMedicationDispense.SupplyEvent.code |
quantity | CombinedMedicationDispense.SupplyEvent.quantity |
whenPrepared | CombinedMedicationDispense.SupplyEvent.effectiveTime |
whenHandedOver | CombinedMedicationDispense.SupplyEvent.effectiveTime |
destination | CombinedMedicationDispense.SupplyEvent.destination |
receiver | CombinedMedicationDispense.SupplyEvent.receiver |
substitution | CombinedMedicationDispense.substitutionMade |
type | CombinedMedicationDispense.substitutionMade.code |
reason | CombinedMedicationDispense.substitutionMade.reasonCode |
responsibleParty | CombinedMedicationDispense.substitutionMade.ResponsibleParty |
PT_MedicationDispense |
MedicationDispense | |
identifier | |
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) |
category | |
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 |
medication[x] | RXD-2-Dispense/Give Code |
subject | PID-3-Patient ID List |
authorizingPrescription | ORC-2 Placer Order Number |
type | RXD-33-Dispense Type |
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 |
quantity | RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system |
value | SN.2 / CQ - N/A |
unit | (see OBX.6 etc.) / CQ.2 |
system | (see OBX.6 etc.) / CQ.2 |
code | (see OBX.6 etc.) / CQ.2 |
daysSupply | TQ1.6 Timing/Quantity Segment Service Duration.
Prior to v2.5, ORC.7.3 Common Order Segment / Quantity/Timing / Duration component. This is a formatted string, first character for the time unit (e.g., D=days), followed by the value. For example, “D14” represents “14 days supply”
From v2.5 on, TQ1.6 Timing/Quantity Segment / Service Duration. This is a CQ data type (<Quantity (NM)> ^ <Units (CWE)>), thus for days supply, assuming the unit of measure is “days”, the numeric value is TQ1.6.1 (…|14^
For backwards compatibility, ORC.7 was permitted through v2.6. Both forms (field and segment) may be present in v2.5, v2.5.1, and v2.6 |
whenPrepared | RXD-3-Date/Time Dispensed |
whenHandedOver | RXD-3-Date/Time Dispensed |
destination | RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address |
note | RXD-9 Dispense Notes |
author[x] | N/A |
time | N/A |
text | N/A |
dosageInstruction | |
sequence | TQ1-1 |
text | RXO-6; RXE-21 |
additionalInstruction | RXO-7 |
patientInstruction | RXO-7 |
asNeeded[x] | TQ1-9 |
site | RXR-2 |
route | RXR-1 |
method | RXR-4 |
doseAndRate | TQ1-2 |
type | RXO-21; RXE-23 |
dose[x] | RXO-2, RXE-3 |
rate[x] | RXE22, RXE23, RXE-24 |
maxDosePerPeriod | RXO-23, RXE-19 |
substitution | |
type | RXO-9-Allow Substitutions / RXE-9-Substitution Status |