FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: cpg-medicationrequest

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-medicationrequest

Profile of MedicationRequest for use with CPG Implementation Guide

This profile builds on MedicationRequest.

This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 1 element
Must-Support: 15 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*Ordering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-strengthOfRecommendation SI0..*CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cqf-qualityOfEvidence SI0..*CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!SΣ1..1codeproposal | plan | order | original-order | instance-order | option
Binding: medicationRequest Intent (required)
... category S0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(http://hl7.org/fhir/R4/patient.html | http://hl7.org/fhir/R4/practitioner.html | http://hl7.org/fhir/R4/practitionerrole.html | http://hl7.org/fhir/R4/relatedperson.html | http://hl7.org/fhir/R4/organization.html)
... medication[x] SΣ1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(http://hl7.org/fhir/R4/medication.html)
... subject SΣ1..1Reference(Patient | Group)Who or group medication request is for
... encounter S0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example)
... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode S0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference S0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical SΣ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example)
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest I0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill I0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution I0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: V3 Value SetSubstanceAdminSubstitutionReason (example)
... priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Summary

Mandatory: 1 element
Must-Support: 15 elements

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*Ordering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-strengthOfRecommendation SI0..*CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cqf-qualityOfEvidence SI0..*CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason 0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!SΣ1..1codeproposal | plan | order | original-order | instance-order | option
Binding: medicationRequest Intent (required)
... category S0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(http://hl7.org/fhir/R4/patient.html | http://hl7.org/fhir/R4/practitioner.html | http://hl7.org/fhir/R4/practitionerrole.html | http://hl7.org/fhir/R4/relatedperson.html | http://hl7.org/fhir/R4/organization.html)
... medication[x] SΣ1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(http://hl7.org/fhir/R4/medication.html)
... subject SΣ1..1Reference(Patient | Group)Who or group medication request is for
... encounter S0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Information to support ordering of the medication
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example)
... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode S0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference S0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical SΣ0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example)
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest I0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill I0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution I0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy should (not) substitution be made
Binding: V3 Value SetSubstanceAdminSubstitutionReason (example)
... priorPrescription 0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]examplev3.ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexamplev3.SubstanceAdminSubstitutionReason

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4MedicationRequestIf 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-3MedicationRequestIf 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-6MedicationRequestA resource should have narrative for robust management
: text.div.exists()
dom-5MedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1MedicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1MedicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1MedicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1MedicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1MedicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1MedicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1MedicationRequest.dispenseRequestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1MedicationRequest.dispenseRequest.initialFillAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1MedicationRequest.substitutionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())