FHIR Implementatiegids voor de Nederlandse Kankerregistratie - Local Development build (v1.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: NcrEhrMedicationAgreement
| Official URL: http://fhir.iknl.nl/fhir/iknl-ncr-ehr-r4/StructureDefinition/ncr-ehr-medication-agreement | Version: 1.4.0 | |||
| Draft as of 2026-01-22 | Computable Name: NcrEhrMedicationAgreement | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
Usages:
- Refer to this Profile: NcrEhrMedicationAdministration
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  MedicationRequest |
0..* | MpMedicationAgreement | MedicationAgreement | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:medicationAgreementAdditionalInformation |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation |
  url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation" | |
| extension:renderedDosageInstruction |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction" | |
| extension:periodOfUse |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period" | |
| extension:pharmaceuticalTreatmentIdentifier |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier" | |
| extension:relationEpisodeOfCare |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare" | |
| extension:nextPractitioner |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner" | |
 extension:registrationDateTime |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime |
   extension |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime" | |
 Slices for modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| modifierExtension:stopType |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-StopType |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-StopType" | |
| modifierExtension:repeatPeriodCyclicalSchedule |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule" | |
| status |
?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Required Pattern: completed |
| intent |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. Required Pattern: order |
| Slices for category |
1..* | CodeableConcept | Type of medication usage Slice: Unordered, Open by value:$this Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |
| category:medicationAgreementCode |
1..1 | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 33633005 | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Slices for reported[x] |
Σ | 0..1 | Reported rather than primary record Slice: Unordered, Open by type:$this | |
 reportedBoolean |
boolean | |||
 reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||
 reported[x]:reportedBoolean |
Σ | 0..1 | boolean | CopyIndicator |
| Slices for medication[x] |
Σ | 1..1 | Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| medication[x]:medicationReference |
SΣ | 1..1 | Reference(NcrEhrMedication) | AgreedMedicine |
| subject |
SΣ | 1..1 | Reference(NcrEhrPatient) | Who or group medication request is for |
| reasonCode |
0..1 | CodeableConcept | ReasonModificationOrDiscontinuation Binding: RedenWijzigen-StakenCodelijst (required): A coded concept indicating why the medication was ordered. | |
| reasonReference |
S | 1..1 | Reference(NcrEhrCondition) | PrescriptionReason |
 note |
0..1 | Annotation | Information about the prescription | |
| text |
Σ | 1..1 | markdown | Comment |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.category:medicationAgreementCode | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | required | RedenWijzigen-StakenCodelijst | 📦2022-11-14T13:25:25 | FHIR implementation of Medication Process 9 v2.0 |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from MpMedicationAgreement
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MpMedicationAgreement | MedicationAgreement | |
 status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Required Pattern: completed | |
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: order | |
| Slices for medication[x] |
Content/Rules for all slices | |||
| medication[x]:medicationReference |
S | 1..1 | Reference(NcrEhrMedication) | AgreedMedicine |
| subject |
S | 1..1 | Reference(NcrEhrPatient) | Who or group medication request is for |
| reasonReference |
S | 1..1 | Reference(NcrEhrCondition) | PrescriptionReason |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | MpMedicationAgreement | 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:medicationAgreementAdditionalInformation |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation" | |||||
| value[x] |
0..1 | CodeableConcept | MedicationAgreementAdditionalInformation Binding: Aanvullende Informatie voor MA (required) | |||||
| extension:renderedDosageInstruction |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction" | |||||
| value[x] |
0..1 | string | Description | |||||
| extension:periodOfUse |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period" | |||||
 value[x] |
CN | 0..1 | NlcoreTimeInterval | PeriodOfUse Constraints: per-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:duration |
N | 0..1 | Duration | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Duration | ||||
| extension:condition |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-PeriodOfUse.Condition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-PeriodOfUse.Condition" | |||||
| value[x] |
0..1 | string | Condition | |||||
| start |
ΣC | 0..1 | dateTime | startDateTime | ||||
| end |
ΣC | 0..1 | dateTime | endDateTime | ||||
| extension:pharmaceuticalTreatmentIdentifier |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier" | |||||
| value[x] |
0..1 | Identifier | Pharmaceutical Treatment Identifier | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| extension:relationEpisodeOfCare |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare" | |||||
| value[x] |
0..1 | Reference(EpisodeOfCare | nl core EpisodeOfCare) | RelationEpisodeOfCare | |||||
| extension:nextPractitioner |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner" | |||||
| value[x] |
CN | 0..1 | PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole) | NextPractitioner Constraints: ref-1 | ||||
| extension:registrationDateTime |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime" | |||||
| value[x] |
0..1 | dateTime | RegistrationDateTime | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| modifierExtension:stopType |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-StopType | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-StopType" | |||||
| value[x] |
0..1 | CodeableConcept | MedicationAgreementStopType Binding: StopTypeCodelijst (required) | |||||
| modifierExtension:repeatPeriodCyclicalSchedule |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule" | |||||
| value[x] |
0..1 | Duration | RepeatPeriodCyclicalSchedule | |||||
| identifier |
0..* | Identifier | Identification | |||||
| status |
?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Required Pattern: completed | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
| intent |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. Required Pattern: order | ||||
| Slices for category |
1..* | CodeableConcept | Type of medication usage Slice: Unordered, Open by value:$this Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |||||
| category:medicationAgreementCode |
1..1 | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 33633005 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| Slices for reported[x] |
Σ | 0..1 | Reported rather than primary record Slice: Unordered, Open by type:$this | |||||
| reportedBoolean |
boolean | |||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
| reported[x]:reportedBoolean |
Σ | 0..1 | boolean | CopyIndicator | ||||
| Slices for medication[x] |
Σ | 1..1 | Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| medication[x]:medicationReference |
SΣ | 1..1 | Reference(NcrEhrMedication) | AgreedMedicine | ||||
| subject |
SΣ | 1..1 | Reference(NcrEhrPatient) | Who or group medication request is for | ||||
| encounter |
0..1 | Reference(Encounter | nl core Encounter) | RelationEncounter | |||||
| supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||
| authoredOn |
Σ | 0..1 | dateTime | MedicationAgreementDateTime | ||||
| requester |
ΣC | 0..1 | PatternNlCoreHealthProfessionalReference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | nl core HealthProfessional PractitionerRole) | Prescriber Constraints: ref-1 | ||||
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||
| performerType |
Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | ||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||
| reasonCode |
0..1 | CodeableConcept | ReasonModificationOrDiscontinuation Binding: RedenWijzigen-StakenCodelijst (required): A coded concept indicating why the medication was ordered. | |||||
| reasonReference |
S | 1..1 | Reference(NcrEhrCondition) | PrescriptionReason | ||||
| instantiatesCanonical |
Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:relationAdministrationAgreement |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RelationAdministrationAgreement | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RelationAdministrationAgreement" | |||||
| value[x] |
0..1 | Reference(mp AdministrationAgreement) | RelationAdministrationAgreement | |||||
| extension:relationMedicationUse |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.RelationMedicationUse | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.RelationMedicationUse" | |||||
| value[x] |
0..1 | Reference(mp MedicationUse2) | RelationMedicationUse | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
| courseOfTherapyType |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..1 | Annotation | Information about the prescription | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | Comment | ||||
| dosageInstruction |
0..* | MpInstructionsForUseDosageInstructions | DosingInstructions / InstructionsForUse | |||||
| dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| initialFill |
0..1 | BackboneElement | First fill details | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| quantity |
0..1 | SimpleQuantity | First fill quantity | |||||
| duration |
0..1 | Duration | First fill duration | |||||
| dispenseInterval |
0..1 | Duration | Minimum period of time between dispenses | |||||
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of refills authorized | |||||
| quantity |
0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
| 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 | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| allowed[x] |
1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| 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 | mp MedicationAgreement) | RelationMedicationAgreement | |||||
| 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 | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationRequest.extension:medicationAgreementAdditionalInformation.value[x] | Base | required | Aanvullende Informatie voor MA | 📦2022-03-10T16:40:13 | FHIR implementation of Medication Process 9 v2.0 |
| MedicationRequest.extension:pharmaceuticalTreatmentIdentifier.value[x].use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.extension:pharmaceuticalTreatmentIdentifier.value[x].type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| MedicationRequest.modifierExtension:stopType.value[x] | Base | required | StopTypeCodelijst | 📦2022-12-16T10:20:10 | FHIR implementation of Medication Process 9 v2.0 |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.category:medicationAgreementCode | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | required | RedenWijzigen-StakenCodelijst | 📦2022-11-14T13:25:25 | FHIR implementation of Medication Process 9 v2.0 |
| MedicationRequest.basedOn.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.0 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.0 |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| per-1 | error | MedicationRequest.extension:periodOfUse.value[x] | If present, start SHALL have a lower value than end |
start.hasValue().not() or end.hasValue().not() or (start <= end)
|
| ref-1 | error | MedicationRequest.extension:nextPractitioner.value[x], MedicationRequest.requester | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
|
This structure is derived from MpMedicationAgreement
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MpMedicationAgreement | MedicationAgreement | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:medicationAgreementAdditionalInformation |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation" | |
| extension:renderedDosageInstruction |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction" | |
| extension:periodOfUse |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period" | |
| extension:pharmaceuticalTreatmentIdentifier |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier" | |
| extension:relationEpisodeOfCare |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare" | |
| extension:nextPractitioner |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner" | |
| extension:registrationDateTime |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime |
| extension |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime" | |
| Slices for modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| modifierExtension:stopType |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-StopType |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-StopType" | |
| modifierExtension:repeatPeriodCyclicalSchedule |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule |
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule" | |
| status |
?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Required Pattern: completed |
| intent |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. Required Pattern: order |
| Slices for category |
1..* | CodeableConcept | Type of medication usage Slice: Unordered, Open by value:$this Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |
| category:medicationAgreementCode |
1..1 | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 33633005 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Slices for reported[x] |
Σ | 0..1 | Reported rather than primary record Slice: Unordered, Open by type:$this | |
| reportedBoolean |
boolean | |||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||
| reported[x]:reportedBoolean |
Σ | 0..1 | boolean | CopyIndicator |
| Slices for medication[x] |
Σ | 1..1 | Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| medication[x]:medicationReference |
SΣ | 1..1 | Reference(NcrEhrMedication) | AgreedMedicine |
| subject |
SΣ | 1..1 | Reference(NcrEhrPatient) | Who or group medication request is for |
| reasonCode |
0..1 | CodeableConcept | ReasonModificationOrDiscontinuation Binding: RedenWijzigen-StakenCodelijst (required): A coded concept indicating why the medication was ordered. | |
| reasonReference |
S | 1..1 | Reference(NcrEhrCondition) | PrescriptionReason |
| note |
0..1 | Annotation | Information about the prescription | |
| text |
Σ | 1..1 | markdown | Comment |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.category:medicationAgreementCode | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | required | RedenWijzigen-StakenCodelijst | 📦2022-11-14T13:25:25 | FHIR implementation of Medication Process 9 v2.0 |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from MpMedicationAgreement
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationRequest |
0..* | MpMedicationAgreement | MedicationAgreement | |
| status |
1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Required Pattern: completed | |
| intent |
1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: order | |
| Slices for medication[x] |
Content/Rules for all slices | |||
| medication[x]:medicationReference |
S | 1..1 | Reference(NcrEhrMedication) | AgreedMedicine |
| subject |
S | 1..1 | Reference(NcrEhrPatient) | Who or group medication request is for |
| reasonReference |
S | 1..1 | Reference(NcrEhrCondition) | PrescriptionReason |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
0..* | MpMedicationAgreement | 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:medicationAgreementAdditionalInformation |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.MedicationAgreementAdditionalInformation" | |||||
| value[x] |
0..1 | CodeableConcept | MedicationAgreementAdditionalInformation Binding: Aanvullende Informatie voor MA (required) | |||||
| extension:renderedDosageInstruction |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RenderedDosageInstruction" | |||||
| value[x] |
0..1 | string | Description | |||||
| extension:periodOfUse |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Period" | |||||
| value[x] |
CN | 0..1 | NlcoreTimeInterval | PeriodOfUse Constraints: per-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:duration |
N | 0..1 | Duration | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-TimeInterval.Duration | ||||
| extension:condition |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-PeriodOfUse.Condition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-PeriodOfUse.Condition" | |||||
| value[x] |
0..1 | string | Condition | |||||
| start |
ΣC | 0..1 | dateTime | startDateTime | ||||
| end |
ΣC | 0..1 | dateTime | endDateTime | ||||
| extension:pharmaceuticalTreatmentIdentifier |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-PharmaceuticalTreatment.Identifier" | |||||
| value[x] |
0..1 | Identifier | Pharmaceutical Treatment Identifier | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| extension:relationEpisodeOfCare |
N | 0..* | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Context-EpisodeOfCare" | |||||
| value[x] |
0..1 | Reference(EpisodeOfCare | nl core EpisodeOfCare) | RelationEpisodeOfCare | |||||
| extension:nextPractitioner |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.NextPractitioner" | |||||
| value[x] |
CN | 0..1 | PatternNlCoreHealthProfessionalReference(nl core HealthProfessional PractitionerRole) | NextPractitioner Constraints: ref-1 | ||||
| extension:registrationDateTime |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RegistrationDateTime" | |||||
| value[x] |
0..1 | dateTime | RegistrationDateTime | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| modifierExtension:stopType |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-StopType | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-StopType" | |||||
| value[x] |
0..1 | CodeableConcept | MedicationAgreementStopType Binding: StopTypeCodelijst (required) | |||||
| modifierExtension:repeatPeriodCyclicalSchedule |
?!N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule" | |||||
| value[x] |
0..1 | Duration | RepeatPeriodCyclicalSchedule | |||||
| identifier |
0..* | Identifier | Identification | |||||
| status |
?!Σ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Required Pattern: completed | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
| intent |
?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: medicationRequest Intent (required): The kind of medication order. Required Pattern: order | ||||
| Slices for category |
1..* | CodeableConcept | Type of medication usage Slice: Unordered, Open by value:$this Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. | |||||
| category:medicationAgreementCode |
1..1 | CodeableConcept | Type of medication usage Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 33633005 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| Slices for reported[x] |
Σ | 0..1 | Reported rather than primary record Slice: Unordered, Open by type:$this | |||||
| reportedBoolean |
boolean | |||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
| reported[x]:reportedBoolean |
Σ | 0..1 | boolean | CopyIndicator | ||||
| Slices for medication[x] |
Σ | 1..1 | Reference(Medication) | Medication to be taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| medication[x]:medicationReference |
SΣ | 1..1 | Reference(NcrEhrMedication) | AgreedMedicine | ||||
| subject |
SΣ | 1..1 | Reference(NcrEhrPatient) | Who or group medication request is for | ||||
| encounter |
0..1 | Reference(Encounter | nl core Encounter) | RelationEncounter | |||||
| supportingInformation |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||
| authoredOn |
Σ | 0..1 | dateTime | MedicationAgreementDateTime | ||||
| requester |
ΣC | 0..1 | PatternNlCoreHealthProfessionalReference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | nl core HealthProfessional PractitionerRole) | Prescriber Constraints: ref-1 | ||||
| performer |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||
| performerType |
Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication. | ||||
| recorder |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||
| reasonCode |
0..1 | CodeableConcept | ReasonModificationOrDiscontinuation Binding: RedenWijzigen-StakenCodelijst (required): A coded concept indicating why the medication was ordered. | |||||
| reasonReference |
S | 1..1 | Reference(NcrEhrCondition) | PrescriptionReason | ||||
| instantiatesCanonical |
Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:relationAdministrationAgreement |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-RelationAdministrationAgreement | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-RelationAdministrationAgreement" | |||||
| value[x] |
0..1 | Reference(mp AdministrationAgreement) | RelationAdministrationAgreement | |||||
| extension:relationMedicationUse |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.RelationMedicationUse | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-MedicationAgreement.RelationMedicationUse" | |||||
| value[x] |
0..1 | Reference(mp MedicationUse2) | RelationMedicationUse | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
| courseOfTherapyType |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..1 | Annotation | Information about the prescription | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | Comment | ||||
| dosageInstruction |
0..* | MpInstructionsForUseDosageInstructions | DosingInstructions / InstructionsForUse | |||||
| dispenseRequest |
0..1 | BackboneElement | Medication supply authorization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| initialFill |
0..1 | BackboneElement | First fill details | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| quantity |
0..1 | SimpleQuantity | First fill quantity | |||||
| duration |
0..1 | Duration | First fill duration | |||||
| dispenseInterval |
0..1 | Duration | Minimum period of time between dispenses | |||||
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of refills authorized | |||||
| quantity |
0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
| 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 | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| allowed[x] |
1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| 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 | mp MedicationAgreement) | RelationMedicationAgreement | |||||
| 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 | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationRequest.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| MedicationRequest.extension:medicationAgreementAdditionalInformation.value[x] | Base | required | Aanvullende Informatie voor MA | 📦2022-03-10T16:40:13 | FHIR implementation of Medication Process 9 v2.0 |
| MedicationRequest.extension:pharmaceuticalTreatmentIdentifier.value[x].use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| MedicationRequest.extension:pharmaceuticalTreatmentIdentifier.value[x].type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| MedicationRequest.modifierExtension:stopType.value[x] | Base | required | StopTypeCodelijst | 📦2022-12-16T10:20:10 | FHIR implementation of Medication Process 9 v2.0 |
| MedicationRequest.status | Base | required | Medicationrequest status | 📍4.0.1 | FHIR Std. |
| MedicationRequest.statusReason | Base | example | Medication request status reason codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.intent | Base | required | Medication request intent | 📍4.0.1 | FHIR Std. |
| MedicationRequest.category | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.category:medicationAgreementCode | Base | example | Medication request category codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| MedicationRequest.medication[x] | Base | example | SNOMED CT Medication Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.reasonCode | Base | required | RedenWijzigen-StakenCodelijst | 📦2022-11-14T13:25:25 | FHIR implementation of Medication Process 9 v2.0 |
| MedicationRequest.basedOn.type | Base | extensible | ResourceType | 📦4.0.1 | FHIR Std. |
| MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📦4.0.1 | FHIR Std. |
| MedicationRequest.substitution.allowed[x] | Base | example | ActSubstanceAdminSubstitutionCode | 📦3.0.0 | THO v7.0 |
| MedicationRequest.substitution.reason | Base | example | SubstanceAdminSubstitutionReason | 📦3.0.0 | THO v7.0 |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MedicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MedicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| per-1 | error | MedicationRequest.extension:periodOfUse.value[x] | If present, start SHALL have a lower value than end |
start.hasValue().not() or end.hasValue().not() or (start <= end)
|
| ref-1 | error | MedicationRequest.extension:nextPractitioner.value[x], MedicationRequest.requester | SHALL have a contained resource if a local reference is provided |
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
|
This structure is derived from MpMedicationAgreement
Other representations of profile: CSV, Excel, Schematron