MedicationAgreement - RIVO-Noord Zorgviewer Implementation Guide v1.7.0

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

Resource Profile: MedicationAgreement

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/MedicationRequest				Version: 1.7.0
Active as of 2024-11-12				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

ViewDefinition voor MedicationRequest

Request

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

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Zib MedicationAgreement

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest		0..*	Zib MedicationAgreement	MedicationAgreement
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
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
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
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
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
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
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
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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
MedicationRequest.extension:additionalInformation.value[x]:valueCodeableConcept	extensible	MedicatieafspraakAanvullendeInformatieCodelijst `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]:valueCodeableConcept	required	Stoptype `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.20.77.11.19--20160617101300`
MedicationRequest.status	required	MedicationRequestStatus `http://hl7.org/fhir/ValueSet/medication-request-status` from the FHIR Standard
MedicationRequest.intent	required	Fixed Value: order `http://hl7.org/fhir/ValueSet/medication-request-intent` from the FHIR Standard
MedicationRequest.category	preferred	MedicationRequestCategory `http://hl7.org/fhir/ValueSet/medication-request-category` from the FHIR Standard
MedicationRequest.dosageInstruction.asNeeded[x]	example	SNOMED CT Medication As Needed Reason Codes `http://hl7.org/fhir/ValueSet/medication-as-needed-reason` from the FHIR Standard
MedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept	extensible	ZonodigCriteriumCodelijst `http://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`

Constraints

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()