SMART Base Clinical
1.0.0 - ci-build
SMART Base Clinical
1.0.0 - ci-build
SMART Base Clinical, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base-clinical/ and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/base-clinical/StructureDefinition/sg-medicationnotrequested | Version: 1.0.0 | |||
| Draft as of 2024-12-02 | Computable Name: SGMedicationNotRequested | |||
The WHO SMART Guidelines Medication Not Requested profile defines conformance requirements and exchange expectations for MedicationRequest resources used to communicate that a specific medication (or class of medications) should not be prescribed in WHO Smart Guidelines content.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CPGMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationRequest |
SC | 0..* | CPGMedicationRequest | Ordering of medication for patient or group mnr-1: To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided |
  identifier |
S | 1..* | Identifier | External ids for this request |
  use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| system |
S | 1..1 | uri | The namespace for the identifier value |
 value |
S | 1..1 | string | The value that is unique |
| status |
S | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown |
 doNotPerform |
S | 1..1 | boolean | True if request is prohibiting action Fixed Value: true |
 medication[x] |
SC | 1..1 | CodeableConcept | Medication to be taken |
 Slices for extension |
Content/Rules for all slices | |||
  notDoneValueSet |
SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet |
| coding |
C | 0..* | Coding | Code defined by a terminology system |
 subject |
S | 1..1 | Reference(WHO SMART Guidelines Patient) | Who or group medication request is for |
| encounter |
S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter created as part of encounter/admission/stay |
| authoredOn |
S | 1..1 | dateTime | When request was initially authored |
| requester |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who/What requested the Request |
| recorder |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Person who entered the request |
| reasonCode |
S | 1..1 | CodeableConcept | Reason or indication for ordering or not ordering the medication |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| mnr-1 | error | MedicationRequest | To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor medication.coding.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
SC | 0..* | CPGMedicationRequest | Ordering of medication for patient or group mnr-1: To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
 rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale |
| rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
S | 1..* | Identifier | External ids for this request |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
| intent |
?!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. |
| category |
S | 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 |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform |
?!SΣ | 1..1 | boolean | True if request is prohibiting action Fixed Value: true |
| medication[x] |
SΣC | 1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| Slices for extension |
Content/Rules for all slices | |||
| notDoneValueSet |
SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet |
| coding |
ΣC | 0..* | Coding | Code defined by a terminology system |
| subject |
SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who or group medication request is for |
| encounter |
S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter created as part of encounter/admission/stay |
| supportingInformation |
S | 0..* | Reference(Resource) | Pertinent information |
| authoredOn |
SΣ | 1..1 | dateTime | When request was initially authored |
| requester |
SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who/What requested the Request |
| recorder |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Person who entered the request |
| reasonCode |
S | 1..1 | 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. |
| instantiatesCanonical |
SΣ | 0..* | canonical() | Source |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | |
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | |
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom 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() | |
| mnr-1 | error | MedicationRequest | To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor medication.coding.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
SC | 0..* | CPGMedicationRequest | Ordering of medication for patient or group mnr-1: To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | ||||
| rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..* | Identifier | External ids for this request | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
| intent |
?!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. | ||||
| category |
S | 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 |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!SΣ | 1..1 | boolean | True if request is prohibiting action Fixed Value: true | ||||
 reported[x] |
Σ | 0..1 | Reported rather than primary record | |||||
| reportedBoolean |
boolean | |||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
| medication[x] |
SΣC | 1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| notDoneValueSet |
SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet | ||||
| coding |
ΣC | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who or group medication request is for | ||||
| encounter |
S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter created as part of encounter/admission/stay | ||||
| supportingInformation |
S | 0..* | Reference(Resource) | Pertinent information | ||||
| authoredOn |
SΣ | 1..1 | dateTime | When request was initially authored | ||||
| requester |
SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who/What requested the Request | ||||
| 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 |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Person who entered the request | ||||
| reasonCode |
S | 1..1 | 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 |
SΣ | 0..* | canonical() | Source | ||||
| 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 |
0..1 | BackboneElement | Medication supply authorization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| initialFill |
0..1 | BackboneElement | First fill details | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| quantity |
0..1 | SimpleQuantity | First fill quantity | |||||
| duration |
0..1 | Duration | First fill duration | |||||
| dispenseInterval |
0..1 | Duration | Minimum period of time between dispenses | |||||
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of refills authorized | |||||
| quantity |
0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||
| performer |
0..1 | Reference(Organization) | Intended dispenser | |||||
| substitution |
0..1 | BackboneElement | Any restrictions on medication substitution | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| allowed[x] |
1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| priorPrescription |
0..1 | Reference(MedicationRequest) | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| MedicationRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reasonfrom the FHIR Standard | ||||
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | ||||
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | ||||
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapyfrom the FHIR Standard | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| 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() | |
| mnr-1 | error | MedicationRequest | To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor medication.coding.exists() |
This structure is derived from CPGMedicationRequest
Summary
Mandatory: 7 elements
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from CPGMedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
SC | 0..* | CPGMedicationRequest | Ordering of medication for patient or group mnr-1: To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided |
| identifier |
S | 1..* | Identifier | External ids for this request |
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| status |
S | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown |
| doNotPerform |
S | 1..1 | boolean | True if request is prohibiting action Fixed Value: true |
| medication[x] |
SC | 1..1 | CodeableConcept | Medication to be taken |
| Slices for extension |
Content/Rules for all slices | |||
| notDoneValueSet |
SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet |
| coding |
C | 0..* | Coding | Code defined by a terminology system |
| subject |
S | 1..1 | Reference(WHO SMART Guidelines Patient) | Who or group medication request is for |
| encounter |
S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter created as part of encounter/admission/stay |
| authoredOn |
S | 1..1 | dateTime | When request was initially authored |
| requester |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who/What requested the Request |
| recorder |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Person who entered the request |
| reasonCode |
S | 1..1 | CodeableConcept | Reason or indication for ordering or not ordering the medication |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| mnr-1 | error | MedicationRequest | To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor medication.coding.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest |
SC | 0..* | CPGMedicationRequest | Ordering of medication for patient or group mnr-1: To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale |
| rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
S | 1..* | Identifier | External ids for this request |
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
| intent |
?!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. |
| category |
S | 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 |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform |
?!SΣ | 1..1 | boolean | True if request is prohibiting action Fixed Value: true |
| medication[x] |
SΣC | 1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| Slices for extension |
Content/Rules for all slices | |||
| notDoneValueSet |
SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet |
| coding |
ΣC | 0..* | Coding | Code defined by a terminology system |
| subject |
SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who or group medication request is for |
| encounter |
S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter created as part of encounter/admission/stay |
| supportingInformation |
S | 0..* | Reference(Resource) | Pertinent information |
| authoredOn |
SΣ | 1..1 | dateTime | When request was initially authored |
| requester |
SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who/What requested the Request |
| recorder |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Person who entered the request |
| reasonCode |
S | 1..1 | 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. |
| instantiatesCanonical |
SΣ | 0..* | canonical() | Source |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | |
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | |
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | |
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom 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() | |
| mnr-1 | error | MedicationRequest | To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor medication.coding.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationRequest |
SC | 0..* | CPGMedicationRequest | Ordering of medication for patient or group mnr-1: To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | ||||
| rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..* | Identifier | External ids for this request | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!SΣ | 1..1 | code | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status. | |||||
| intent |
?!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. | ||||
| category |
S | 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 |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!SΣ | 1..1 | boolean | True if request is prohibiting action Fixed Value: true | ||||
| reported[x] |
Σ | 0..1 | Reported rather than primary record | |||||
| reportedBoolean |
boolean | |||||||
| reportedReference |
Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | |||||||
| medication[x] |
SΣC | 1..1 | CodeableConcept | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| notDoneValueSet |
SC | 0..1 | canonical(ValueSet) | What was not requested URL: http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet | ||||
| coding |
ΣC | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
SΣ | 1..1 | Reference(WHO SMART Guidelines Patient) | Who or group medication request is for | ||||
| encounter |
S | 0..1 | Reference(WHO SMART Guidelines Encounter) | Encounter created as part of encounter/admission/stay | ||||
| supportingInformation |
S | 0..* | Reference(Resource) | Pertinent information | ||||
| authoredOn |
SΣ | 1..1 | dateTime | When request was initially authored | ||||
| requester |
SΣ | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole | WHO SMART Guidelines Patient | WHO SMART Guidelines RelatedPerson) | Who/What requested the Request | ||||
| 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 |
S | 0..1 | Reference(WHO SMART Guidelines Practitioner | WHO SMART Guidelines PractitionerRole) | Person who entered the request | ||||
| reasonCode |
S | 1..1 | 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 |
SΣ | 0..* | canonical() | Source | ||||
| 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 |
0..1 | BackboneElement | Medication supply authorization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| initialFill |
0..1 | BackboneElement | First fill details | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| quantity |
0..1 | SimpleQuantity | First fill quantity | |||||
| duration |
0..1 | Duration | First fill duration | |||||
| dispenseInterval |
0..1 | Duration | Minimum period of time between dispenses | |||||
| validityPeriod |
0..1 | Period | Time period supply is authorized for | |||||
| numberOfRepeatsAllowed |
0..1 | unsignedInt | Number of refills authorized | |||||
| quantity |
0..1 | SimpleQuantity | Amount of medication to supply per dispense | |||||
| expectedSupplyDuration |
0..1 | Duration | Number of days supply per dispense | |||||
| performer |
0..1 | Reference(Organization) | Intended dispenser | |||||
| substitution |
0..1 | BackboneElement | Any restrictions on medication substitution | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| allowed[x] |
1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed. | ||||||
| allowedBoolean |
boolean | |||||||
| allowedCodeableConcept |
CodeableConcept | |||||||
| reason |
0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. | |||||
| priorPrescription |
0..1 | Reference(MedicationRequest) | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| MedicationRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| MedicationRequest.status | required | medicationrequest Statushttp://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1from the FHIR Standard | ||||
| MedicationRequest.statusReason | example | medicationRequest Status Reason Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-status-reasonfrom the FHIR Standard | ||||
| MedicationRequest.intent | required | medicationRequest Intenthttp://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1from the FHIR Standard | ||||
| MedicationRequest.category | example | medicationRequest Category Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-categoryfrom the FHIR Standard | ||||
| MedicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| MedicationRequest.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationRequest.performerType | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| MedicationRequest.reasonCode | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard | ||||
| MedicationRequest.courseOfTherapyType | example | medicationRequest Course of Therapy Codeshttp://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapyfrom the FHIR Standard | ||||
| MedicationRequest.substitution.allowed[x] | example | ActSubstanceAdminSubstitutionCodehttp://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode | ||||
| 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() | |
| mnr-1 | error | MedicationRequest | To indicate what medication was not requested, either at least one coding in the medication element or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/StructureDefinition/cqf-notDoneValueSet').exists() xor medication.coding.exists() |
This structure is derived from CPGMedicationRequest
Summary
Mandatory: 7 elements
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron