HL7 FHIR® US Core Implementation Guide (Release 3.0.1 STU3 Update for Comment)

This page is part of the US Core (v3.0.1: STU3 Ballot 3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

StructureDefinition-us-core-medicationrequest

The MedicationRequest resource can be used to record a patient’s medication prescription or order. This profile sets minimum expectations for the MedicationRequest resource to record, search and fetch medications associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core-MedicationRequest profile. See the Medication List Guidance section for guidance on accessing a patient medications:

  • Fetching all medications that have been prescribed to a particular patient
  • Fetching all active medications that have been prescribed to particular patient
  • Fetching all medications that have been prescribed to particular patient during a particular encounter
  • Record medications that have been prescribed for a particular patient

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each MedicationRequest must have:

  1. a status
  2. an intent code to indicate whether an order or proposal
  3. a medication
  4. a patient
  5. a date for when written
  6. a prescriber

Each MedicationRequest must support:

  1. the reported flag signaling that information is from a secondary source such as a patient.
  2. the encounter
  3. the prescription Sig Profile specific implementation guidance:
  • See the Medication List Guidance section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.
  • The MedicationRequest resources can represent a medication using either a code, or reference a Medication resource.
    • When referencing a Medication resource, the resource may be contained or an external resource.
    • The server application MAY choose any combination of these methods, but if an external reference to Medication is used, the server SHALL support the include parameter for searching this element.
    • The client application SHALL support all methods.
  • Source EHR identifiers SHOULD be included to support deduplication across MedicationRequest resources. Exposing the EHR identifiers helps client applications identify duplicates.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest

Published on Mon Aug 19 00:00:00 EDT 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on MedicationRequest

MedicationRequest

Summary of the Mandatory Requirements

  1. A code in MedicationRequest.status with a required binding to Medicationrequest status
  2. A code in MedicationRequest.intent with a required binding to Medication request intent
  3. A CodeableConcept or Medication Reference in MedicationRequest.medication[x] with an extensible binding to US Core Medication Codes (RxNorm)
  4. A Patient Reference in MedicationRequest.subject
  5. A dateTime in MedicationRequest.authoredOn
  6. A Requester Reference in MedicationRequest.requester

Summary of the Must Support Requirements

  1. A boolean or Reference in MedicationRequest.reported[x]
  2. A Encounter Reference in MedicationRequest.encounter
  3. One or more Dosages in MedicationRequest.dosageInstruction
    • which should have a string value in MedicationRequest.dosageInstruction.text
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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*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 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] SΣ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | RelatedPerson)
... medication[x] SΣ1..1Medication to be taken
Binding: US Core Medication Codes (RxNorm) (extensible)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(US Core Medication Profile)
... subject SΣ1..1Reference(US Core Patient Profile)Who or group medication request is for
... encounter S0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn SΣ1..1dateTimeWhen request was initially authored
... requester SΣ1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile | US Core Implantable Device Profile | RelatedPerson)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 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ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 S0..*DosageHow the medication should be taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence Σ0..1integerThe order of the dosage instructions
.... text SΣ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate ΣI0..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... dose[x] Σ0..1Amount of medication per dose
...... doseRangeRange
...... doseQuantityQuantity
..... rate[x] Σ0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... 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

MedicationRequest

Summary of the Mandatory Requirements

  1. A code in MedicationRequest.status with a required binding to Medicationrequest status
  2. A code in MedicationRequest.intent with a required binding to Medication request intent
  3. A CodeableConcept or Medication Reference in MedicationRequest.medication[x] with an extensible binding to US Core Medication Codes (RxNorm)
  4. A Patient Reference in MedicationRequest.subject
  5. A dateTime in MedicationRequest.authoredOn
  6. A Requester Reference in MedicationRequest.requester

Summary of the Must Support Requirements

  1. A boolean or Reference in MedicationRequest.reported[x]
  2. A Encounter Reference in MedicationRequest.encounter
  3. One or more Dosages in MedicationRequest.dosageInstruction
    • which should have a string value in MedicationRequest.dosageInstruction.text

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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*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 0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if request is prohibiting action
... reported[x] SΣ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(US Core Patient Profile | US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | RelatedPerson)
... medication[x] SΣ1..1Medication to be taken
Binding: US Core Medication Codes (RxNorm) (extensible)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(US Core Medication Profile)
... subject SΣ1..1Reference(US Core Patient Profile)Who or group medication request is for
... encounter S0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation 0..*Reference(Resource)Information to support ordering of the medication
... authoredOn SΣ1..1dateTimeWhen request was initially authored
... requester SΣ1..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile | US Core Implantable Device Profile | RelatedPerson)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 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference 0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical Σ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 S0..*DosageHow the medication should be taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence Σ0..1integerThe order of the dosage instructions
.... text SΣ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction Σ0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
.... asNeeded[x] Σ0..1Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site Σ0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route Σ0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate ΣI0..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... dose[x] Σ0..1Amount of medication per dose
...... doseRangeRange
...... doseQuantityQuantity
..... rate[x] Σ0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity
.... maxDosePerPeriod Σ0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime Σ0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... 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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

  • See the General Guidance section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters, search parameter combinations SHALL be supported. Any listed search parameter modifiers, comparators, chains and composites SHALL also be supported UNLESS they are listed as “optional” in which case they SHOULD be supported.:

  1. SHALL support searching using the combination of the patient and intent search parameters:

    GET [base]/MedicationRequest?patient=[reference]&intent=http://hl7.org/fhir/CodeSystem/medicationrequest-intent|order

    Example:

    1. GET [base]/MedicationRequest?patient=14676&intent=http://hl7.org/fhir/CodeSystem/medicationrequest-intent order
    2. GET [base]/MedicationRequest?patient=14676&intent=http://hl7.org/fhir/CodeSystem/medicationrequest-intent order&_include=MedicationRequest:medication

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient and intent code = order (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and intent and status search parameters:

    • including support for composite OR search on status (e.g.status={[system]}|[code],{[system]}|[code],...)

    GET [base]/MedicationRequest?patient=[reference]&intent=http://hl7.org/fhir/CodeSystem/medicationrequest-intent|order&status={[system]}|[code]{,{[system]}|[code],...}

    Example:

    1. GET [base]/MedicationRequest?patient=1137192&status=active
    2. GET [base]/MedicationRequest?patient=1137192&status=active&_include=MedicationRequest:medication

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient and intent code = order and status (how to search by reference and how to search by token)

Optional Search Parameters:

The following search parameters, search parameter combinations and search parameter modifiers, comparators, chains and composites SHOULD be supported.

  1. SHOULD support searching using the combination of the patient and intent and encounter search parameters:

    GET [base]/MedicationRequest?patient=[reference]&intent=http://hl7.org/fhir/CodeSystem/medicationrequest-intent|order&encounter=[reference]

    Example:

    1. GET [base]/MedicationRequest?patient=1137192&status=active
    2. GET [base]/MedicationRequest?patient=1137192&status=active&_include=MedicationRequest:medication

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient and intent code = order and encounter (how to search by reference and how to search by token)

  2. SHOULD support searching using the combination of the patient and intent and authoredon search parameters:

    • including support for these authoredon comparators: gt,lt,ge,le
    • including optional support for composite AND search on authoredon (e.g.authoredon=[date]&authoredon=[date]]&...)

    GET [base]/MedicationRequest?patient=[reference]&intent=http://hl7.org/fhir/CodeSystem/medicationrequest-intent|order&authoredon={gt|lt|ge|le}[date]{&authoredon={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/MedicationRequest?patient=1137192&effective=ge2019
    2. GET [base]/MedicationStatement?patient=1137192&effective=ge2019&_include=MedicationRequest:medication

    Implementation Notes: Fetches a bundle of all MedicationRequest resources for the specified patient and intent code = order and authoredon date (how to search by reference and how to search by token and how to search by date)