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
Official URL: http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-medicationrequest | Version: 2.0.0 | |||
Standards status: Trial-use | Maturity Level: 4 | Computable Name: RtpbcMedicationRequest |
This profile constrains the MedicationRequest resource to convey a subset of prescription information required in the consumer real-time pharmacy benefit check (RTPBC) process. The content specifies the prescribed product and quantity, and references the prescribing practitioner and the patient's preferred pharmacy.
This profile differs from the US Core MedicationRequest in that it doesn't set the encounter or dosageInstruction elements as Must Support, because clients in the exchange will typically be mobile consumer applications that do not posess this information, and because that information is not pertinent to this use case.
The function of the MedicationRequest resource in this exchange is to convey information from the patient's prescription that has a bearing on pricing and coverage. This limited set of information consists of…
Client systems
All of the elements identified above are marked Must Support…
Client and Responding systems
Responding systems
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MedicationRequest | Ordering of medication for patient or group | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 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 |
![]() ![]() ![]() |
?!SΣ | 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 |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Reported rather than primary record |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RTPBC Patient) | Patient |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request was initially authored |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Prescriber |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
S | 0..* | Dosage | How the medication should be taken |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Medication supply authorization |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | SimpleQuantity | Prescribed Quantity |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Quantity in Billing Units |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Days Supply |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | decimal | Days Supply Value |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Pharmacy Organization) | Pharmacy |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Substitution |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Substitution Allowed |
![]() |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 From the FHIR Standard | |
MedicationRequest.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 From the FHIR Standard | |
MedicationRequest.medication[x] | extensible | RTPBCPrescribableProductCodeValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code From this IG | |
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard | |
MedicationRequest.dispenseRequest.quantity.unit | extensible | RtbpcBillingUnitValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit From this IG | |
MedicationRequest.dispenseRequest.expectedSupplyDuration.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 MedicationRequest
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MedicationRequest | Ordering of medication for patient or group | |
![]() ![]() ![]() |
S | 1..1 | code | Request Status Fixed Value: draft |
![]() ![]() ![]() |
S | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: proposal |
![]() ![]() ![]() |
S | 1..1 | boolean | Reported rather than primary record |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm) |
![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Patient) | Patient |
![]() ![]() ![]() |
S | 1..1 | dateTime | When request was initially authored |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Practitioner Profile) | Prescriber |
![]() ![]() ![]() |
0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication | |
![]() ![]() ![]() |
S | 0..* | Dosage | How the medication should be taken |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Medication supply authorization |
![]() ![]() ![]() ![]() |
S | 1..1 | SimpleQuantity | Prescribed Quantity |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | decimal | Quantity in Billing Units |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Days Supply |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Days Supply Value |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Pharmacy Organization) | Pharmacy |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Substitution |
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Substitution Allowed |
![]() |
Path | Conformance | ValueSet | URI |
MedicationRequest.medication[x] | extensible | RTPBCPrescribableProductCodeValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code From this IG | |
MedicationRequest.dispenseRequest.quantity.unit | extensible | RtbpcBillingUnitValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MedicationRequest | Ordering of medication for patient or group | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | External ids for this request | |||||
![]() ![]() ![]() |
?!SΣ | 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 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
![]() ![]() ![]() |
?!SΣ | 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 | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Reported rather than primary record | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RTPBC Patient) | Patient | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request was initially authored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Prescriber | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||
![]() ![]() ![]() |
Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||
![]() ![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
![]() ![]() ![]() |
0..* | Annotation | Information about the prescription | |||||
![]() ![]() ![]() |
S | 0..* | Dosage | How the medication should be taken | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Medication supply authorization | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | First fill details | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | First fill quantity | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Duration | First fill duration | |||||
![]() ![]() ![]() ![]() |
0..1 | Duration | Minimum period of time between dispenses | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period supply is authorized for | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Number of refills authorized | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | SimpleQuantity | Prescribed Quantity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Quantity in Billing Units | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Days Supply | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | decimal | Days Supply Value | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Pharmacy Organization) | Pharmacy | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Substitution | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Substitution Allowed | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Reference(MedicationRequest) | An order/prescription that is being replaced | |||||
![]() ![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||
![]() ![]() ![]() |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
MedicationRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 From the FHIR Standard | ||||
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason From the FHIR Standard | ||||
MedicationRequest.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 From the FHIR Standard | ||||
MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-category From the FHIR Standard | ||||
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
MedicationRequest.medication[x] | extensible | RTPBCPrescribableProductCodeValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code From this IG | ||||
MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role From the FHIR Standard | ||||
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard | ||||
MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy From the FHIR Standard | ||||
MedicationRequest.dispenseRequest.quantity.unit | extensible | RtbpcBillingUnitValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit From this IG | ||||
MedicationRequest.dispenseRequest.expectedSupplyDuration.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 From the FHIR Standard | ||||
MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
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 MedicationRequest
Summary
Mandatory: 9 elements
Must-Support: 17 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 4
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MedicationRequest | Ordering of medication for patient or group | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 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 |
![]() ![]() ![]() |
?!SΣ | 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 |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Reported rather than primary record |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm) |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RTPBC Patient) | Patient |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request was initially authored |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Prescriber |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
S | 0..* | Dosage | How the medication should be taken |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Medication supply authorization |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | SimpleQuantity | Prescribed Quantity |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Quantity in Billing Units |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Days Supply |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | decimal | Days Supply Value |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Pharmacy Organization) | Pharmacy |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Substitution |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Substitution Allowed |
![]() |
Path | Conformance | ValueSet / Code | URI |
MedicationRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 From the FHIR Standard | |
MedicationRequest.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 From the FHIR Standard | |
MedicationRequest.medication[x] | extensible | RTPBCPrescribableProductCodeValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code From this IG | |
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard | |
MedicationRequest.dispenseRequest.quantity.unit | extensible | RtbpcBillingUnitValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit From this IG | |
MedicationRequest.dispenseRequest.expectedSupplyDuration.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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 MedicationRequest
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MedicationRequest | Ordering of medication for patient or group | |
![]() ![]() ![]() |
S | 1..1 | code | Request Status Fixed Value: draft |
![]() ![]() ![]() |
S | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: proposal |
![]() ![]() ![]() |
S | 1..1 | boolean | Reported rather than primary record |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm) |
![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Patient) | Patient |
![]() ![]() ![]() |
S | 1..1 | dateTime | When request was initially authored |
![]() ![]() ![]() |
S | 1..1 | Reference(US Core Practitioner Profile) | Prescriber |
![]() ![]() ![]() |
0..* | CodeableConcept | Reason or indication for ordering or not ordering the medication | |
![]() ![]() ![]() |
S | 0..* | Dosage | How the medication should be taken |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Medication supply authorization |
![]() ![]() ![]() ![]() |
S | 1..1 | SimpleQuantity | Prescribed Quantity |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | decimal | Quantity in Billing Units |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure |
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Days Supply |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Days Supply Value |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Pharmacy Organization) | Pharmacy |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Substitution |
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Substitution Allowed |
![]() |
Path | Conformance | ValueSet | URI |
MedicationRequest.medication[x] | extensible | RTPBCPrescribableProductCodeValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code From this IG | |
MedicationRequest.dispenseRequest.quantity.unit | extensible | RtbpcBillingUnitValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MedicationRequest | Ordering of medication for patient or group | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | External ids for this request | |||||
![]() ![]() ![]() |
?!SΣ | 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 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
![]() ![]() ![]() |
?!SΣ | 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 | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Reported rather than primary record | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Prescribed Product Binding: RTPBC Prescribable Product Code Value Set (extensible): RTPBC prescribable product codes (NDC11 and RxNorm) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(RTPBC Patient) | Patient | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information to support ordering of the medication | |||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When request was initially authored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Prescriber | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Intended performer of administration | |||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation) | Condition or observation that supports why the prescription is being written | |||||
![]() ![]() ![]() |
Σ | 0..* | canonical() | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | What request fulfills | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Overall pattern of medication administration Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio. | |||||
![]() ![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
![]() ![]() ![]() |
0..* | Annotation | Information about the prescription | |||||
![]() ![]() ![]() |
S | 0..* | Dosage | How the medication should be taken | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Medication supply authorization | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | First fill details | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | First fill quantity | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Duration | First fill duration | |||||
![]() ![]() ![]() ![]() |
0..1 | Duration | Minimum period of time between dispenses | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period supply is authorized for | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Number of refills authorized | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | SimpleQuantity | Prescribed Quantity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Quantity in Billing Units | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Billing unit of measure Binding: RTPBC Billing Unit Value Set (extensible): Billing quantity unity of measure | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Duration | Days Supply | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | decimal | Days Supply Value | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(RTPBC Pharmacy Organization) | Pharmacy | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Substitution | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Substitution Allowed | ||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Reference(MedicationRequest) | An order/prescription that is being replaced | |||||
![]() ![]() ![]() |
0..* | Reference(DetectedIssue) | Clinical Issue with action | |||||
![]() ![]() ![]() |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
MedicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
MedicationRequest.status | required | Fixed Value: drafthttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1 From the FHIR Standard | ||||
MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reason From the FHIR Standard | ||||
MedicationRequest.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1 From the FHIR Standard | ||||
MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-category From the FHIR Standard | ||||
MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
MedicationRequest.medication[x] | extensible | RTPBCPrescribableProductCodeValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-prescribable-product-code From this IG | ||||
MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role From the FHIR Standard | ||||
MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code From the FHIR Standard | ||||
MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy From the FHIR Standard | ||||
MedicationRequest.dispenseRequest.quantity.unit | extensible | RtbpcBillingUnitValueSethttp://hl7.org/fhir/us/carin-rtpbc/ValueSet/rtpbc-billing-unit From this IG | ||||
MedicationRequest.dispenseRequest.expectedSupplyDuration.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 From the FHIR Standard | ||||
MedicationRequest.substitution.reason | example | SubstanceAdminSubstitutionReasonhttp://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason |
Id | Grade | Path(s) | Details | Requirements |
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 MedicationRequest
Summary
Mandatory: 9 elements
Must-Support: 17 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron