RIVO-Noord Zorgviewer Implementation Guide
1.11.0 - sprint49 Netherlands flag

This page is part of the RIVO-Noord Zorgviewer Implementation Guide (v1.11.0: Release) based on FHIR (HL7® FHIR® Standard) R3. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: MedicationAgreement

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/MedicationRequest Version: 1.11.0
Active as of 2025-01-20 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.

Zorginformatiebouwsteen

ZIB Medicatieafspraak

View Definition

Request

  1. Opvragen (search) definities

    GET <ontsluiten-bronsysteem-base>/MedicationRequest?category=http://snomed.info/sct|16076005&_include=MedicationRequest:medication&patient=<fhir_patient_id>

Bronsysteem herkennen

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:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Changes since version 1.10.0:

  • The data elements list has changed
  • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. 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
    ... 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 How the medication should be taken
    .... 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 Σ 0..1 SimpleQuantity Amount of medication per dose
    Binding: G-Standaard Eenhedentabel (required): GstdTabel902

    ..... dose[x]:doseRange Σ 0..1 Range Amount of medication per dose

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    MedicationRequest.extension:additionalInformation.value[x]:valueCodeableConceptextensibleMedicatieafspraakAanvullendeInformatieCodelijst
    http://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]:valueCodeableConceptrequiredStoptype
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300
    MedicationRequest.statusrequiredMedicationRequestStatus
    http://hl7.org/fhir/ValueSet/medication-request-status
    from the FHIR Standard
    MedicationRequest.intentrequiredFixed Value: order
    http://hl7.org/fhir/ValueSet/medication-request-intent
    from the FHIR Standard
    MedicationRequest.categorypreferredMedicationRequestCategory
    http://hl7.org/fhir/ValueSet/medication-request-category
    from the FHIR Standard
    MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMED CT Medication As Needed Reason Codes
    http://hl7.org/fhir/ValueSet/medication-as-needed-reason
    from the FHIR Standard
    MedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConceptextensibleZonodigCriteriumCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.12.4--20171231000000
    MedicationRequest.dosageInstruction.routeextensibleMedicatieToedieningswegCodelijst (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]:doseQuantityrequiredGstdTabel902 (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

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-1errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain any narrative
    : contained.text.empty()
    dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() | (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

     

    Other representations of profile: CSV, Excel, Schematron