Clinical Practice Guidelines
2.0.0-ballot - ballot International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

Resource Profile: CPG Immunization Request

Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-immunizationrequest Version: 2.0.0-ballot
Active as of 2023-12-19 Computable Name: CPGImmunizationRequest

Recommendation for a particular immunization as part of the delivery of a computable clinical practice guideline

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rationale S0..1markdownCPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... identifier S0..*IdentifierExternal ids for this request
... intent S1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
... Slices for category S1..*CodeableConceptType of medication usage
Slice: Unordered, Open by pattern:coding
.... category:immunization S1..1CodeableConceptType of medication usage
..... coding 1..*CodingCode defined by a terminology system
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: recommend-immunization
... priority S0..1coderoutine | urgent | asap | stat
... doNotPerform S0..1booleanTrue if request is prohibiting action
... medication[x] S1..1CodeableConcept, Reference(Medication)Medication to be taken
... subject S1..1Reference(CPG Patient)Who or group medication request is for
... encounter S0..1Reference(CPG Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Pertinent information
... instantiatesCanonical S0..*canonical()Source

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rationale S0..1markdownCPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... identifier S0..*IdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | 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..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... Slices for category S1..*CodeableConceptType of medication usage
Slice: Unordered, Open by pattern:coding
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.


.... category:immunization S1..1CodeableConceptType 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.


..... coding Σ1..*CodingCode defined by a terminology system

Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: recommend-immunization
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... medication[x] SΣ1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(CPG Patient)Who or group medication request is for
... encounter S0..1Reference(CPG Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Pertinent information
... instantiatesCanonical SΣ0..*canonical()Source

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.category:immunizationexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rationale S0..1markdownCPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | 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..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!SΣ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... Slices for category S1..*CodeableConceptType of medication usage
Slice: Unordered, Open by pattern:coding
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.


.... category:immunization S1..1CodeableConceptType 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.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: recommend-immunization
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SΣ1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(CPG Patient)Who or group medication request is for
... encounter S0..1Reference(CPG Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Pertinent information
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): 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..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest 0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy 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..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.category:immunizationexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequest

Summary

Mandatory: 3 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.category is sliced based on the value of pattern:coding

Differential View

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rationale S0..1markdownCPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... identifier S0..*IdentifierExternal ids for this request
... intent S1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
... Slices for category S1..*CodeableConceptType of medication usage
Slice: Unordered, Open by pattern:coding
.... category:immunization S1..1CodeableConceptType of medication usage
..... coding 1..*CodingCode defined by a terminology system
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: recommend-immunization
... priority S0..1coderoutine | urgent | asap | stat
... doNotPerform S0..1booleanTrue if request is prohibiting action
... medication[x] S1..1CodeableConcept, Reference(Medication)Medication to be taken
... subject S1..1Reference(CPG Patient)Who or group medication request is for
... encounter S0..1Reference(CPG Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Pertinent information
... instantiatesCanonical S0..*canonical()Source

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rationale S0..1markdownCPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... identifier S0..*IdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | 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..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... Slices for category S1..*CodeableConceptType of medication usage
Slice: Unordered, Open by pattern:coding
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.


.... category:immunization S1..1CodeableConceptType 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.


..... coding Σ1..*CodingCode defined by a terminology system

Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: recommend-immunization
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... medication[x] SΣ1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(CPG Patient)Who or group medication request is for
... encounter S0..1Reference(CPG Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Pertinent information
... instantiatesCanonical SΣ0..*canonical()Source

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.category:immunizationexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rationale S0..1markdownCPG Rationale Extension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierExternal ids for this request
... status ?!SΣ1..1codeactive | 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..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

... intent ?!SΣ1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required): The kind of medication order.

... Slices for category S1..*CodeableConceptType of medication usage
Slice: Unordered, Open by pattern:coding
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.


.... category:immunization S1..1CodeableConceptType 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.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system

Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: recommend-immunization
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!SΣ0..1booleanTrue if request is prohibiting action
... reported[x] Σ0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
... medication[x] SΣ1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(CPG Patient)Who or group medication request is for
... encounter S0..1Reference(CPG Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation S0..*Reference(Resource)Pertinent information
... authoredOn Σ0..1dateTimeWhen request was initially authored
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/What requested the Request
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType Σ0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

... recorder 0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode 0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): 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..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... courseOfTherapyType 0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example): Identifies the overall pattern of medication administratio.

... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationInformation about the prescription
... dosageInstruction 0..*DosageHow the medication should be taken
... dispenseRequest 0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill 0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity 0..1SimpleQuantityFirst fill quantity
..... duration 0..1DurationFirst fill duration
.... dispenseInterval 0..1DurationMinimum period of time between dispenses
.... validityPeriod 0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed 0..1unsignedIntNumber of refills authorized
.... quantity 0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration 0..1DurationNumber of days supply per dispense
.... performer 0..1Reference(Organization)Intended dispenser
... substitution 0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] 1..1Whether substitution is allowed or not
Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason 0..1CodeableConceptWhy 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..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue 0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.category:immunizationexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationRequestIf 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-4errorMedicationRequestIf 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-5errorMedicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MedicationRequest

Summary

Mandatory: 3 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationRequest.category is sliced based on the value of pattern:coding

 

Other representations of profile: CSV, Excel, Schematron