HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
0.0.1 - STU1
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
Official URL: http://hl7.pt/fhir/core/StructureDefinition/17e19b6f-8e82-4c55-948e-85e02764fc9b | Version: 0.0.1 | |||
Active as of 2024-09-23 | Computable Name: PT_MedicationRequest |
A generic MedicationRequest resource for Portugal
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
statusChanged | 0..1 | dateTime | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/a54e3c30-afb4-4bd8-8297-ad40aa181704 | |
Diet | 0..1 | CodeableConcept | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/Diet | |
DispenserInstruction | 0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/DispenserInstruction | |
OrderType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/OrderType | |
ProductType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/ProductType | |
device | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/MEDreqDevice | |
identifier | ||||
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource | |
status | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown | |
statusReason | 0..1 | CodeableConcept | Reason for current status | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
intent | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | |
category | 0..* | CodeableConcept | Type of medication usage Binding: hl7VS-orderType (preferred): FHIR Value set/code system definition for HL7 v2 table 0482 (Order Type) | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
priority | 0..1 | code | routine | urgent | asap | stat | |
medication[x] | 1..1 | Reference(Medication) | Medication to be taken | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
subject | 1..1 | Reference(PT_Patient) | Who or group medication request is for | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
encounter | 0..1 | Reference(PT_Encounter) | Encounter created as part of encounter/admission/stay | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
supportingInformation | 0..* | Reference(Observation) | Information to support ordering of the medication | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
authoredOn | 0..1 | dateTime | When request was initially authored | |
requester | 0..1 | Reference(PT_Practitioner | PT_Organization) | Who/What requested the Request | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
recorder | 0..1 | Reference(PT_Practitioner) | Person who entered the request | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
groupIdentifier | ||||
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource | |
insurance | 0..* | Reference(PT_Coverage) | Associated insurance coverage | |
note | ||||
text | 1..1 | markdown | The annotation - text content (as markdown) | |
dosageInstruction | ||||
text | 0..1 | string | Free text dosage instructions e.g. SIG | |
additionalInstruction | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
timing | ||||
repeat | ||||
Slices for bounds[x] | 0..1 | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
bounds[x]:boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
start | S | 0..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
duration | 0..1 | decimal | How long when it happens | |
durationUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
period | 0..1 | decimal | Event occurs frequency times per period | |
periodUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
timeOfDay | 0..* | time | Time of day for action | |
when | 0..* | code | Code for time period of occurrence | |
code | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: hl7VS-repeatPattern (preferred): FHIR Value set/code system definition for HL7 v2 table 0335 ( Repeat pattern) | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
asNeeded[x] | 0..1 | CodeableConcept | Take "as needed" (for x) Fixed Value: As shown | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
display | 1..1 | string | Representation defined by the system Fixed Value: Catálogo CPHA | |
site | 0..1 | CodeableConcept | Body site to administer to | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
route | 0..1 | CodeableConcept | How drug should enter body | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: https:www.edqm.eu/ | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
method | 0..1 | CodeableConcept | Technique for administering medication Binding: hl7VS-administrationMethod (preferred): FHIR Value set/code system definition for HL7 v2 table 0165 ( ADMINISTRATION METHOD) | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
doseAndRate | ||||
Slices for dose[x] | 0..1 | Range, SimpleQuantity | Amount of medication per dose Slice: Unordered, Open by type:$this | |
dose[x]:doseQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
dose[x]:doseRange | 0..1 | Range | Amount of medication per dose | |
low | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
high | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
Slices for rate[x] | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time Slice: Unordered, Open by type:$this | |
rate[x]:rateQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
maxDosePerPeriod | 0..1 | Ratio | Upper limit on medication per unit of time | |
maxDosePerAdministration | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
code | 0..1 | code | Coded form of the unit | |
dispenseRequest | ||||
initialFill | ||||
quantity | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | |
code | 0..1 | code | Coded form of the unit | |
dispenseInterval | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
numberOfRepeatsAllowed | 0..1 | unsignedInt | Number of refills authorized | |
quantity | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | |
code | 0..1 | code | Coded form of the unit | |
performer | 0..1 | Reference(PT_Organization) | Intended dispenser | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
substitution | ||||
allowed[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not | |
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system | |
priorPrescription | 0..1 | Reference(PT_MedicationRequest) | An order/prescription that is being replaced | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationRequest.category | preferred | Hl7VSOrderTypehttp://terminology.hl7.org/ValueSet/v2-0482 | |
MedicationRequest.dosageInstruction.timing.code | preferred | Hl7VSRepeatPatternhttp://terminology.hl7.org/ValueSet/v2-0335 | |
MedicationRequest.dosageInstruction.method | preferred | Hl7VSAdministrationMethodhttp://terminology.hl7.org/ValueSet/v2-0165 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
statusChanged | 0..1 | dateTime | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/a54e3c30-afb4-4bd8-8297-ad40aa181704 | |
Diet | 0..1 | CodeableConcept | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/Diet | |
DispenserInstruction | 0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/DispenserInstruction | |
OrderType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/OrderType | |
ProductType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/ProductType | |
device | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/MEDreqDevice | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. |
category | 0..* | CodeableConcept | Type of medication usage Binding: hl7VS-orderType (preferred): FHIR Value set/code system definition for HL7 v2 table 0482 (Order Type) | |
text | Σ | 0..1 | string | Plain text representation of the concept |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action |
medication[x] | Σ | 1..1 | Reference(Medication) | Medication to be taken |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
subject | Σ | 1..1 | Reference(PT_Patient) | Who or group medication request is for |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
encounter | 0..1 | Reference(PT_Encounter) | Encounter created as part of encounter/admission/stay | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
supportingInformation | 0..* | Reference(Observation) | Information to support ordering of the medication | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
authoredOn | Σ | 0..1 | dateTime | When request was initially authored |
requester | Σ | 0..1 | Reference(PT_Practitioner | PT_Organization) | Who/What requested the Request |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
recorder | 0..1 | Reference(PT_Practitioner) | Person who entered the request | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
insurance | 0..* | Reference(PT_Coverage) | Associated insurance coverage | |
dosageInstruction | 0..* | Dosage | How the medication should be taken | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
text | Σ | 0..1 | string | Plain text representation of the concept |
timing | Σ | 0..1 | Timing | When medication should be administered |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
repeat | ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
duration | Σ | 0..1 | decimal | How long when it happens |
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
period | Σ | 0..1 | decimal | Event occurs frequency times per period |
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
timeOfDay | Σ | 0..* | time | Time of day for action |
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: hl7VS-repeatPattern (preferred): FHIR Value set/code system definition for HL7 v2 table 0335 ( Repeat pattern) |
text | Σ | 0..1 | string | Plain text representation of the concept |
asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
version | 0..0 | string | Version of the system - if relevant | |
code | 0..0 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system Fixed Value: Catálogo CPHA | |
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
text | 0..0 | string | Plain text representation of the concept | |
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
text | Σ | 0..1 | string | Plain text representation of the concept |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
text | Σ | 0..1 | string | Plain text representation of the concept |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: hl7VS-administrationMethod (preferred): FHIR Value set/code system definition for HL7 v2 table 0165 ( ADMINISTRATION METHOD) |
text | Σ | 0..1 | string | Plain text representation of the concept |
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
priorPrescription | 0..1 | Reference(PT_MedicationRequest) | An order/prescription that is being replaced | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | |
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason from the FHIR Standard | |
MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | |
MedicationRequest.category | preferred | Hl7VSOrderTypehttp://terminology.hl7.org/ValueSet/v2-0482 | |
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | |
MedicationRequest.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.code | preferred | Hl7VSRepeatPatternhttp://terminology.hl7.org/ValueSet/v2-0335 | |
MedicationRequest.dosageInstruction.asNeeded[x] | example | Fixed Value: null("Catálogo CPHA")http://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationRequest.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | |
MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | |
MedicationRequest.dosageInstruction.method | preferred | Hl7VSAdministrationMethodhttp://terminology.hl7.org/ValueSet/v2-0165 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
tim-1 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
tim-2 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
tim-4 | error | MedicationRequest.dosageInstruction.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
tim-5 | error | MedicationRequest.dosageInstruction.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
tim-6 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
tim-7 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
tim-8 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
tim-9 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
tim-10 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
statusChanged | 0..1 | dateTime | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/a54e3c30-afb4-4bd8-8297-ad40aa181704 | |||||
Diet | 0..1 | CodeableConcept | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/Diet | |||||
DispenserInstruction | 0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/DispenserInstruction | |||||
OrderType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/OrderType | |||||
ProductType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/ProductType | |||||
device | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/MEDreqDevice | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External ids for this request | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
status | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | ||||
category | 0..* | CodeableConcept | Type of medication usage Binding: hl7VS-orderType (preferred): FHIR Value set/code system definition for HL7 v2 table 0482 (Order Type) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
reported[x] | Σ | 0..1 | Reported rather than primary record | |||||
reportedBoolean | boolean | |||||||
reportedReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
medication[x] | Σ | 1..1 | Reference(Medication) | Medication to be taken | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
subject | Σ | 1..1 | Reference(PT_Patient) | Who or group medication request is for | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | 0..1 | Reference(PT_Encounter) | Encounter created as part of encounter/admission/stay | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
supportingInformation | 0..* | Reference(Observation) | Information to support ordering of the medication | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
authoredOn | Σ | 0..1 | dateTime | When request was initially authored | ||||
requester | Σ | 0..1 | Reference(PT_Practitioner | PT_Organization) | Who/What requested the Request | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
performer | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | ||||
recorder | 0..1 | Reference(PT_Practitioner) | Person who entered the request | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reasonReference | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
courseOfTherapyType | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||
insurance | 0..* | Reference(PT_Coverage) | Associated insurance coverage | |||||
note | 0..* | Annotation | Information about the prescription | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
dosageInstruction | 0..* | Dosage | How the medication should be taken | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | Σ | 0..1 | Timing | When medication should be administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
event | Σ | 0..* | dateTime | When the event occurs | ||||
repeat | ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |||||
boundsDuration | Duration | |||||||
boundsRange | Range | |||||||
boundsPeriod | Period | |||||||
bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
count | Σ | 0..1 | positiveInt | Number of times to repeat | ||||
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
duration | Σ | 0..1 | decimal | How long when it happens | ||||
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) | ||||
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
period | Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
timeOfDay | Σ | 0..* | time | Time of day for action | ||||
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: hl7VS-repeatPattern (preferred): FHIR Value set/code system definition for HL7 v2 table 0335 ( Repeat pattern) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. Fixed Value: As shown | ||||
id | 0..0 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | Extension | Additional content defined by implementations | |||||
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..0 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |||||
version | 0..0 | string | Version of the system - if relevant | |||||
code | 0..0 | code | Symbol in syntax defined by the system | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Catálogo CPHA | |||||
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
text | 0..0 | string | Plain text representation of the concept | |||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https:www.edqm.eu/ | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: hl7VS-administrationMethod (preferred): FHIR Value set/code system definition for HL7 v2 table 0165 ( ADMINISTRATION METHOD) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |||||
doseRange | Range | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
dose[x]:doseRange | Σ | 0..1 | Range | Amount of medication per dose | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
low | Σ | 0..1 | SimpleQuantity | Low limit | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
high | Σ | 0..1 | SimpleQuantity | High limit | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
Slices for rate[x] | Σ | 0..1 | Amount of medication per unit of time Slice: Unordered, Open by type:$this | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
rate[x]:rateQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
dispenseRequest | 0..1 | BackboneElement | Medication supply authorization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
initialFill | 0..1 | BackboneElement | First fill details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
quantity | 0..1 | SimpleQuantity | First fill quantity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
duration | 0..1 | Duration | First fill duration | |||||
dispenseInterval | 0..1 | Duration | Minimum period of time between dispenses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
validityPeriod | 0..1 | Period | Time period supply is authorized for | |||||
numberOfRepeatsAllowed | 0..1 | unsignedInt | Number of refills authorized | |||||
quantity | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
expectedSupplyDuration | 0..1 | Duration | Number of days supply per dispense | |||||
performer | 0..1 | Reference(PT_Organization) | Intended dispenser | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
substitution | 0..1 | BackboneElement | Any restrictions on medication substitution | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
allowed[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reason | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
priorPrescription | 0..1 | Reference(PT_MedicationRequest) | An order/prescription that is being replaced | |||||
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||
eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationRequest.identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | ||||
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason from the FHIR Standard | ||||
MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | ||||
MedicationRequest.category | preferred | Hl7VSOrderTypehttp://terminology.hl7.org/ValueSet/v2-0482 | ||||
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
MedicationRequest.medication[x].type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.encounter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.supportingInformation.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.requester.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
MedicationRequest.recorder.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationRequest.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationRequest.groupIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationRequest.groupIdentifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.code | preferred | Hl7VSRepeatPatternhttp://terminology.hl7.org/ValueSet/v2-0335 | ||||
MedicationRequest.dosageInstruction.asNeeded[x] | example | Fixed Value: null("Catálogo CPHA")http://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.method | preferred | Hl7VSAdministrationMethodhttp://terminology.hl7.org/ValueSet/v2-0165 | ||||
MedicationRequest.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationRequest.dispenseRequest.dispenseInterval.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dispenseRequest.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
qty-3 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity, MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity, MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
tim-1 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
tim-2 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
tim-4 | error | MedicationRequest.dosageInstruction.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
tim-5 | error | MedicationRequest.dosageInstruction.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
tim-6 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
tim-7 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
tim-8 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
tim-9 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
tim-10 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from MedicationRequest
Summary
Must-Support: 2 elements
Fixed: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
statusChanged | 0..1 | dateTime | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/a54e3c30-afb4-4bd8-8297-ad40aa181704 | |
Diet | 0..1 | CodeableConcept | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/Diet | |
DispenserInstruction | 0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/DispenserInstruction | |
OrderType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/OrderType | |
ProductType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/ProductType | |
device | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/MEDreqDevice | |
identifier | ||||
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource | |
status | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown | |
statusReason | 0..1 | CodeableConcept | Reason for current status | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
intent | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | |
category | 0..* | CodeableConcept | Type of medication usage Binding: hl7VS-orderType (preferred): FHIR Value set/code system definition for HL7 v2 table 0482 (Order Type) | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
priority | 0..1 | code | routine | urgent | asap | stat | |
medication[x] | 1..1 | Reference(Medication) | Medication to be taken | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
subject | 1..1 | Reference(PT_Patient) | Who or group medication request is for | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
encounter | 0..1 | Reference(PT_Encounter) | Encounter created as part of encounter/admission/stay | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
supportingInformation | 0..* | Reference(Observation) | Information to support ordering of the medication | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
authoredOn | 0..1 | dateTime | When request was initially authored | |
requester | 0..1 | Reference(PT_Practitioner | PT_Organization) | Who/What requested the Request | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
recorder | 0..1 | Reference(PT_Practitioner) | Person who entered the request | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
groupIdentifier | ||||
value | 0..1 | string | The value that is unique | |
assigner | ||||
display | 0..1 | string | Text alternative for the resource | |
insurance | 0..* | Reference(PT_Coverage) | Associated insurance coverage | |
note | ||||
text | 1..1 | markdown | The annotation - text content (as markdown) | |
dosageInstruction | ||||
text | 0..1 | string | Free text dosage instructions e.g. SIG | |
additionalInstruction | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
timing | ||||
repeat | ||||
Slices for bounds[x] | 0..1 | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
bounds[x]:boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
start | S | 0..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
duration | 0..1 | decimal | How long when it happens | |
durationUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
period | 0..1 | decimal | Event occurs frequency times per period | |
periodUnit | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) | |
timeOfDay | 0..* | time | Time of day for action | |
when | 0..* | code | Code for time period of occurrence | |
code | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: hl7VS-repeatPattern (preferred): FHIR Value set/code system definition for HL7 v2 table 0335 ( Repeat pattern) | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
asNeeded[x] | 0..1 | CodeableConcept | Take "as needed" (for x) Fixed Value: As shown | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
display | 1..1 | string | Representation defined by the system Fixed Value: Catálogo CPHA | |
site | 0..1 | CodeableConcept | Body site to administer to | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
route | 0..1 | CodeableConcept | How drug should enter body | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: https:www.edqm.eu/ | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
method | 0..1 | CodeableConcept | Technique for administering medication Binding: hl7VS-administrationMethod (preferred): FHIR Value set/code system definition for HL7 v2 table 0165 ( ADMINISTRATION METHOD) | |
coding | ||||
system | 0..1 | uri | Identity of the terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
text | 0..1 | string | Plain text representation of the concept | |
doseAndRate | ||||
Slices for dose[x] | 0..1 | Range, SimpleQuantity | Amount of medication per dose Slice: Unordered, Open by type:$this | |
dose[x]:doseQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
dose[x]:doseRange | 0..1 | Range | Amount of medication per dose | |
low | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
high | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
Slices for rate[x] | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time Slice: Unordered, Open by type:$this | |
rate[x]:rateQuantity | 0..1 | SimpleQuantity | A fixed quantity (no comparator) | |
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form | |
code | 0..1 | code | Coded form of the unit | |
maxDosePerPeriod | 0..1 | Ratio | Upper limit on medication per unit of time | |
maxDosePerAdministration | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
code | 0..1 | code | Coded form of the unit | |
dispenseRequest | ||||
initialFill | ||||
quantity | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | |
code | 0..1 | code | Coded form of the unit | |
dispenseInterval | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
numberOfRepeatsAllowed | 0..1 | unsignedInt | Number of refills authorized | |
quantity | ||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |
unit | 0..1 | string | Unit representation | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | |
code | 0..1 | code | Coded form of the unit | |
performer | 0..1 | Reference(PT_Organization) | Intended dispenser | |
reference | 0..1 | string | Literal reference, Relative, internal or absolute URL | |
substitution | ||||
allowed[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not | |
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system | |
priorPrescription | 0..1 | Reference(PT_MedicationRequest) | An order/prescription that is being replaced | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationRequest.category | preferred | Hl7VSOrderTypehttp://terminology.hl7.org/ValueSet/v2-0482 | |
MedicationRequest.dosageInstruction.timing.code | preferred | Hl7VSRepeatPatternhttp://terminology.hl7.org/ValueSet/v2-0335 | |
MedicationRequest.dosageInstruction.method | preferred | Hl7VSAdministrationMethodhttp://terminology.hl7.org/ValueSet/v2-0165 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
statusChanged | 0..1 | dateTime | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/a54e3c30-afb4-4bd8-8297-ad40aa181704 | |
Diet | 0..1 | CodeableConcept | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/Diet | |
DispenserInstruction | 0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/DispenserInstruction | |
OrderType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/OrderType | |
ProductType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/ProductType | |
device | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/MEDreqDevice | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. |
category | 0..* | CodeableConcept | Type of medication usage Binding: hl7VS-orderType (preferred): FHIR Value set/code system definition for HL7 v2 table 0482 (Order Type) | |
text | Σ | 0..1 | string | Plain text representation of the concept |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action |
medication[x] | Σ | 1..1 | Reference(Medication) | Medication to be taken |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
subject | Σ | 1..1 | Reference(PT_Patient) | Who or group medication request is for |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
encounter | 0..1 | Reference(PT_Encounter) | Encounter created as part of encounter/admission/stay | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
supportingInformation | 0..* | Reference(Observation) | Information to support ordering of the medication | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
authoredOn | Σ | 0..1 | dateTime | When request was initially authored |
requester | Σ | 0..1 | Reference(PT_Practitioner | PT_Organization) | Who/What requested the Request |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
recorder | 0..1 | Reference(PT_Practitioner) | Person who entered the request | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
insurance | 0..* | Reference(PT_Coverage) | Associated insurance coverage | |
dosageInstruction | 0..* | Dosage | How the medication should be taken | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
text | Σ | 0..1 | string | Plain text representation of the concept |
timing | Σ | 0..1 | Timing | When medication should be administered |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
repeat | ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
duration | Σ | 0..1 | decimal | How long when it happens |
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
period | Σ | 0..1 | decimal | Event occurs frequency times per period |
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). |
timeOfDay | Σ | 0..* | time | Time of day for action |
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: hl7VS-repeatPattern (preferred): FHIR Value set/code system definition for HL7 v2 table 0335 ( Repeat pattern) |
text | Σ | 0..1 | string | Plain text representation of the concept |
asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. Fixed Value: As shown |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..0 | string | Unique id for inter-element referencing | |
extension | 0..0 | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |
version | 0..0 | string | Version of the system - if relevant | |
code | 0..0 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system Fixed Value: Catálogo CPHA | |
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |
text | 0..0 | string | Plain text representation of the concept | |
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
text | Σ | 0..1 | string | Plain text representation of the concept |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
text | Σ | 0..1 | string | Plain text representation of the concept |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: hl7VS-administrationMethod (preferred): FHIR Value set/code system definition for HL7 v2 table 0165 ( ADMINISTRATION METHOD) |
text | Σ | 0..1 | string | Plain text representation of the concept |
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
priorPrescription | 0..1 | Reference(PT_MedicationRequest) | An order/prescription that is being replaced | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | |
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason from the FHIR Standard | |
MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | |
MedicationRequest.category | preferred | Hl7VSOrderTypehttp://terminology.hl7.org/ValueSet/v2-0482 | |
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | |
MedicationRequest.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | |
MedicationRequest.dosageInstruction.timing.code | preferred | Hl7VSRepeatPatternhttp://terminology.hl7.org/ValueSet/v2-0335 | |
MedicationRequest.dosageInstruction.asNeeded[x] | example | Fixed Value: null("Catálogo CPHA")http://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationRequest.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | |
MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | |
MedicationRequest.dosageInstruction.method | preferred | Hl7VSAdministrationMethodhttp://terminology.hl7.org/ValueSet/v2-0165 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
tim-1 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
tim-2 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
tim-4 | error | MedicationRequest.dosageInstruction.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
tim-5 | error | MedicationRequest.dosageInstruction.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
tim-6 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
tim-7 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
tim-8 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
tim-9 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
tim-10 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
statusChanged | 0..1 | dateTime | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/a54e3c30-afb4-4bd8-8297-ad40aa181704 | |||||
Diet | 0..1 | CodeableConcept | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/Diet | |||||
DispenserInstruction | 0..1 | Coding | Extension URL: http://hl7.pt/fhir/core/StructureDefinition/DispenserInstruction | |||||
OrderType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/OrderType | |||||
ProductType | 0..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/ProductType | |||||
device | 0..* | (Complex) | Optional Extensions Element URL: http://hl7.pt/fhir/core/StructureDefinition/MEDreqDevice | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External ids for this request | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
status | ?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. | ||||
category | 0..* | CodeableConcept | Type of medication usage Binding: hl7VS-orderType (preferred): FHIR Value set/code system definition for HL7 v2 table 0482 (Order Type) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
reported[x] | Σ | 0..1 | Reported rather than primary record | |||||
reportedBoolean | boolean | |||||||
reportedReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
medication[x] | Σ | 1..1 | Reference(Medication) | Medication to be taken | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
subject | Σ | 1..1 | Reference(PT_Patient) | Who or group medication request is for | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
encounter | 0..1 | Reference(PT_Encounter) | Encounter created as part of encounter/admission/stay | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
supportingInformation | 0..* | Reference(Observation) | Information to support ordering of the medication | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
authoredOn | Σ | 0..1 | dateTime | When request was initially authored | ||||
requester | Σ | 0..1 | Reference(PT_Practitioner | PT_Organization) | Who/What requested the Request | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
performer | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||
performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | ||||
recorder | 0..1 | Reference(PT_Practitioner) | Person who entered the request | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
reasonCode | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reasonReference | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
courseOfTherapyType | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||
insurance | 0..* | Reference(PT_Coverage) | Associated insurance coverage | |||||
note | 0..* | Annotation | Information about the prescription | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
dosageInstruction | 0..* | Dosage | How the medication should be taken | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
sequence | Σ | 0..1 | integer | The order of the dosage instructions | ||||
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | Σ | 0..1 | Timing | When medication should be administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
event | Σ | 0..* | dateTime | When the event occurs | ||||
repeat | ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |||||
boundsDuration | Duration | |||||||
boundsRange | Range | |||||||
boundsPeriod | Period | |||||||
bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
count | Σ | 0..1 | positiveInt | Number of times to repeat | ||||
countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
duration | Σ | 0..1 | decimal | How long when it happens | ||||
durationMax | Σ | 0..1 | decimal | How long when it happens (Max) | ||||
durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
period | Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
timeOfDay | Σ | 0..* | time | Time of day for action | ||||
when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: hl7VS-repeatPattern (preferred): FHIR Value set/code system definition for HL7 v2 table 0335 ( Repeat pattern) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. Fixed Value: As shown | ||||
id | 0..0 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | Extension | Additional content defined by implementations | |||||
coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..0 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | |||||
version | 0..0 | string | Version of the system - if relevant | |||||
code | 0..0 | code | Symbol in syntax defined by the system | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Catálogo CPHA | |||||
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
text | 0..0 | string | Plain text representation of the concept | |||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http:snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https:www.edqm.eu/ | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: hl7VS-administrationMethod (preferred): FHIR Value set/code system definition for HL7 v2 table 0165 ( ADMINISTRATION METHOD) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
doseAndRate | Σ | 0..* | Element | Amount of medication administered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. | ||||
Slices for dose[x] | Σ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |||||
doseRange | Range | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
dose[x]:doseRange | Σ | 0..1 | Range | Amount of medication per dose | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
low | Σ | 0..1 | SimpleQuantity | Low limit | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
high | Σ | 0..1 | SimpleQuantity | High limit | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
Slices for rate[x] | Σ | 0..1 | Amount of medication per unit of time Slice: Unordered, Open by type:$this | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
rate[x]:rateQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time | ||||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
dispenseRequest | 0..1 | BackboneElement | Medication supply authorization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
initialFill | 0..1 | BackboneElement | First fill details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
quantity | 0..1 | SimpleQuantity | First fill quantity | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
duration | 0..1 | Duration | First fill duration | |||||
dispenseInterval | 0..1 | Duration | Minimum period of time between dispenses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
validityPeriod | 0..1 | Period | Time period supply is authorized for | |||||
numberOfRepeatsAllowed | 0..1 | unsignedInt | Number of refills authorized | |||||
quantity | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Fixed Value: https:ucum.org/ | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
expectedSupplyDuration | 0..1 | Duration | Number of days supply per dispense | |||||
performer | 0..1 | Reference(PT_Organization) | Intended dispenser | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
substitution | 0..1 | BackboneElement | Any restrictions on medication substitution | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
allowed[x] | 1..1 | CodeableConcept | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reason | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
priorPrescription | 0..1 | Reference(PT_MedicationRequest) | An order/prescription that is being replaced | |||||
detectedIssue | 0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||
eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationRequest.identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 from the FHIR Standard | ||||
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason from the FHIR Standard | ||||
MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 from the FHIR Standard | ||||
MedicationRequest.category | preferred | Hl7VSOrderTypehttp://terminology.hl7.org/ValueSet/v2-0482 | ||||
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
MedicationRequest.medication[x].type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.encounter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.supportingInformation.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.requester.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
MedicationRequest.recorder.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationRequest.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationRequest.groupIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationRequest.groupIdentifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructionshttp://hl7.org/fhir/ValueSet/additional-instruction-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.timing.code | preferred | Hl7VSRepeatPatternhttp://terminology.hl7.org/ValueSet/v2-0335 | ||||
MedicationRequest.dosageInstruction.asNeeded[x] | example | Fixed Value: null("Catálogo CPHA")http://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.method | preferred | Hl7VSAdministrationMethodhttp://terminology.hl7.org/ValueSet/v2-0165 | ||||
MedicationRequest.dosageInstruction.doseAndRate.type | example | DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type from the FHIR Standard | ||||
MedicationRequest.dispenseRequest.dispenseInterval.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
MedicationRequest.dispenseRequest.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
qty-3 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity, MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity, MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
tim-1 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
tim-2 | error | MedicationRequest.dosageInstruction.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
tim-4 | error | MedicationRequest.dosageInstruction.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
tim-5 | error | MedicationRequest.dosageInstruction.timing.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
tim-6 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
tim-7 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
tim-8 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
tim-9 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
tim-10 | error | MedicationRequest.dosageInstruction.timing.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from MedicationRequest
Summary
Must-Support: 2 elements
Fixed: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron