Consumer Real-Time Pharmacy Benefit Check FHIR IG
2.0.0 - CI Build

Consumer Real-Time Pharmacy Benefit Check FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-rtpbc/ and changes regularly. See the Directory of published versions

## Resource Profile: RTPBC Medication Request - Non-PHI

Official URL: http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-medicationrequest-non-phi | Version: 2.0.0
Standards status: Trial-use Active as of 2020-12-12 | Maturity Level: 4 | Computable Name: RtpbcMedicationRequestNonPHI

This profile provides minimal prescription characteristics for submission in an RTPBC request to data sources that can provide benefit or price information without receiving patient details.

Usages:

- Use this Profile: RTPBC Request Bundle - Non-PHI
- Refer to this Profile: RTPBC Request Using Claim - Non-PHI
- Examples for this Profile: MedicationRequest/rtpbc-medicationrequest-non-phi-1 and MedicationRequest/rtpbc-medicationrequest-non-phi-2

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | Ordering of medication for patient or group
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | Request Status Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Fixed Value: draft
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. Fixed Value: proposal
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
medication[x] | S Σ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm)
coding | Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
text | S Σ | 0..1 | string | Plain text representation of the concept
subject | Σ | 1..1 | Reference(Patient | Group) | Patient - non-PHI
display | S Σ | 0..1 | string | Text alternative for the resource
authoredOn | Σ | 0..1 | dateTime | When request was initially authored
requester | Σ | 0..1 | Reference(US Core Practitioner Profile) | Prescriber
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
dispenseRequest | S | 1..1 | BackboneElement | Medication supply authorization
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
quantity | S | 1..1 | SimpleQuantity(4.0.1) | Prescribed Quantity
value | S Σ | 1..1 | decimal | Quantity in Billing Units
unit | S Σ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure
expectedSupplyDuration | S | 0..1 | Duration | Days Supply
value | S Σ | 0..1 | decimal | Days Supply Value
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
performer | S | 0..1 | Reference(Organization) | Pharmacy
substitution | S | 0..1 | BackboneElement | Substitution
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
allowed[x] | S | 1..1 | boolean | Substitution Allowed
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.medication[x] | Base | extensible | RTPBC Prescribable Product Code Value Set | 📦2.0.0 | This IG
MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
MedicationRequest.dispenseRequest.​quantity.unit | Base | extensible | RTPBC Billing Unit Value Set | 📦2.0.0 | This IG
MedicationRequest.dispenseRequest.​expectedSupplyDuration.​comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | Ordering of medication for patient or group
status |  | 1..1 | code | Request Status Fixed Value: draft
intent |  | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: proposal
medication[x] | S | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm)
coding |  |  |  |
system | S | 0..1 | uri | Identity of the terminology system
code | S | 0..1 | code | Symbol in syntax defined by the system
text | S | 0..1 | string | Plain text representation of the concept
subject |  | 1..1 | Reference(Patient | Group) | Patient - non-PHI
display | S | 0..1 | string | Text alternative for the resource
authoredOn |  | 0..1 | dateTime | When request was initially authored
requester |  | 0..1 | Reference(US Core Practitioner Profile) | Prescriber
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication
dispenseRequest | S | 1..1 | BackboneElement | Medication supply authorization
quantity | S | 1..1 | SimpleQuantity(4.0.1) | Prescribed Quantity
value | S | 1..1 | decimal | Quantity in Billing Units
unit | S | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure
expectedSupplyDuration | S | 0..1 | Duration | Days Supply
value | S | 0..1 | decimal | Days Supply Value
performer | S | 0..1 | Reference(Organization) | Pharmacy
substitution | S | 0..1 | BackboneElement | Substitution
allowed[x] | S | 1..1 | boolean | Substitution Allowed
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
MedicationRequest.medication[x] | Base | extensible | RTPBC Prescribable Product Code Value Set | 📦2.0.0 | This IG
MedicationRequest.dispenseRequest.​quantity.unit | Base | extensible | RTPBC Billing Unit Value Set | 📦2.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | Ordering of medication for patient or group
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | External ids for this request
status | ?!Σ | 1..1 | code | Request Status Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Fixed Value: draft
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. Fixed Value: proposal
category |  | 0..* | 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.
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
reported[x] | Σ | 0..1 |  | Reported rather than primary record
reportedBoolean |  |  | boolean |
reportedReference |  |  | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) |
medication[x] | S Σ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | S Σ | 0..1 | string | Plain text representation of the concept
subject | Σ | 1..1 | Reference(Patient | Group) | Patient - non-PHI
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | S Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay
supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication
authoredOn | Σ | 0..1 | dateTime | When request was initially authored
requester | Σ | 0..1 | Reference(US Core Practitioner Profile) | Prescriber
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..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
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..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills
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..* | Annotation | Information about the prescription
dosageInstruction |  | 0..* | Dosage | How the medication should be taken
dispenseRequest | S | 1..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(4.0.1) | 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 | S | 1..1 | SimpleQuantity(4.0.1) | Prescribed Quantity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
value | S Σ | 1..1 | decimal | Quantity in Billing Units
unit | S Σ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
expectedSupplyDuration | S | 0..1 | Duration | Days Supply
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
value | S Σ | 0..1 | decimal | Days Supply Value
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
performer | S | 0..1 | Reference(Organization) | Pharmacy
substitution | S | 0..1 | BackboneElement | 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] | S | 1..1 | boolean | Substitution Allowed
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) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
MedicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
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.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
MedicationRequest.medication[x] | Base | extensible | RTPBC Prescribable Product Code Value Set | 📦2.0.0 | This IG
MedicationRequest.subject.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std.
MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📍4.0.1 | FHIR Std.
MedicationRequest.dispenseRequest.​quantity.unit | Base | extensible | RTPBC Billing Unit Value Set | 📦2.0.0 | This IG
MedicationRequest.dispenseRequest.​expectedSupplyDuration.​comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
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()`

Summary

Mandatory: 4 elements
Must-Support: 14 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)

Maturity: 4

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | Ordering of medication for patient or group
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | Request Status Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Fixed Value: draft
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. Fixed Value: proposal
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
medication[x] | S Σ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm)
coding | Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
text | S Σ | 0..1 | string | Plain text representation of the concept
subject | Σ | 1..1 | Reference(Patient | Group) | Patient - non-PHI
display | S Σ | 0..1 | string | Text alternative for the resource
authoredOn | Σ | 0..1 | dateTime | When request was initially authored
requester | Σ | 0..1 | Reference(US Core Practitioner Profile) | Prescriber
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
dispenseRequest | S | 1..1 | BackboneElement | Medication supply authorization
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
quantity | S | 1..1 | SimpleQuantity(4.0.1) | Prescribed Quantity
value | S Σ | 1..1 | decimal | Quantity in Billing Units
unit | S Σ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure
expectedSupplyDuration | S | 0..1 | Duration | Days Supply
value | S Σ | 0..1 | decimal | Days Supply Value
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
performer | S | 0..1 | Reference(Organization) | Pharmacy
substitution | S | 0..1 | BackboneElement | Substitution
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
allowed[x] | S | 1..1 | boolean | Substitution Allowed
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.medication[x] | Base | extensible | RTPBC Prescribable Product Code Value Set | 📦2.0.0 | This IG
MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
MedicationRequest.dispenseRequest.​quantity.unit | Base | extensible | RTPBC Billing Unit Value Set | 📦2.0.0 | This IG
MedicationRequest.dispenseRequest.​expectedSupplyDuration.​comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.

#### 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | Ordering of medication for patient or group
status |  | 1..1 | code | Request Status Fixed Value: draft
intent |  | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: proposal
medication[x] | S | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm)
coding |  |  |  |
system | S | 0..1 | uri | Identity of the terminology system
code | S | 0..1 | code | Symbol in syntax defined by the system
text | S | 0..1 | string | Plain text representation of the concept
subject |  | 1..1 | Reference(Patient | Group) | Patient - non-PHI
display | S | 0..1 | string | Text alternative for the resource
authoredOn |  | 0..1 | dateTime | When request was initially authored
requester |  | 0..1 | Reference(US Core Practitioner Profile) | Prescriber
reasonCode |  | 0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication
dispenseRequest | S | 1..1 | BackboneElement | Medication supply authorization
quantity | S | 1..1 | SimpleQuantity(4.0.1) | Prescribed Quantity
value | S | 1..1 | decimal | Quantity in Billing Units
unit | S | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure
expectedSupplyDuration | S | 0..1 | Duration | Days Supply
value | S | 0..1 | decimal | Days Supply Value
performer | S | 0..1 | Reference(Organization) | Pharmacy
substitution | S | 0..1 | BackboneElement | Substitution
allowed[x] | S | 1..1 | boolean | Substitution Allowed
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
MedicationRequest.medication[x] | Base | extensible | RTPBC Prescribable Product Code Value Set | 📦2.0.0 | This IG
MedicationRequest.dispenseRequest.​quantity.unit | Base | extensible | RTPBC Billing Unit Value Set | 📦2.0.0 | This IG

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationRequest |  | 0..* | MedicationRequest | Ordering of medication for patient or group
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | External ids for this request
status | ?!Σ | 1..1 | code | Request Status Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. Fixed Value: draft
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. Fixed Value: proposal
category |  | 0..* | 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.
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
reported[x] | Σ | 0..1 |  | Reported rather than primary record
reportedBoolean |  |  | boolean |
reportedReference |  |  | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) |
medication[x] | S Σ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 0..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | S Σ | 0..1 | string | Plain text representation of the concept
subject | Σ | 1..1 | Reference(Patient | Group) | Patient - non-PHI
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | S Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay
supportingInformation |  | 0..* | Reference(Resource) | Information to support ordering of the medication
authoredOn | Σ | 0..1 | dateTime | When request was initially authored
requester | Σ | 0..1 | Reference(US Core Practitioner Profile) | Prescriber
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..* | CodeableConcept | Reason or indication for ordering or not ordering the medication Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.
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..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills
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..* | Annotation | Information about the prescription
dosageInstruction |  | 0..* | Dosage | How the medication should be taken
dispenseRequest | S | 1..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(4.0.1) | 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 | S | 1..1 | SimpleQuantity(4.0.1) | Prescribed Quantity
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
value | S Σ | 1..1 | decimal | Quantity in Billing Units
unit | S Σ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
expectedSupplyDuration | S | 0..1 | Duration | Days Supply
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
value | S Σ | 0..1 | decimal | Days Supply Value
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented.
unit | Σ | 0..1 | string | Unit representation
system | Σ C | 0..1 | uri | System that defines coded unit form
code | Σ | 0..1 | code | Coded form of the unit
performer | S | 0..1 | Reference(Organization) | Pharmacy
substitution | S | 0..1 | BackboneElement | 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] | S | 1..1 | boolean | Substitution Allowed
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) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
MedicationRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
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.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
MedicationRequest.medication[x] | Base | extensible | RTPBC Prescribable Product Code Value Set | 📦2.0.0 | This IG
MedicationRequest.subject.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
MedicationRequest.performerType | Base | example | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std.
MedicationRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
MedicationRequest.courseOfTherapyType | Base | example | Medication request course of therapy codes | 📍4.0.1 | FHIR Std.
MedicationRequest.dispenseRequest.​quantity.unit | Base | extensible | RTPBC Billing Unit Value Set | 📦2.0.0 | This IG
MedicationRequest.dispenseRequest.​expectedSupplyDuration.​comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std.
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()`

Summary

Mandatory: 4 elements
Must-Support: 14 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)

Maturity: 4

Other representations of profile: CSV, Excel, Schematron