RIVO-Noord Zorgviewer Implementation Guide
1.9.1 - sprint47
RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.9.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/MedicationRequest | Version: 1.9.1 | |||
Active as of 2024-12-10 | Computable Name: MedicationAgreement |
Medicatieafspraak
Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.
Opvragen (search) definities
GET <ontsluiten-bronsysteem-base>/MedicationRequest?category=http://snomed.info/sct|16076005&_include=MedicationRequest:medication&patient=<fhir_patient_id>
De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.
Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):
"meta": {
"extension": [ {
"url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
"valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
} ]
}
Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient
). Elke patient heeft een Patient.managingOrganization
en in de gerefereerde Organization.identifier
staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Zib MedicationAgreement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | Zib MedicationAgreement | MedicationAgreement | |
category | ||||
text | S | 0..1 | string | Plain text representation of the concept |
medicationReference | ||||
display | S | 0..1 | string | Text alternative for the resource |
authoredOn | S | 1..1 | dateTime | MedicationAgreementDateTime |
dosageInstruction | ||||
text | S | 0..1 | string | Description |
route | ||||
text | S | 0..1 | string | Plain text representation of the concept |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | Zib MedicationAgreement | MedicationAgreement dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
periodOfUse | 0..1 | Period | PeriodOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
usageDuration | 0..1 | Duration | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
additionalInformation | 0..* | (Complex) | MedicationAgreementAdditionalInformation URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: MedicatieafspraakAanvullendeInformatieCodelijst (extensible): MedicatieafspraakAanvullendeInformatieCodelijst Example Example of MedicationAgreementAdditionalInformation: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.2.3.2050","code":"1","display":"Bewust hoge dosering"}]} | |
medicationTreatment | 0..1 | Identifier | Medication Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
nl-core-episodeofcare | 0..* | Reference(nl-core-episodeofcare) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/extension-context-nl-core-episodeofcare ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
modifierExtension:stopType | ?! | 0..1 | Zib Medication StopType | StopType ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Stoptype (required) | |
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
status | ?!Σ | 0..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: MedicationRequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription |
intent | ?!Σ | 1..1 | code | proposal | plan | order | instance-order Binding: MedicationRequestIntent (required): The kind of medication order Fixed Value: order |
category | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationRequestCategory (preferred): A coded concept identifying where the medication ordered is expected to be consumed or administered | |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
coding:medicationAgreementCode | Σ | 0..* | Coding | MedicationAgreementCode |
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 Fixed Value: 16076005 |
text | SΣ | 0..1 | string | Plain text representation of the concept |
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this |
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AgreedMedicine |
display | SΣ | 0..1 | string | Text alternative for the resource |
subject | Σ | 1..1 | Reference(nl-core-patient | Group) | Who or group medication request is for |
authoredOn | SΣ | 1..1 | dateTime | MedicationAgreementDateTime |
dosageInstruction | 0..* | Zib InstructionsForUse | InstructionsForUse ele-1: All FHIR elements must have a @value or children | |
text | SΣ | 0..1 | string | Description |
Slices for asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication As Needed Reason Codes (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. |
asNeeded[x]:asNeededCodeableConcept | Σ | 0..1 | CodeableConcept | AsNeeded Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst |
route | Σ | 0..1 | CodeableConcept | RouteOfAdministration Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]} |
text | SΣ | 0..1 | string | Plain text representation of the concept |
Slices for dose[x] | Σ | 0..1 | Dose Slice: Unordered, Closed by type:$this | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Binding: G-Standaard Eenhedentabel (required): GstdTabel902 ele-1: All FHIR elements must have a @value or children 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 |
dose[x]:doseRange | Σ | 0..1 | Range | Amount of medication per dose |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.extension:additionalInformation.value[x]:valueCodeableConcept | extensible | MedicatieafspraakAanvullendeInformatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.6.3--20171231000000 | |
MedicationRequest.modifierExtension:stopType.value[x]:valueCodeableConcept | required | Stoptypehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300 | |
MedicationRequest.status | required | MedicationRequestStatushttp://hl7.org/fhir/ValueSet/medication-request-status from the FHIR Standard | |
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medication-request-intent from the FHIR Standard | |
MedicationRequest.category | preferred | MedicationRequestCategoryhttp://hl7.org/fhir/ValueSet/medication-request-category from the FHIR Standard | |
MedicationRequest.dosageInstruction.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept | extensible | ZonodigCriteriumCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.4--20171231000000 | |
MedicationRequest.dosageInstruction.route | extensible | MedicatieToedieningswegCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.9 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.1--20171231000000 | |
MedicationRequest.dosageInstruction.dose[x]:doseQuantity | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (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.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationRequest.dosageInstruction.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | Zib MedicationAgreement | MedicationAgreement | |||||
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: Common Languages (extensible): 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 | |||||
periodOfUse | 0..1 | Period | PeriodOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse | |||||
usageDuration | 0..1 | Duration | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration | |||||
additionalInformation | 0..* | (Complex) | MedicationAgreementAdditionalInformation URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: MedicatieafspraakAanvullendeInformatieCodelijst (extensible): MedicatieafspraakAanvullendeInformatieCodelijst Example Example of MedicationAgreementAdditionalInformation: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.2.3.2050","code":"1","display":"Bewust hoge dosering"}]} | |||||
medicationTreatment | 0..1 | Identifier | Medication Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |||||
nl-core-episodeofcare | 0..* | Reference(nl-core-episodeofcare) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/extension-context-nl-core-episodeofcare | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:stopType | ?! | 0..1 | Zib Medication StopType | StopType | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Stoptype (required) | |||||
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule | ||||
identifier | 0..* | Identifier | External ids for this request | |||||
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | Protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest) | What request fulfills | ||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
status | ?!Σ | 0..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: MedicationRequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | order | instance-order Binding: MedicationRequestIntent (required): The kind of medication order Fixed Value: order | ||||
category | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationRequestCategory (preferred): A coded concept identifying where the medication ordered is expected to be consumed or administered | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
coding:medicationAgreementCode | Σ | 0..* | Coding | MedicationAgreementCode | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
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 Fixed Value: 16076005 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
priority | Σ | 0..1 | code | routine | urgent | stat | asap Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request | ||||
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this | ||||
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AgreedMedicine | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
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 | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | SΣ | 0..1 | string | Text alternative for the resource | ||||
subject | Σ | 1..1 | Reference(nl-core-patient | Group) | Who or group medication request is for | ||||
context | 0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created during encounter/admission/stay | |||||
supportingInformation | 0..* | Reference(Resource) | Information to support ordering of the medication | |||||
authoredOn | SΣ | 1..1 | dateTime | MedicationAgreementDateTime | ||||
requester | ΣC | 0..1 | BackboneElement | Prescriber mps-1: onBehalfOf can only be specified if agent is practitioner or device | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
agent | Σ | 1..1 | Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | nl-core-relatedperson | Device) | Who ordered the initial medication(s) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
practitionerRole | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
onBehalfOf | ΣC | 0..1 | Reference(nl-core-organization) | Organization agent is acting for | ||||
recorder | 0..1 | Reference(nl-core-practitioner) | Person who entered the request | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
practitionerRole | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
reasonCode | 0..* | CodeableConcept | ReasonMedicationAgreement Binding: RedenMedicatieafspraakCodelijst (extensible): RedenWijzigenOfStakenCodelijst | |||||
reasonReference | 0..* | Reference(Observation | HCIM Problem) | PrescriptionReason | |||||
note | 0..* | Annotation | Comment | |||||
dosageInstruction | 0..* | Zib InstructionsForUse | InstructionsForUse | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
sequence | Σ | 0..1 | integer | SequenceNumber | ||||
text | SΣ | 0..1 | string | Description | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | AdditionalInstructions Binding: Aanvullende gebruiksinstructie (extensible) | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | 0..1 | Zib AdministrationSchedule | AdministeringSchedule | |||||
Slices for asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication As Needed Reason Codes (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. | ||||
asNeeded[x]:asNeededCodeableConcept | Σ | 0..1 | CodeableConcept | AsNeeded Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst | ||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
route | Σ | 0..1 | CodeableConcept | RouteOfAdministration Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]} | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered. | ||||
Slices for dose[x] | Σ | 0..1 | Dose Slice: Unordered, Closed by type:$this | |||||
doseRange | Range | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Binding: G-Standaard Eenhedentabel (required): GstdTabel902 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 | ||||
dose[x]:doseRange | Σ | 0..1 | Range | Amount of medication per dose | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
low | ΣC | 0..1 | SimpleQuantity | Low limit Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | ||||
high | ΣC | 0..1 | SimpleQuantity | High limit Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | ||||
maxDosePerPeriod | Σ | 0..1 | Ratio | MaximumDose | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
numerator | Σ | 0..1 | Quantity | Numerator value Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | ||||
denominator | Σ | 0..1 | Quantity | Denominator value | ||||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
rate[x] | Σ | 0..1 | AdministeringSpeed | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
dispenseRequest | 0..1 | BackboneElement | Medication supply authorization | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
validityPeriod | 0..1 | Period | Time period supply is authorized for | |||||
numberOfRepeatsAllowed | 0..1 | positiveInt | Number of refills authorized | |||||
quantity | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
expectedSupplyDuration | 0..1 | Duration | Number of days supply per dispense | |||||
performer | 0..1 | Reference(Organization) | Intended dispenser | |||||
substitution | 0..1 | BackboneElement | Any restrictions on medication substitution | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
allowed | ?! | 1..1 | boolean | Whether substitution is allowed or not | ||||
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(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 | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationRequest.extension:additionalInformation.value[x]:valueCodeableConcept | extensible | MedicatieafspraakAanvullendeInformatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.6.3--20171231000000 | ||||
MedicationRequest.modifierExtension:stopType.value[x]:valueCodeableConcept | required | Stoptypehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300 | ||||
MedicationRequest.status | required | MedicationRequestStatushttp://hl7.org/fhir/ValueSet/medication-request-status from the FHIR Standard | ||||
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medication-request-intent from the FHIR Standard | ||||
MedicationRequest.category | preferred | MedicationRequestCategoryhttp://hl7.org/fhir/ValueSet/medication-request-category from the FHIR Standard | ||||
MedicationRequest.priority | required | MedicationRequestPriorityhttp://hl7.org/fhir/ValueSet/medication-request-priority from the FHIR Standard | ||||
MedicationRequest.reasonCode | extensible | RedenMedicatieafspraakCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.6.2--20171231000000 | ||||
MedicationRequest.dosageInstruction.additionalInstruction | extensible | AanvullendeGebruiksinstructiehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.9--20160407000000 | ||||
MedicationRequest.dosageInstruction.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept | extensible | ZonodigCriteriumCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.4--20171231000000 | ||||
MedicationRequest.dosageInstruction.site | example | SNOMED CT Anatomical Structure for Administration Site Codeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.route | extensible | MedicatieToedieningswegCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.9 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.1--20171231000000 | ||||
MedicationRequest.dosageInstruction.method | example | SNOMED CT Administration Method Codeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.dose[x]:doseQuantity | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.dosageInstruction.dose[x]:doseRange.low | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.dosageInstruction.dose[x]:doseRange.high | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.dosageInstruction.maxDosePerPeriod.numerator | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mps-1 | error | MedicationRequest.requester | onBehalfOf can only be specified if agent is practitioner or device : (agent.resolve().empty()) or (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not() | |
qty-3 | error | MedicationRequest.dosageInstruction.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationRequest.dosageInstruction.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from Zib MedicationAgreement
Differential View
This structure is derived from Zib MedicationAgreement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | Zib MedicationAgreement | MedicationAgreement | |
category | ||||
text | S | 0..1 | string | Plain text representation of the concept |
medicationReference | ||||
display | S | 0..1 | string | Text alternative for the resource |
authoredOn | S | 1..1 | dateTime | MedicationAgreementDateTime |
dosageInstruction | ||||
text | S | 0..1 | string | Description |
route | ||||
text | S | 0..1 | string | Plain text representation of the concept |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationRequest | 0..* | Zib MedicationAgreement | MedicationAgreement dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
periodOfUse | 0..1 | Period | PeriodOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
usageDuration | 0..1 | Duration | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
additionalInformation | 0..* | (Complex) | MedicationAgreementAdditionalInformation URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: MedicatieafspraakAanvullendeInformatieCodelijst (extensible): MedicatieafspraakAanvullendeInformatieCodelijst Example Example of MedicationAgreementAdditionalInformation: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.2.3.2050","code":"1","display":"Bewust hoge dosering"}]} | |
medicationTreatment | 0..1 | Identifier | Medication Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
nl-core-episodeofcare | 0..* | Reference(nl-core-episodeofcare) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/extension-context-nl-core-episodeofcare ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
modifierExtension:stopType | ?! | 0..1 | Zib Medication StopType | StopType ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Stoptype (required) | |
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
status | ?!Σ | 0..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: MedicationRequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription |
intent | ?!Σ | 1..1 | code | proposal | plan | order | instance-order Binding: MedicationRequestIntent (required): The kind of medication order Fixed Value: order |
category | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationRequestCategory (preferred): A coded concept identifying where the medication ordered is expected to be consumed or administered | |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
coding:medicationAgreementCode | Σ | 0..* | Coding | MedicationAgreementCode |
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 Fixed Value: 16076005 |
text | SΣ | 0..1 | string | Plain text representation of the concept |
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this |
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AgreedMedicine |
display | SΣ | 0..1 | string | Text alternative for the resource |
subject | Σ | 1..1 | Reference(nl-core-patient | Group) | Who or group medication request is for |
authoredOn | SΣ | 1..1 | dateTime | MedicationAgreementDateTime |
dosageInstruction | 0..* | Zib InstructionsForUse | InstructionsForUse ele-1: All FHIR elements must have a @value or children | |
text | SΣ | 0..1 | string | Description |
Slices for asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication As Needed Reason Codes (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. |
asNeeded[x]:asNeededCodeableConcept | Σ | 0..1 | CodeableConcept | AsNeeded Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst |
route | Σ | 0..1 | CodeableConcept | RouteOfAdministration Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]} |
text | SΣ | 0..1 | string | Plain text representation of the concept |
Slices for dose[x] | Σ | 0..1 | Dose Slice: Unordered, Closed by type:$this | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Binding: G-Standaard Eenhedentabel (required): GstdTabel902 ele-1: All FHIR elements must have a @value or children 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 |
dose[x]:doseRange | Σ | 0..1 | Range | Amount of medication per dose |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.extension:additionalInformation.value[x]:valueCodeableConcept | extensible | MedicatieafspraakAanvullendeInformatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.6.3--20171231000000 | |
MedicationRequest.modifierExtension:stopType.value[x]:valueCodeableConcept | required | Stoptypehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300 | |
MedicationRequest.status | required | MedicationRequestStatushttp://hl7.org/fhir/ValueSet/medication-request-status from the FHIR Standard | |
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medication-request-intent from the FHIR Standard | |
MedicationRequest.category | preferred | MedicationRequestCategoryhttp://hl7.org/fhir/ValueSet/medication-request-category from the FHIR Standard | |
MedicationRequest.dosageInstruction.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept | extensible | ZonodigCriteriumCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.4--20171231000000 | |
MedicationRequest.dosageInstruction.route | extensible | MedicatieToedieningswegCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.9 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.1--20171231000000 | |
MedicationRequest.dosageInstruction.dose[x]:doseQuantity | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (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.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationRequest.dosageInstruction.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationRequest | 0..* | Zib MedicationAgreement | MedicationAgreement | |||||
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: Common Languages (extensible): 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 | |||||
periodOfUse | 0..1 | Period | PeriodOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse | |||||
usageDuration | 0..1 | Duration | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration | |||||
additionalInformation | 0..* | (Complex) | MedicationAgreementAdditionalInformation URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: MedicatieafspraakAanvullendeInformatieCodelijst (extensible): MedicatieafspraakAanvullendeInformatieCodelijst Example Example of MedicationAgreementAdditionalInformation: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.2.3.2050","code":"1","display":"Bewust hoge dosering"}]} | |||||
medicationTreatment | 0..1 | Identifier | Medication Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |||||
nl-core-episodeofcare | 0..* | Reference(nl-core-episodeofcare) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/extension-context-nl-core-episodeofcare | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:stopType | ?! | 0..1 | Zib Medication StopType | StopType | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Stoptype (required) | |||||
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule | ||||
identifier | 0..* | Identifier | External ids for this request | |||||
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | Protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest) | What request fulfills | ||||
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of | ||||
status | ?!Σ | 0..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: MedicationRequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | order | instance-order Binding: MedicationRequestIntent (required): The kind of medication order Fixed Value: order | ||||
category | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationRequestCategory (preferred): A coded concept identifying where the medication ordered is expected to be consumed or administered | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | ||||
coding:medicationAgreementCode | Σ | 0..* | Coding | MedicationAgreementCode | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
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 Fixed Value: 16076005 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
priority | Σ | 0..1 | code | routine | urgent | stat | asap Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request | ||||
Slices for medication[x] | Σ | 1..1 | Reference() | Medication to be taken Slice: Unordered, Closed by type:$this | ||||
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | AgreedMedicine | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
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 | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | SΣ | 0..1 | string | Text alternative for the resource | ||||
subject | Σ | 1..1 | Reference(nl-core-patient | Group) | Who or group medication request is for | ||||
context | 0..1 | Reference(HCIM Encounter | nl-core-episodeofcare) | Created during encounter/admission/stay | |||||
supportingInformation | 0..* | Reference(Resource) | Information to support ordering of the medication | |||||
authoredOn | SΣ | 1..1 | dateTime | MedicationAgreementDateTime | ||||
requester | ΣC | 0..1 | BackboneElement | Prescriber mps-1: onBehalfOf can only be specified if agent is practitioner or device | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
agent | Σ | 1..1 | Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | nl-core-relatedperson | Device) | Who ordered the initial medication(s) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
practitionerRole | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
onBehalfOf | ΣC | 0..1 | Reference(nl-core-organization) | Organization agent is acting for | ||||
recorder | 0..1 | Reference(nl-core-practitioner) | Person who entered the request | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
practitionerRole | 0..1 | Reference(nl-core-practitionerrole) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
reasonCode | 0..* | CodeableConcept | ReasonMedicationAgreement Binding: RedenMedicatieafspraakCodelijst (extensible): RedenWijzigenOfStakenCodelijst | |||||
reasonReference | 0..* | Reference(Observation | HCIM Problem) | PrescriptionReason | |||||
note | 0..* | Annotation | Comment | |||||
dosageInstruction | 0..* | Zib InstructionsForUse | InstructionsForUse | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
sequence | Σ | 0..1 | integer | SequenceNumber | ||||
text | SΣ | 0..1 | string | Description | ||||
additionalInstruction | Σ | 0..* | CodeableConcept | AdditionalInstructions Binding: Aanvullende gebruiksinstructie (extensible) | ||||
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions | ||||
timing | 0..1 | Zib AdministrationSchedule | AdministeringSchedule | |||||
Slices for asNeeded[x] | Σ | 0..1 | CodeableConcept | Take "as needed" (for x) Slice: Unordered, Closed by type:$this Binding: SNOMED CT Medication As Needed Reason Codes (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. | ||||
asNeeded[x]:asNeededCodeableConcept | Σ | 0..1 | CodeableConcept | AsNeeded Binding: ZonodigCriteriumCodelijst (extensible): ZonodigCriteriumCodelijst | ||||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
route | Σ | 0..1 | CodeableConcept | RouteOfAdministration Binding: MedicatieToedieningswegCodelijst (extensible): ToedieningswegCodelijst Example Example of RouteOfAdministration: {"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.4.9","code":"oraal","display":"Oraal"}]} | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered. | ||||
Slices for dose[x] | Σ | 0..1 | Dose Slice: Unordered, Closed by type:$this | |||||
doseRange | Range | |||||||
doseQuantity | Quantity(SimpleQuantity) | |||||||
dose[x]:doseQuantity | C | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Binding: G-Standaard Eenhedentabel (required): GstdTabel902 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 | ||||
dose[x]:doseRange | Σ | 0..1 | Range | Amount of medication per dose | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
low | ΣC | 0..1 | SimpleQuantity | Low limit Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | ||||
high | ΣC | 0..1 | SimpleQuantity | High limit Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | ||||
maxDosePerPeriod | Σ | 0..1 | Ratio | MaximumDose | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
numerator | Σ | 0..1 | Quantity | Numerator value Binding: G-Standaard Eenhedentabel (required): GstdTabel902 | ||||
denominator | Σ | 0..1 | Quantity | Denominator value | ||||
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration | ||||
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient | ||||
rate[x] | Σ | 0..1 | AdministeringSpeed | |||||
rateRatio | Ratio | |||||||
rateRange | Range | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
dispenseRequest | 0..1 | BackboneElement | Medication supply authorization | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
validityPeriod | 0..1 | Period | Time period supply is authorized for | |||||
numberOfRepeatsAllowed | 0..1 | positiveInt | Number of refills authorized | |||||
quantity | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
expectedSupplyDuration | 0..1 | Duration | Number of days supply per dispense | |||||
performer | 0..1 | Reference(Organization) | Intended dispenser | |||||
substitution | 0..1 | BackboneElement | Any restrictions on medication substitution | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
allowed | ?! | 1..1 | boolean | Whether substitution is allowed or not | ||||
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(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 | extensible | Common Languageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationRequest.extension:additionalInformation.value[x]:valueCodeableConcept | extensible | MedicatieafspraakAanvullendeInformatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.6.3--20171231000000 | ||||
MedicationRequest.modifierExtension:stopType.value[x]:valueCodeableConcept | required | Stoptypehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300 | ||||
MedicationRequest.status | required | MedicationRequestStatushttp://hl7.org/fhir/ValueSet/medication-request-status from the FHIR Standard | ||||
MedicationRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/medication-request-intent from the FHIR Standard | ||||
MedicationRequest.category | preferred | MedicationRequestCategoryhttp://hl7.org/fhir/ValueSet/medication-request-category from the FHIR Standard | ||||
MedicationRequest.priority | required | MedicationRequestPriorityhttp://hl7.org/fhir/ValueSet/medication-request-priority from the FHIR Standard | ||||
MedicationRequest.reasonCode | extensible | RedenMedicatieafspraakCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.6.2--20171231000000 | ||||
MedicationRequest.dosageInstruction.additionalInstruction | extensible | AanvullendeGebruiksinstructiehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.9--20160407000000 | ||||
MedicationRequest.dosageInstruction.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept | extensible | ZonodigCriteriumCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.4--20171231000000 | ||||
MedicationRequest.dosageInstruction.site | example | SNOMED CT Anatomical Structure for Administration Site Codeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.route | extensible | MedicatieToedieningswegCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.9 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.1--20171231000000 | ||||
MedicationRequest.dosageInstruction.method | example | SNOMED CT Administration Method Codeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationRequest.dosageInstruction.dose[x]:doseQuantity | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.dosageInstruction.dose[x]:doseRange.low | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.dosageInstruction.dose[x]:doseRange.high | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.dosageInstruction.maxDosePerPeriod.numerator | required | GstdTabel902 (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1.900.2 )http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.27--20160830202453 | ||||
MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
mps-1 | error | MedicationRequest.requester | onBehalfOf can only be specified if agent is practitioner or device : (agent.resolve().empty()) or (agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not() | |
qty-3 | error | MedicationRequest.dosageInstruction.dose[x]:doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationRequest.dosageInstruction.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from Zib MedicationAgreement
Other representations of profile: CSV, Excel, Schematron