WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build International flag

WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions

Resource Profile: Reason PrEP for HIV prevention was not provided

Official URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/anc-b10-de127 Version: 0.3.0
Draft as of 2024-04-09 Computable Name: ReasonPrEPforHIVpreventionwasnotprovided

Usage:Workflow Task: Risk reduction & general counselling

Why the client was not provided with PrEP

Usage:

Formal Views of Profile Content

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

This structure is derived from ANCMedicationNotRequested

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* ANCMedicationNotRequested Ordering of medication for patient or group
... statusReason S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided Choices (extensible)
... medication[x] S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationRequest.statusReasonextensibleReasonPrEPforHIVpreventionwasnotprovidedChoices
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de128
from this IG
MedicationRequest.medication[x]extensibleReasonPrEPforHIVpreventionwasnotprovided
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de127
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C 0..* ANCMedicationNotRequested Ordering of medication for patient or group
mnr-1: To indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference extension shall be provided
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... rationale S 0..1 markdown Explanation
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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.


Fixed Value: completed
... statusReason S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided Choices (extensible)
... 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Σ 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided (extensible)
.... notDoneValueSet SC 0..1 uri What was not requested
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
... subject SΣ 1..1 Reference(ANC Patient) Who or group medication request is for
... encounter S 0..1 Reference(ANC 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(ANC Practitioner | ANC PractitionerRole | ANC Patient | ANC RelatedPerson) Who/What requested the Request
... recorder S 0..1 Reference(ANC Practitioner | ANC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationRequest.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonextensibleReasonPrEPforHIVpreventionwasnotprovidedChoices
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de128
from this IG
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]extensibleReasonPrEPforHIVpreventionwasnotprovided
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de127
from this IG
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

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()
mnr-1errorMedicationRequestTo indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference extension shall be provided
: medication.extension('http://hl7.org/fhir/StructureDefinition/valueset-reference').exists() xor medication.coding.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C 0..* ANCMedicationNotRequested Ordering of medication for patient or group
mnr-1: To indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 Explanation
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... 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.


Fixed Value: completed
... statusReason S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided Choices (extensible)
... 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Σ 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided (extensible)
.... 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 uri What was not requested
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
.... 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(ANC Patient) Who or group medication request is for
... encounter S 0..1 Reference(ANC 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(ANC Practitioner | ANC PractitionerRole | ANC Patient | ANC 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(ANC Practitioner | ANC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationRequest.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationRequest.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonextensibleReasonPrEPforHIVpreventionwasnotprovidedChoices
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de128
from this IG
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]extensibleReasonPrEPforHIVpreventionwasnotprovided
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de127
from this IG
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

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()
mnr-1errorMedicationRequestTo indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference extension shall be provided
: medication.extension('http://hl7.org/fhir/StructureDefinition/valueset-reference').exists() xor medication.coding.exists()

This structure is derived from ANCMedicationNotRequested

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Differential View

This structure is derived from ANCMedicationNotRequested

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest 0..* ANCMedicationNotRequested Ordering of medication for patient or group
... statusReason S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided Choices (extensible)
... medication[x] S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationRequest.statusReasonextensibleReasonPrEPforHIVpreventionwasnotprovidedChoices
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de128
from this IG
MedicationRequest.medication[x]extensibleReasonPrEPforHIVpreventionwasnotprovided
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de127
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C 0..* ANCMedicationNotRequested Ordering of medication for patient or group
mnr-1: To indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference extension shall be provided
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... rationale S 0..1 markdown Explanation
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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.


Fixed Value: completed
... statusReason S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided Choices (extensible)
... 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Σ 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided (extensible)
.... notDoneValueSet SC 0..1 uri What was not requested
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
... subject SΣ 1..1 Reference(ANC Patient) Who or group medication request is for
... encounter S 0..1 Reference(ANC 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(ANC Practitioner | ANC PractitionerRole | ANC Patient | ANC RelatedPerson) Who/What requested the Request
... recorder S 0..1 Reference(ANC Practitioner | ANC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationRequest.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonextensibleReasonPrEPforHIVpreventionwasnotprovidedChoices
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de128
from this IG
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]extensibleReasonPrEPforHIVpreventionwasnotprovided
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de127
from this IG
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

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()
mnr-1errorMedicationRequestTo indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference extension shall be provided
: medication.extension('http://hl7.org/fhir/StructureDefinition/valueset-reference').exists() xor medication.coding.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest C 0..* ANCMedicationNotRequested Ordering of medication for patient or group
mnr-1: To indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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 Explanation
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... 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.


Fixed Value: completed
... statusReason S 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided Choices (extensible)
... 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Σ 1..1 CodeableConcept Reason PrEP for HIV prevention was not provided
Binding: Reason PrEP for HIV prevention was not provided (extensible)
.... 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 uri What was not requested
URL: http://hl7.org/fhir/StructureDefinition/valueset-reference
.... 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(ANC Patient) Who or group medication request is for
... encounter S 0..1 Reference(ANC 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(ANC Practitioner | ANC PractitionerRole | ANC Patient | ANC 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(ANC Practitioner | ANC 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationRequest.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationRequest.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
from the FHIR Standard
MedicationRequest.statusReasonextensibleReasonPrEPforHIVpreventionwasnotprovidedChoices
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de128
from this IG
MedicationRequest.intentrequiredmedicationRequest Intent
http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
from the FHIR Standard
MedicationRequest.categoryexamplemedicationRequest Category Codes
http://hl7.org/fhir/ValueSet/medicationrequest-category
from the FHIR Standard
MedicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
MedicationRequest.medication[x]extensibleReasonPrEPforHIVpreventionwasnotprovided
http://fhir.org/guides/who/anc-cds/ValueSet/anc-b10-de127
from this IG
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
from the FHIR Standard
MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexampleSubstanceAdminSubstitutionReason
http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason

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()
mnr-1errorMedicationRequestTo indicate what medication was not requested, either at least one coding in the codeableconcept or a valueset-reference extension shall be provided
: medication.extension('http://hl7.org/fhir/StructureDefinition/valueset-reference').exists() xor medication.coding.exists()

This structure is derived from ANCMedicationNotRequested

Summary

Mandatory: 2 elements
Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron