RIVO-Noord Zorgviewer Implementation Guide
1.7.0 - CI build
RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.7.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/MedicationStatement | Version: 1.7.0 | |||
Active as of 2024-10-30 | Computable Name: MedicationUse |
Medicatie Gebruik
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>/MedicationStatement?category=urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.3|6&_include=MedicationStatement: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 MedicationUse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | Zib MedicationUse | MedicationUse | |
category | ||||
text | S | 0..1 | string | Plain text representation of the concept |
medicationReference | ||||
display | S | 0..1 | string | Text alternative for the resource |
dateAsserted | S | 1..1 | dateTime | MedicationUseDateTime |
dosage | ||||
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 |
---|---|---|---|---|
MedicationStatement | C | 0..* | Zib MedicationUse | MedicationUse mst-1: Reason not taken is only permitted if Taken is No |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
asAgreedIndicator | 0..1 | (Complex) | AsAgreedIndicator URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-AsAgreedIndicator | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-AsAgreedIndicator" | |
Slices for value[x] | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueBoolean | 0..1 | boolean | Value of extension Example Example of asAgreed: true | |
prescriber | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner) | Prescriber URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Prescriber | |
author | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner | nl-core-organization | nl-core-patient) | Author URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Author | |
medicationTreatment | 0..1 | Identifier | Medical Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |
reasonForChangeOrDiscontinuationOfUse | 0..* | (Complex) | ReasonForChangeOrDiscontinuationOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-ReasonForChangeOrDiscontinuationOfUse | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-ReasonForChangeOrDiscontinuationOfUse" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | ReasonForChangeOrDiscontinuationOfUse Binding: RedenWijzigenOfStoppenGebruikCodelijst (extensible) Example Example of ReasonForChangeOrDiscontinuationOfUse: {"coding":[{"system":"http://snomed.info/sct","code":"79899007","display":"Drug interaction (finding)"}]} | |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule |
status | ?!Σ | 1..1 | code | MedicationUseStopType Binding: MedicationStatementStatus (required): Allergy Intolerance critically Code list |
category | Σ | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationStatementCategory (preferred): A coded concept identifying where the medication included in the medicationstatement 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:medicationUseCode | Σ | 0..* | Coding | MedicationUseCode |
text | SΣ | 0..1 | string | Plain text representation of the concept |
Slices for medication[x] | Σ | 1..1 | Reference() | What medication was taken Slice: Unordered, Closed by type:$this |
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | ProductUsed |
display | SΣ | 0..1 | string | Text alternative for the resource |
Slices for effective[x] | Σ | 0..1 | Period | The date/time or interval when the medication was taken Slice: Unordered, Closed by type:$this |
effective[x]:effectivePeriod | Σ | 0..1 | Period | PeriodOfUse |
Slices for extension | Content/Rules for all slices | |||
Duration | 0..1 | (Complex) | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration" | |
Slices for value[x] | 0..1 | Duration | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueDuration | 0..1 | Duration | UsageDuration Example Example of Duration: {"value":3,"unit":"day","system":"http://unitsofmeasure.org","code":"d"} | |
dateAsserted | SΣ | 1..1 | dateTime | MedicationUseDateTime Example Example of MedicationUseDateTime: 2017-06-14 |
subject | Σ | 1..1 | Reference(nl-core-patient) | Who is/was taking the medication |
taken | ?!Σ | 1..1 | code | UseIndicator Binding: MedicationStatementTaken (required): A coded concept identifying level of certainty if patient has taken or has not taken the medication Example Example of taken: y |
dosage | 0..* | Zib InstructionsForUse | InstructionsForUse | |
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 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 | URI |
MedicationStatement.extension:reasonForChangeOrDiscontinuationOfUse.value[x]:valueCodeableConcept | extensible | RedenWijzigenOfStoppenGebruikCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.11.2--20171231000000 | |
MedicationStatement.status | required | MedicationStatementStatushttp://hl7.org/fhir/ValueSet/medication-statement-status from the FHIR Standard | |
MedicationStatement.category | preferred | MedicationStatementCategoryhttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | |
MedicationStatement.taken | required | MedicationStatementTakenhttp://hl7.org/fhir/ValueSet/medication-statement-taken from the FHIR Standard | |
MedicationStatement.dosage.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationStatement.dosage.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 | |
MedicationStatement.dosage.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 | |
MedicationStatement.dosage.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 | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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() | |
mst-1 | error | MedicationStatement | Reason not taken is only permitted if Taken is No : reasonNotTaken.exists().not() or (taken = 'n') | |
qty-3 | error | MedicationStatement.dosage.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 | MedicationStatement.dosage.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | C | 0..* | Zib MedicationUse | MedicationUse mst-1: Reason not taken is only permitted if Taken is No | ||||
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 | |||||
asAgreedIndicator | 0..1 | (Complex) | AsAgreedIndicator URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-AsAgreedIndicator | |||||
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-MedicationUse-AsAgreedIndicator" | |||||
Slices for value[x] | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueBoolean | 0..1 | boolean | Value of extension Example Example of asAgreed: true | |||||
prescriber | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner) | Prescriber URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Prescriber | |||||
author | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner | nl-core-organization | nl-core-patient) | Author URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Author | |||||
medicationTreatment | 0..1 | Identifier | Medical Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |||||
reasonForChangeOrDiscontinuationOfUse | 0..* | (Complex) | ReasonForChangeOrDiscontinuationOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-ReasonForChangeOrDiscontinuationOfUse | |||||
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-MedicationUse-ReasonForChangeOrDiscontinuationOfUse" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | ReasonForChangeOrDiscontinuationOfUse Binding: RedenWijzigenOfStoppenGebruikCodelijst (extensible) Example Example of ReasonForChangeOrDiscontinuationOfUse: {"coding":[{"system":"http://snomed.info/sct","code":"79899007","display":"Drug interaction (finding)"}]} | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule | ||||
identifier | Σ | 0..* | Identifier | External identifier | ||||
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest) | Fulfils plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
status | ?!Σ | 1..1 | code | MedicationUseStopType Binding: MedicationStatementStatus (required): Allergy Intolerance critically Code list | ||||
category | Σ | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationStatementCategory (preferred): A coded concept identifying where the medication included in the medicationstatement 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:medicationUseCode | Σ | 0..* | Coding | MedicationUseCode | ||||
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: urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.3 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 6 | ||||
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 | ||||
Slices for medication[x] | Σ | 1..1 | Reference() | What medication was taken Slice: Unordered, Closed by type:$this | ||||
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | ProductUsed | ||||
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 | ||||
Slices for effective[x] | Σ | 0..1 | Period | The date/time or interval when the medication was taken Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectivePeriod | Σ | 0..1 | Period | PeriodOfUse | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Duration | 0..1 | (Complex) | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration | |||||
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-MedicationUse-Duration" | |||||
Slices for value[x] | 0..1 | Duration | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueDuration | 0..1 | Duration | UsageDuration Example Example of Duration: {"value":3,"unit":"day","system":"http://unitsofmeasure.org","code":"d"} | |||||
start | ΣC | 0..1 | dateTime | StartDate | ||||
end | ΣC | 0..1 | dateTime | EndDate | ||||
dateAsserted | SΣ | 1..1 | dateTime | MedicationUseDateTime Example Example of MedicationUseDateTime: 2017-06-14 | ||||
informationSource | 0..1 | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization) | Person or organization that provided the information about the taking of this medication | |||||
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 | ||||
subject | Σ | 1..1 | Reference(nl-core-patient) | Who is/was taking the medication | ||||
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
taken | ?!Σ | 1..1 | code | UseIndicator Binding: MedicationStatementTaken (required): A coded concept identifying level of certainty if patient has taken or has not taken the medication Example Example of taken: y | ||||
reasonNotTaken | C | 0..* | CodeableConcept | True if asserting medication was not given Binding: SNOMED CT Drugs not taken/completed Codes (example): A coded concept indicating the reason why the medication was not taken | ||||
reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/Diagnosis Codes (example): A coded concept identifying why the medication is being taken. | |||||
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 | Σ | 0..1 | string | ReasonForUse | ||||
reasonReference | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the medication is being/was taken | |||||
note | 0..* | Annotation | Comment | |||||
dosage | 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) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.language | extensible | Common Languages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationStatement.extension:reasonForChangeOrDiscontinuationOfUse.value[x]:valueCodeableConcept | extensible | RedenWijzigenOfStoppenGebruikCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.11.2--20171231000000 | ||||
MedicationStatement.status | required | MedicationStatementStatushttp://hl7.org/fhir/ValueSet/medication-statement-status from the FHIR Standard | ||||
MedicationStatement.category | preferred | MedicationStatementCategoryhttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.taken | required | MedicationStatementTakenhttp://hl7.org/fhir/ValueSet/medication-statement-taken from the FHIR Standard | ||||
MedicationStatement.reasonNotTaken | example | SNOMED CT Drugs not taken/completed Codeshttp://hl7.org/fhir/ValueSet/reason-medication-not-taken-codes from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/Diagnosis Codeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | extensible | AanvullendeGebruiksinstructiehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.9--20160407000000 | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.site | example | SNOMED CT Anatomical Structure for Administration Site Codeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.method | example | SNOMED CT Administration Method Codeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.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 |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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() | |
mst-1 | error | MedicationStatement | Reason not taken is only permitted if Taken is No : reasonNotTaken.exists().not() or (taken = 'n') | |
qty-3 | error | MedicationStatement.dosage.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 | MedicationStatement.dosage.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from Zib MedicationUse
Differential View
This structure is derived from Zib MedicationUse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | Zib MedicationUse | MedicationUse | |
category | ||||
text | S | 0..1 | string | Plain text representation of the concept |
medicationReference | ||||
display | S | 0..1 | string | Text alternative for the resource |
dateAsserted | S | 1..1 | dateTime | MedicationUseDateTime |
dosage | ||||
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 |
---|---|---|---|---|
MedicationStatement | C | 0..* | Zib MedicationUse | MedicationUse mst-1: Reason not taken is only permitted if Taken is No |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
asAgreedIndicator | 0..1 | (Complex) | AsAgreedIndicator URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-AsAgreedIndicator | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-AsAgreedIndicator" | |
Slices for value[x] | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueBoolean | 0..1 | boolean | Value of extension Example Example of asAgreed: true | |
prescriber | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner) | Prescriber URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Prescriber | |
author | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner | nl-core-organization | nl-core-patient) | Author URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Author | |
medicationTreatment | 0..1 | Identifier | Medical Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |
reasonForChangeOrDiscontinuationOfUse | 0..* | (Complex) | ReasonForChangeOrDiscontinuationOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-ReasonForChangeOrDiscontinuationOfUse | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-ReasonForChangeOrDiscontinuationOfUse" | |
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | ReasonForChangeOrDiscontinuationOfUse Binding: RedenWijzigenOfStoppenGebruikCodelijst (extensible) Example Example of ReasonForChangeOrDiscontinuationOfUse: {"coding":[{"system":"http://snomed.info/sct","code":"79899007","display":"Drug interaction (finding)"}]} | |
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule |
status | ?!Σ | 1..1 | code | MedicationUseStopType Binding: MedicationStatementStatus (required): Allergy Intolerance critically Code list |
category | Σ | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationStatementCategory (preferred): A coded concept identifying where the medication included in the medicationstatement 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:medicationUseCode | Σ | 0..* | Coding | MedicationUseCode |
text | SΣ | 0..1 | string | Plain text representation of the concept |
Slices for medication[x] | Σ | 1..1 | Reference() | What medication was taken Slice: Unordered, Closed by type:$this |
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | ProductUsed |
display | SΣ | 0..1 | string | Text alternative for the resource |
Slices for effective[x] | Σ | 0..1 | Period | The date/time or interval when the medication was taken Slice: Unordered, Closed by type:$this |
effective[x]:effectivePeriod | Σ | 0..1 | Period | PeriodOfUse |
Slices for extension | Content/Rules for all slices | |||
Duration | 0..1 | (Complex) | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration | |
url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration" | |
Slices for value[x] | 0..1 | Duration | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueDuration | 0..1 | Duration | UsageDuration Example Example of Duration: {"value":3,"unit":"day","system":"http://unitsofmeasure.org","code":"d"} | |
dateAsserted | SΣ | 1..1 | dateTime | MedicationUseDateTime Example Example of MedicationUseDateTime: 2017-06-14 |
subject | Σ | 1..1 | Reference(nl-core-patient) | Who is/was taking the medication |
taken | ?!Σ | 1..1 | code | UseIndicator Binding: MedicationStatementTaken (required): A coded concept identifying level of certainty if patient has taken or has not taken the medication Example Example of taken: y |
dosage | 0..* | Zib InstructionsForUse | InstructionsForUse | |
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 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 | URI |
MedicationStatement.extension:reasonForChangeOrDiscontinuationOfUse.value[x]:valueCodeableConcept | extensible | RedenWijzigenOfStoppenGebruikCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.11.2--20171231000000 | |
MedicationStatement.status | required | MedicationStatementStatushttp://hl7.org/fhir/ValueSet/medication-statement-status from the FHIR Standard | |
MedicationStatement.category | preferred | MedicationStatementCategoryhttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | |
MedicationStatement.taken | required | MedicationStatementTakenhttp://hl7.org/fhir/ValueSet/medication-statement-taken from the FHIR Standard | |
MedicationStatement.dosage.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
MedicationStatement.dosage.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 | |
MedicationStatement.dosage.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 | |
MedicationStatement.dosage.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 | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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() | |
mst-1 | error | MedicationStatement | Reason not taken is only permitted if Taken is No : reasonNotTaken.exists().not() or (taken = 'n') | |
qty-3 | error | MedicationStatement.dosage.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 | MedicationStatement.dosage.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | C | 0..* | Zib MedicationUse | MedicationUse mst-1: Reason not taken is only permitted if Taken is No | ||||
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 | |||||
asAgreedIndicator | 0..1 | (Complex) | AsAgreedIndicator URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-AsAgreedIndicator | |||||
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-MedicationUse-AsAgreedIndicator" | |||||
Slices for value[x] | 0..1 | boolean | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueBoolean | 0..1 | boolean | Value of extension Example Example of asAgreed: true | |||||
prescriber | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner) | Prescriber URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Prescriber | |||||
author | 0..1 | Reference(nl-core-practitionerrole | nl-core-practitioner | nl-core-organization | nl-core-patient) | Author URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Author | |||||
medicationTreatment | 0..1 | Identifier | Medical Treatment URL: http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment | |||||
reasonForChangeOrDiscontinuationOfUse | 0..* | (Complex) | ReasonForChangeOrDiscontinuationOfUse URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-ReasonForChangeOrDiscontinuationOfUse | |||||
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-MedicationUse-ReasonForChangeOrDiscontinuationOfUse" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | ReasonForChangeOrDiscontinuationOfUse Binding: RedenWijzigenOfStoppenGebruikCodelijst (extensible) Example Example of ReasonForChangeOrDiscontinuationOfUse: {"coding":[{"system":"http://snomed.info/sct","code":"79899007","display":"Drug interaction (finding)"}]} | |||||
Slices for modifierExtension | ?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
modifierExtension:repeatPeriodCyclicalSchedule | ?! | 0..1 | Zib Medication RepeatPeriodCyclicalSchedule | RepeatPeriodCyclicalSchedule | ||||
identifier | Σ | 0..* | Identifier | External identifier | ||||
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest) | Fulfils plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement | ||||
status | ?!Σ | 1..1 | code | MedicationUseStopType Binding: MedicationStatementStatus (required): Allergy Intolerance critically Code list | ||||
category | Σ | 1..1 | CodeableConcept | Type of medication usage Binding: MedicationStatementCategory (preferred): A coded concept identifying where the medication included in the medicationstatement 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:medicationUseCode | Σ | 0..* | Coding | MedicationUseCode | ||||
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: urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.3 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 6 | ||||
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 | ||||
Slices for medication[x] | Σ | 1..1 | Reference() | What medication was taken Slice: Unordered, Closed by type:$this | ||||
medication[x]:medicationReference | Σ | 1..1 | Reference(HCIM PharmaceuticalProduct) | ProductUsed | ||||
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 | ||||
Slices for effective[x] | Σ | 0..1 | Period | The date/time or interval when the medication was taken Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectivePeriod | Σ | 0..1 | Period | PeriodOfUse | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Duration | 0..1 | (Complex) | Duration URL: http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration | |||||
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-MedicationUse-Duration" | |||||
Slices for value[x] | 0..1 | Duration | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueDuration | 0..1 | Duration | UsageDuration Example Example of Duration: {"value":3,"unit":"day","system":"http://unitsofmeasure.org","code":"d"} | |||||
start | ΣC | 0..1 | dateTime | StartDate | ||||
end | ΣC | 0..1 | dateTime | EndDate | ||||
dateAsserted | SΣ | 1..1 | dateTime | MedicationUseDateTime Example Example of MedicationUseDateTime: 2017-06-14 | ||||
informationSource | 0..1 | Reference(nl-core-patient | nl-core-practitioner | nl-core-relatedperson | nl-core-organization) | Person or organization that provided the information about the taking of this medication | |||||
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 | ||||
subject | Σ | 1..1 | Reference(nl-core-patient) | Who is/was taking the medication | ||||
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |||||
taken | ?!Σ | 1..1 | code | UseIndicator Binding: MedicationStatementTaken (required): A coded concept identifying level of certainty if patient has taken or has not taken the medication Example Example of taken: y | ||||
reasonNotTaken | C | 0..* | CodeableConcept | True if asserting medication was not given Binding: SNOMED CT Drugs not taken/completed Codes (example): A coded concept indicating the reason why the medication was not taken | ||||
reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/Diagnosis Codes (example): A coded concept identifying why the medication is being taken. | |||||
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 | Σ | 0..1 | string | ReasonForUse | ||||
reasonReference | 0..* | Reference(Condition | Observation) | Condition or observation that supports why the medication is being/was taken | |||||
note | 0..* | Annotation | Comment | |||||
dosage | 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) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationStatement.language | extensible | Common Languages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationStatement.extension:reasonForChangeOrDiscontinuationOfUse.value[x]:valueCodeableConcept | extensible | RedenWijzigenOfStoppenGebruikCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.11.2--20171231000000 | ||||
MedicationStatement.status | required | MedicationStatementStatushttp://hl7.org/fhir/ValueSet/medication-statement-status from the FHIR Standard | ||||
MedicationStatement.category | preferred | MedicationStatementCategoryhttp://hl7.org/fhir/ValueSet/medication-statement-category from the FHIR Standard | ||||
MedicationStatement.taken | required | MedicationStatementTakenhttp://hl7.org/fhir/ValueSet/medication-statement-taken from the FHIR Standard | ||||
MedicationStatement.reasonNotTaken | example | SNOMED CT Drugs not taken/completed Codeshttp://hl7.org/fhir/ValueSet/reason-medication-not-taken-codes from the FHIR Standard | ||||
MedicationStatement.reasonCode | example | Condition/Problem/Diagnosis Codeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
MedicationStatement.dosage.additionalInstruction | extensible | AanvullendeGebruiksinstructiehttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.9--20160407000000 | ||||
MedicationStatement.dosage.asNeeded[x] | example | SNOMED CT Medication As Needed Reason Codeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.site | example | SNOMED CT Anatomical Structure for Administration Site Codeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.method | example | SNOMED CT Administration Method Codeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.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 | ||||
MedicationStatement.dosage.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 |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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() | |
mst-1 | error | MedicationStatement | Reason not taken is only permitted if Taken is No : reasonNotTaken.exists().not() or (taken = 'n') | |
qty-3 | error | MedicationStatement.dosage.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 | MedicationStatement.dosage.dose[x]:doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from Zib MedicationUse
Other representations of profile: CSV, Excel, Schematron