AU Base Implementation Guide
5.0.1-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Medication Request

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medicationrequest Version: 5.0.1-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUBaseMedicationRequest

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a medication request structure that localises core concepts, including identifiers and terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

  • When identifying a medication, this resource can use either a code or refer to a Medication resource.
  • If making use of MedicationRequest.code, this profile includes coding as:
  • If a medication is compounded and is a list of ingredients, MedicationRequest.code is still present and may contain only the list of ingredients as text in MedicationRequest.code.text.
  • Where additional medicinal product information is needed, MedicationRequest.medicationReference is preferred to MedicationRequest.code and use of extensions, see guidance on AU Base Medication.
  • See each Identifier profile page for guidance related to that identifier type.

Potentially useful extensions:

Usage:

Changes since version 5.0.0:

  • No changes

    • 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..* MedicationRequest A request for a medication for a patient in an Australian healthcare context
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
    URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
    Binding: Concurrent Supply Grounds . (required)
    ... identifier 0..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
    ... Slices for medication[x] 1..1 CodeableConcept, Reference(Medication) Medication to be taken
    Slice: Unordered, Closed by type:$this
    .... medication[x]:medicationCodeableConcept 0..1 CodeableConcept Coded Prescribed Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    ..... coding
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ....... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ..... text 0..1 string Medication primary text
    .... medication[x]:medicationReference 0..1 Reference(Medication) Prescribed Medication
    .... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
    .... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
    ... authoredOn 0..1 dateTime Created date
    ... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
    Binding: Reason for Request . (preferred)
    ... dosageInstruction 0..* AUBaseDosage How the medication should be taken
    ... dispenseRequest 0..1 BackboneElement Requested dispensing
    .... numberOfRepeatsAllowed 0..1 unsignedInt Maximum repeats authorised
    ... substitution 0..1 BackboneElement Brand substitution details
    .... allowed[x] 1..1 boolean, CodeableConcept Brand substitution flag
    .... reason 0..1 CodeableConcept Why should (not) substitution be made
    Binding: Medicine Substitution Reason . (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    MedicationRequest.reasonCodepreferredReasonForRequest .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
    MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
    https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. MedicationRequest 0..* MedicationRequest A request for a medication for a patient in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
    URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
    Binding: Concurrent Supply Grounds . (required)
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... status ?!Σ 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.


    ele-1: All FHIR elements must have a @value or children
    ... intent ?!Σ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
    Binding: medicationRequest Intent (required): The kind of medication order.


    ele-1: All FHIR elements must have a @value or children
    ... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
    ele-1: All FHIR elements must have a @value or children
    ... Slices for medication[x] Σ 1..1 Medication to be taken
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.


    ele-1: All FHIR elements must have a @value or children
    .... medicationCodeableConcept CodeableConcept
    .... medicationReference Reference(Medication)
    .... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred

    ele-1: All FHIR elements must have a @value or children
    ..... text Σ 0..1 string Medication primary text
    ele-1: All FHIR elements must have a @value or children
    .... medication[x]:medicationReference Σ 0..1 Reference(Medication) Prescribed Medication
    ele-1: All FHIR elements must have a @value or children
    ... subject Σ 1..1 Reference(Patient | Group) Who or group medication request is for
    ele-1: All FHIR elements must have a @value or children
    ... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
    Slice: Unordered, Open by profile:resolve()
    ele-1: All FHIR elements must have a @value or children
    .... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
    ele-1: All FHIR elements must have a @value or children
    .... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
    ele-1: All FHIR elements must have a @value or children
    ... authoredOn Σ 0..1 dateTime Created date
    ele-1: All FHIR elements must have a @value or children
    ... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
    Binding: Reason for Request . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... dosageInstruction 0..* AUBaseDosage How the medication should be taken
    ele-1: All FHIR elements must have a @value or children
    ... dispenseRequest 0..1 BackboneElement Requested dispensing
    ele-1: All FHIR elements must have a @value or children
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... numberOfRepeatsAllowed 0..1 unsignedInt Maximum repeats authorised
    ele-1: All FHIR elements must have a @value or children
    ... substitution 0..1 BackboneElement Brand substitution details
    ele-1: All FHIR elements must have a @value or children
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... allowed[x] 1..1 Brand substitution flag
    Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.


    ele-1: All FHIR elements must have a @value or children
    ..... allowedBoolean boolean
    ..... allowedCodeableConcept CodeableConcept
    .... reason 0..1 CodeableConcept Why should (not) substitution be made
    Binding: Medicine Substitution Reason . (preferred)
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    MedicationRequest.statusrequiredmedicationrequest Status
    http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
    from the FHIR Standard
    MedicationRequest.intentrequiredmedicationRequest Intent
    http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
    from the FHIR Standard
    MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.reasonCodepreferredReasonForRequest .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
    MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
    http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
    MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
    https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

    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..* MedicationRequest A request for a medication for a patient in an Australian healthcare context
    ... 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
    .... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
    URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
    Binding: Concurrent Supply Grounds . (required)
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier 0..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
    ... status ?!Σ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
    Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

    ... statusReason 0..1 CodeableConcept Reason for current status
    Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

    ... intent ?!Σ 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 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)
    ... Slices for medication[x] Σ 1..1 Medication to be taken
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

    .... medicationCodeableConcept CodeableConcept
    .... medicationReference Reference(Medication)
    .... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 0..* Coding Code defined by a terminology system
    ...... id 0..1 string Unique id for inter-element referencing
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ....... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ...... system Σ 0..1 uri Identity of the terminology system
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 0..1 string Medication primary text
    .... medication[x]:medicationReference Σ 0..1 Reference(Medication) Prescribed 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
    ... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
    Slice: Unordered, Open by profile:resolve()
    .... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
    .... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
    ... authoredOn Σ 0..1 dateTime Created date
    ... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) 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 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
    ... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
    Binding: Reason for Request . (preferred)
    ... 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 Σ 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..* AUBaseDosage How the medication should be taken
    ... dispenseRequest 0..1 BackboneElement Requested dispensing
    .... 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 Maximum repeats authorised
    .... 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 Brand substitution 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
    .... allowed[x] 1..1 Brand substitution flag
    Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

    ..... allowedBoolean boolean
    ..... allowedCodeableConcept CodeableConcept
    .... reason 0..1 CodeableConcept Why should (not) substitution be made
    Binding: Medicine Substitution Reason . (preferred)
    ... 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

    PathConformanceValueSetURI
    MedicationRequest.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    MedicationRequest.statusrequiredmedicationrequest Status
    http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
    from the FHIR Standard
    MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
    http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
    from the FHIR Standard
    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]exampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
    http://hl7.org/fhir/ValueSet/performer-role
    from the FHIR Standard
    MedicationRequest.reasonCodepreferredReasonForRequest .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
    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.reasonpreferredMedicineSubstitutionReason .
    https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

    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

    Structures

    This structure refers to these other structures:

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of MedicationRequest.medication[x] (Closed)
    • The element 1 is sliced based on the value of MedicationRequest.supportingInformation

    Maturity: 2

    Differential View

    This structure is derived from MedicationRequest

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. MedicationRequest 0..* MedicationRequest A request for a medication for a patient in an Australian healthcare context
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
    URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
    Binding: Concurrent Supply Grounds . (required)
    ... identifier 0..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
    ... Slices for medication[x] 1..1 CodeableConcept, Reference(Medication) Medication to be taken
    Slice: Unordered, Closed by type:$this
    .... medication[x]:medicationCodeableConcept 0..1 CodeableConcept Coded Prescribed Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    ..... coding
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ....... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ..... text 0..1 string Medication primary text
    .... medication[x]:medicationReference 0..1 Reference(Medication) Prescribed Medication
    .... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
    .... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
    ... authoredOn 0..1 dateTime Created date
    ... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
    Binding: Reason for Request . (preferred)
    ... dosageInstruction 0..* AUBaseDosage How the medication should be taken
    ... dispenseRequest 0..1 BackboneElement Requested dispensing
    .... numberOfRepeatsAllowed 0..1 unsignedInt Maximum repeats authorised
    ... substitution 0..1 BackboneElement Brand substitution details
    .... allowed[x] 1..1 boolean, CodeableConcept Brand substitution flag
    .... reason 0..1 CodeableConcept Why should (not) substitution be made
    Binding: Medicine Substitution Reason . (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    MedicationRequest.reasonCodepreferredReasonForRequest .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
    MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
    https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. MedicationRequest 0..* MedicationRequest A request for a medication for a patient in an Australian healthcare context
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-3: 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
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    dom-6: A resource should have narrative for robust management
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ele-1: All FHIR elements must have a @value or children
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
    URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
    Binding: Concurrent Supply Grounds . (required)
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    ... status ?!Σ 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.


    ele-1: All FHIR elements must have a @value or children
    ... intent ?!Σ 1..1 code proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
    Binding: medicationRequest Intent (required): The kind of medication order.


    ele-1: All FHIR elements must have a @value or children
    ... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
    ele-1: All FHIR elements must have a @value or children
    ... Slices for medication[x] Σ 1..1 Medication to be taken
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.


    ele-1: All FHIR elements must have a @value or children
    .... medicationCodeableConcept CodeableConcept
    .... medicationReference Reference(Medication)
    .... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred

    ele-1: All FHIR elements must have a @value or children
    ..... text Σ 0..1 string Medication primary text
    ele-1: All FHIR elements must have a @value or children
    .... medication[x]:medicationReference Σ 0..1 Reference(Medication) Prescribed Medication
    ele-1: All FHIR elements must have a @value or children
    ... subject Σ 1..1 Reference(Patient | Group) Who or group medication request is for
    ele-1: All FHIR elements must have a @value or children
    ... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
    Slice: Unordered, Open by profile:resolve()
    ele-1: All FHIR elements must have a @value or children
    .... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
    ele-1: All FHIR elements must have a @value or children
    .... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
    ele-1: All FHIR elements must have a @value or children
    ... authoredOn Σ 0..1 dateTime Created date
    ele-1: All FHIR elements must have a @value or children
    ... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
    Binding: Reason for Request . (preferred)
    ele-1: All FHIR elements must have a @value or children
    ... dosageInstruction 0..* AUBaseDosage How the medication should be taken
    ele-1: All FHIR elements must have a @value or children
    ... dispenseRequest 0..1 BackboneElement Requested dispensing
    ele-1: All FHIR elements must have a @value or children
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... numberOfRepeatsAllowed 0..1 unsignedInt Maximum repeats authorised
    ele-1: All FHIR elements must have a @value or children
    ... substitution 0..1 BackboneElement Brand substitution details
    ele-1: All FHIR elements must have a @value or children
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    ele-1: All FHIR elements must have a @value or children
    ext-1: Must have either extensions or value[x], not both
    .... allowed[x] 1..1 Brand substitution flag
    Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.


    ele-1: All FHIR elements must have a @value or children
    ..... allowedBoolean boolean
    ..... allowedCodeableConcept CodeableConcept
    .... reason 0..1 CodeableConcept Why should (not) substitution be made
    Binding: Medicine Substitution Reason . (preferred)
    ele-1: All FHIR elements must have a @value or children

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    MedicationRequest.statusrequiredmedicationrequest Status
    http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
    from the FHIR Standard
    MedicationRequest.intentrequiredmedicationRequest Intent
    http://hl7.org/fhir/ValueSet/medicationrequest-intent|4.0.1
    from the FHIR Standard
    MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.reasonCodepreferredReasonForRequest .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
    MedicationRequest.substitution.allowed[x]exampleActSubstanceAdminSubstitutionCode
    http://terminology.hl7.org/ValueSet/v3-ActSubstanceAdminSubstitutionCode
    MedicationRequest.substitution.reasonpreferredMedicineSubstitutionReason .
    https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

    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..* MedicationRequest A request for a medication for a patient in an Australian healthcare context
    ... 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
    .... extension:subsidisedConcurrentSupply 0..1 Coding Grounds for concurrent supply of medication
    URL: http://hl7.org.au/fhir/StructureDefinition/subsidised-concurrent-supply
    Binding: Concurrent Supply Grounds . (required)
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier 0..* Identifier, AUETPPrescriptionIdentifier, AULocalPrescriptionIdentifier External ids for this request
    ... status ?!Σ 1..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
    Binding: medicationrequest Status (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.

    ... statusReason 0..1 CodeableConcept Reason for current status
    Binding: medicationRequest Status Reason Codes (example): Identifies the reasons for a given status.

    ... intent ?!Σ 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 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)
    ... Slices for medication[x] Σ 1..1 Medication to be taken
    Slice: Unordered, Closed by type:$this
    Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered.

    .... medicationCodeableConcept CodeableConcept
    .... medicationReference Reference(Medication)
    .... medication[x]:medicationCodeableConcept Σ 0..1 CodeableConcept Coded Prescribed Medication
    Binding: SNOMEDCTMedicationCodes (example)
    Additional BindingsPurpose
    Australian Medication . Preferred
    PBS Item Codes Preferred
    MIMS Preferred
    GTIN Preferred
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... coding Σ 0..* Coding Code defined by a terminology system
    ...... id 0..1 string Unique id for inter-element referencing
    ...... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ....... extension:medicationClass 0..1 Coding Medication type
    URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
    Binding: Medication Type (required)
    ...... system Σ 0..1 uri Identity of the terminology system
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... text Σ 0..1 string Medication primary text
    .... medication[x]:medicationReference Σ 0..1 Reference(Medication) Prescribed 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
    ... Slices for supportingInformation 0..* Reference(Resource) Information to support ordering of the medication
    Slice: Unordered, Open by profile:resolve()
    .... supportingInformation:bodyHeight 0..1 Reference(Observation Body Height Profile) Observation of Body Height
    .... supportingInformation:bodyWeight 0..1 Reference(Observation Body Weight Profile) Observation of Body Weight
    ... authoredOn Σ 0..1 dateTime Created date
    ... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) 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 0..1 Reference(Practitioner | PractitionerRole) Person who entered the request
    ... reasonCode 0..* CodeableConcept Reason or indication for ordering or not ordering the medication
    Binding: Reason for Request . (preferred)
    ... 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 Σ 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..* AUBaseDosage How the medication should be taken
    ... dispenseRequest 0..1 BackboneElement Requested dispensing
    .... 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 Maximum repeats authorised
    .... 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 Brand substitution 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
    .... allowed[x] 1..1 Brand substitution flag
    Binding: ActSubstanceAdminSubstitutionCode (example): Identifies the type of substitution allowed.

    ..... allowedBoolean boolean
    ..... allowedCodeableConcept CodeableConcept
    .... reason 0..1 CodeableConcept Why should (not) substitution be made
    Binding: Medicine Substitution Reason . (preferred)
    ... 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

    PathConformanceValueSetURI
    MedicationRequest.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    MedicationRequest.statusrequiredmedicationrequest Status
    http://hl7.org/fhir/ValueSet/medicationrequest-status|4.0.1
    from the FHIR Standard
    MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
    http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
    from the FHIR Standard
    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]exampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.medication[x]:medicationCodeableConceptexampleSNOMEDCTMedicationCodes
    http://hl7.org/fhir/ValueSet/medication-codes
    from the FHIR Standard
    MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
    http://hl7.org/fhir/ValueSet/performer-role
    from the FHIR Standard
    MedicationRequest.reasonCodepreferredReasonForRequest .
    https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
    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.reasonpreferredMedicineSubstitutionReason .
    https://healthterminologies.gov.au/fhir/ValueSet/medicine-substitution-reason-1

    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

    Structures

    This structure refers to these other structures:

    Extensions

    This structure refers to these extensions:

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of MedicationRequest.medication[x] (Closed)
    • The element 1 is sliced based on the value of MedicationRequest.supportingInformation

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron