HIV-CASEREPORTING\HIV Care Medication Request

HIV Case Reporting and Monitoring
0.2.0 - CI Build

HIV Case Reporting and Monitoring - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: HIV Care Medication Request

Official URL: http://openhie.org/fhir/hiv-casereporting/StructureDefinition/hiv-med-req				Version: 0.2.0
Active as of 2022-10-06		Responsible: OpenHIE	Realm:	Computable Name: HIVCareMedicationRequest

HIV Care Medication Request

Usage:

Refer to this Resource Profile:
Examples for this Resource Profile: MedicationRequest/HIVCareMedicationRequestExample

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from MedicationRequest

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 2 elements

This structure is derived from MedicationRequest

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest		0..*	MedicationRequest	Ordering of medication for patient or group
basedOn	S	1..1	Reference(CarePlan \| MedicationRequest \| ServiceRequest \| ImmunizationRecommendation)	What request fulfills
dispenseRequest
quantity	S	1..1	SimpleQuantity	Amount of medication to supply per dispense
Documentation for this format

Description & Constraints

MedicationRequest

0..*

MedicationRequest

Ordering of medication for patient or group

id

Σ

0..1

id

Logical id of this artifact

category

0..*

CodeableConcept

Type of medication usage
Binding: medicationRequest Category Codes (example): A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.

priority

Σ

0..1

code

routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

doNotPerform

?!Σ

0..1

boolean

True if request is prohibiting action

reported[x]

Σ

0..1

Reported rather than primary record

reportedBoolean

boolean

reportedReference

Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)

medication[x]

Σ

1..1

Medication to be taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

medicationCodeableConcept

CodeableConcept

medicationReference

Reference(Medication)

subject

Σ

1..1

Reference(Patient | Group)

Who or group medication request is for

encounter

0..1

Reference(Encounter)

Encounter created as part of encounter/admission/stay

supportingInformation

0..*

Reference(Resource)

Information to support ordering of the medication

authoredOn

Σ

0..1

dateTime

When request was initially authored

requester

Σ

0..1

Who/What requested the Request

performer

0..1

Intended performer of administration

performerType

Σ

0..1

CodeableConcept

Desired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example): Identifies the type of individual that is desired to administer the medication.

recorder

0..1

Reference(Practitioner | PractitionerRole)

Person who entered the request

reasonCode

0..*

CodeableConcept

Reason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example): A coded concept indicating why the medication was ordered.

reasonReference

0..*

Reference(Condition | Observation)

Condition or observation that supports why the prescription is being written

instantiatesCanonical

Σ

0..*

canonical()

Instantiates FHIR protocol or definition

instantiatesUri

Σ

0..*

uri

Instantiates external protocol or definition

basedOn

SΣ

1..1

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

0..1

First fill quantity

0..1

First fill duration

0..1

Minimum period of time between dispenses

validityPeriod

0..1

Period

Time period supply is authorized for

numberOfRepeatsAllowed

0..1

unsignedInt

Number of refills authorized

quantity

S

1..1

SimpleQuantity

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

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest		0..*	MedicationRequest	Ordering of medication for patient or group
basedOn	Σ	1..1	Reference(CarePlan \| MedicationRequest \| ServiceRequest \| ImmunizationRecommendation)	What request fulfills
dispenseRequest		0..1	BackboneElement	Medication supply authorization
quantity		1..1	SimpleQuantity	Amount of medication to supply per dispense
Documentation for this format

This structure is derived from MedicationRequest

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 2 elements

Differential View

This structure is derived from MedicationRequest

Name	Flags	Card.	Type	Description & Constraints
MedicationRequest		0..*	MedicationRequest	Ordering of medication for patient or group
basedOn	S	1..1	Reference(CarePlan \| MedicationRequest \| ServiceRequest \| ImmunizationRecommendation)	What request fulfills
dispenseRequest
quantity	S	1..1	SimpleQuantity	Amount of medication to supply per dispense
Documentation for this format

Snapshot View

Description & Constraints

MedicationRequest

0..*

MedicationRequest

Ordering of medication for patient or group

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path	Conformance	ValueSet
MedicationRequest.language	preferred	CommonLanguages Max Binding: AllLanguages
MedicationRequest.status	required	medicationrequest Status
MedicationRequest.statusReason	example	medicationRequest Status Reason Codes
MedicationRequest.intent	required	medicationRequest Intent
MedicationRequest.category	example	medicationRequest Category Codes
MedicationRequest.priority	required	RequestPriority
MedicationRequest.medication[x]	example	SNOMEDCTMedicationCodes
MedicationRequest.performerType	example	ProcedurePerformerRoleCodes
MedicationRequest.reasonCode	example	Condition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyType	example	medicationRequest Course of Therapy Codes
MedicationRequest.substitution.allowed[x]	example	ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reason	example	SubstanceAdminSubstitutionReason

Constraints

Id	Grade	Path	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	MedicationRequest.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.statusReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.intent	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.priority	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.doNotPerform	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.reported[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.medication[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.supportingInformation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.authoredOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.requester	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.performerType	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.recorder	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.reasonCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.reasonReference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.instantiatesUri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.groupIdentifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.courseOfTherapyType	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.insurance	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dosageInstruction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.dispenseRequest.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.dispenseRequest.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.dispenseRequest.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.dispenseRequest.initialFill	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.initialFill.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.dispenseRequest.initialFill.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.dispenseRequest.initialFill.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.dispenseRequest.initialFill.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.dispenseRequest.initialFill.quantity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.initialFill.duration	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.dispenseInterval	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.validityPeriod	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.numberOfRepeatsAllowed	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.quantity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.expectedSupplyDuration	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.dispenseRequest.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.substitution	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.substitution.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.substitution.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.substitution.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	MedicationRequest.substitution.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	MedicationRequest.substitution.allowed[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.substitution.reason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.priorPrescription	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.detectedIssue	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	MedicationRequest.eventHistory	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2019+ OpenHIE. Package openhie.fhir.hiv#0.2.0 based on FHIR 4.0.1. Generated 2022-10-06
Links: Table of Contents | QA Report | Version History | |