Australian Digital Health Agency FHIR
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/mcv/ and changes regularly. See the Directory of published versions

Resource Profile: ADHAMedicationCore - Detailed Descriptions

Active as of 2024-09-16

Definitions for the dh-medication-core-1 resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Medication
Invariantsinv-dh-med-01: If present, a manufacturer shall at least have a reference, an identifier or a display (manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()))
2. Medication.extension
SlicingThis element introduces a set of slices on Medication.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Medication.extension:brandName
    Slice NamebrandName
    ShortMedication brand name
    Control0..1
    TypeExtension(Medication Brand Name) (Extension Type: string)
    Must Supporttrue
    6. Medication.extension:genericName
    Slice NamegenericName
    ShortMedication generic drug name
    Control0..1
    TypeExtension(Medication Generic Drug Name) (Extension Type: string)
    Must Supporttrue
    8. Medication.manufacturer
    TypeReference(ADHA Core Organization)
    Must Supporttrue
    10. Medication.ingredient
    Must Supporttrue
    Invariantsinv-dh-med-02: If present, an item reference shall at least have a reference or a display ((item as Reference).exists() implies (item as Reference).all($this.reference.exists() or $this.display.exists()))
    12. Medication.ingredient.item[x]
    TypeChoice of: CodeableConcept, Reference(ADHA Core Substance, ADHA Core Medication)
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles

    Guidance on how to interpret the contents of this table can be found here

    0. Medication
    Definition

    This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

    ShortA medication in an Australian healthcare contextDefinition of a Medication
    Control0..*
    Is Modifierfalse
    Summaryfalse
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    inv-dh-med-01: If present, a manufacturer shall at least have a reference, an identifier or a display (manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()))
    2. Medication.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Control0..1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. Medication.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Medication.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. Medication.extension:brandName
      Slice NamebrandName
      Definition

      The brand medication text name for an associated medication, this may be supplied if a coded brand name is not available.

      ShortMedication brand name
      Control0..1
      TypeExtension(Medication Brand Name) (Extension Type: string)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      8. Medication.extension:genericName
      Slice NamegenericName
      Definition

      The generic medication text name for an associated medication. This may not be the same as the subject medication (prescribed, dispensed or stated) but may be used to provide an additional or equivalent drug name that is a generic medication concept.

      ShortMedication generic drug name
      Control0..1
      TypeExtension(Medication Generic Drug Name) (Extension Type: string)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      10. Medication.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Summaryfalse
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      12. Medication.code
      Definition

      A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

      ShortCoding for the medicineCodes that identify this medication
      Comments

      Australian codings are typical medicine/product concept codes.

      A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.


      Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).

      Control10..1
      BindingFor example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes
      (example to http://hl7.org/fhir/ValueSet/medication-codes)
      Additional BindingsPurposeDocumentation
      Australian Medication .Preferred

      This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

      PBS Item CodesPreferred

      This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

      MIMSPreferred

      This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

      GTINPreferred

      This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Obligations
        ObligationsActor
        SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
        SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. Medication.code.coding
        Definition

        A reference to a code defined by a terminology system.

        ShortCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control0..*
        TypeCoding
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Medication.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • pattern @ $this
        • 16. Medication.code.coding.extension:medicationClass
          Slice NamemedicationClass
          Definition

          The type of information covered by the medication coding, e.g. branded product with no strength or form.

          ShortMedication type
          Control0..1
          TypeExtension(Medication Type) (Extension Type: Coding)
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. Medication.code.coding:pbs
          Slice Namepbs
          Definition

          A reference to a code defined by a terminology system.

          ShortCode defined by a terminology system
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control0..*
          BindingThe codes SHALL be taken from For codes, see PBS Item Codes
          (required to http://terminology.hl7.org.au/ValueSet/pbs-item)
          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Obligations
            ObligationsActor
            SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
            SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. Medication.code.coding:pbs.extension:medicationClass
            Slice NamemedicationClass
            Definition

            The type of information covered by the medication coding, e.g. branded product with no strength or form.

            ShortMedication type
            Control0..1
            TypeExtension(Medication Type) (Extension Type: Coding)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            22. Medication.code.coding:amt
            Slice Nameamt
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

            Control0..*
            BindingThe codes SHALL be taken from For codes, see Australian Medication .
            (required to https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1)
            TypeCoding
            Is Modifierfalse
            Must Supporttrue
            Obligations
              ObligationsActor
              SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
              SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
              Summarytrue
              Requirements

              Allows for alternative encodings within a code system, and translations to other code systems.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              24. Medication.code.coding:amt.extension:medicationClass
              Slice NamemedicationClass
              Definition

              The type of information covered by the medication coding, e.g. branded product with no strength or form.

              ShortMedication type
              Control0..1
              TypeExtension(Medication Type) (Extension Type: Coding)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              26. Medication.status
              Definition

              A code to indicate if the medication is in active use.

              Shortactive | inactive | entered-in-error
              Comments

              This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.

              Control0..1
              BindingThe codes SHALL be taken from Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1
              (required to http://hl7.org/fhir/ValueSet/medication-status|4.0.1)

              A coded concept defining if the medication is in active use.

              Typecode
              Is Modifiertrue because This element changes the interpretation of all descriptive attributes.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              28. Medication.manufacturer
              Definition

              Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product it is the manufacturer of the actual physical medicine product.


              Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

              ShortPhysical product manufacturer organisationManufacturer of the item
              Control0..1
              This element is affected by the following invariants: inv-dh-med-01
              TypeReference(ADHA Core Organization, Organization)
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              30. Medication.ingredient
              Definition

              Identifies a particular constituent of interest in the product. Can be coded with AMT.


              Identifies a particular constituent of interest in the product.

              ShortActive or inactive ingredient
              Comments

              The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.

              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              inv-dh-med-02: If present, an item reference shall at least have a reference or a display ((item as Reference).exists() implies (item as Reference).all($this.reference.exists() or $this.display.exists()))
              32. Medication.ingredient.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              34. Medication.ingredient.item[x]
              Definition

              The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

              ShortThe actual ingredient or content
              Control1..1
              This element is affected by the following invariants: inv-dh-med-02
              BindingThe codes SHOULD be taken from For codes, see AMT Medicinal Product and Substances
              (preferred to http://terminology.hl7.org.au/ValueSet/amt-mp-codes)
              TypeChoice of: CodeableConcept, Reference(ADHA Core Substance, ADHA Core Medication, Substance, Medication)
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              Summaryfalse
              Requirements

              The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

              Guidance on how to interpret the contents of this table can be found here

              0. Medication
              Definition

              This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

              ShortA medication in an Australian healthcare context
              Control0..*
              Is Modifierfalse
              Summaryfalse
              Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              inv-dh-med-01: If present, a manufacturer shall at least have a reference, an identifier or a display (manufacturer.exists() implies manufacturer.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists()))
              2. Medication.id
              Definition

              The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

              ShortLogical id of this artifact
              Comments

              The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

              Control0..1
              Typeid
              Is Modifierfalse
              Summarytrue
              4. Medication.meta
              Definition

              The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. Medication.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

              Control0..1
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              8. Medication.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..1
              BindingThe codes SHOULD be taken from CommonLanguages
              (preferred to http://hl7.org/fhir/ValueSet/languages)

              A human language.

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              10. Medication.text
              Definition

              A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

              ShortText summary of the resource, for human interpretation
              Comments

              Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

              Control0..1
              TypeNarrative
              Is Modifierfalse
              Summaryfalse
              Alternate Namesnarrative, html, xhtml, display
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. Medication.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

              Control0..*
              TypeResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              14. Medication.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Medication.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. Medication.extension:brandName
                Slice NamebrandName
                Definition

                The brand medication text name for an associated medication, this may be supplied if a coded brand name is not available.

                ShortMedication brand name
                Control0..1
                TypeExtension(Medication Brand Name) (Extension Type: string)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                18. Medication.extension:genericName
                Slice NamegenericName
                Definition

                The generic medication text name for an associated medication. This may not be the same as the subject medication (prescribed, dispensed or stated) but may be used to provide an additional or equivalent drug name that is a generic medication concept.

                ShortMedication generic drug name
                Control0..1
                TypeExtension(Medication Generic Drug Name) (Extension Type: string)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                20. Medication.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                22. Medication.identifier
                Definition

                Business identifier for this medication.

                ShortBusiness identifier for this medication
                Comments

                The serial number could be included as an identifier.

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. Medication.code
                Definition

                A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

                ShortCoding for the medicine
                Comments

                Australian codings are typical medicine/product concept codes.

                A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.

                Control1..1
                BindingFor example codes, see SNOMEDCTMedicationCodes
                (example to http://hl7.org/fhir/ValueSet/medication-codes)
                Additional BindingsPurposeDocumentation
                Australian Medication .Preferred

                This value set is for use when AMT (Australian Medicines Terminology) codes are preferred.

                PBS Item CodesPreferred

                This value set is for use when PBS (Pharmaceutical Benefits Scheme) item codes are preferred.

                MIMSPreferred

                This value set is for use when MIMS (Monthly Index of Medical Specialties) codes are preferred.

                GTINPreferred

                This value set is for use when GTIN (Global Trade Item Number) codes are preferred.

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Obligations
                  ObligationsActor
                  SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                  SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  26. Medication.code.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  28. Medication.code.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Medication.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 30. Medication.code.coding
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortCode defined by a terminology system
                    Comments

                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                    Control0..*
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on Medication.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • pattern @ $this
                    • 32. Medication.code.coding.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      34. Medication.code.coding.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on Medication.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 36. Medication.code.coding.extension:medicationClass
                        Slice NamemedicationClass
                        Definition

                        The type of information covered by the medication coding, e.g. branded product with no strength or form.

                        ShortMedication type
                        Control0..1
                        TypeExtension(Medication Type) (Extension Type: Coding)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        38. Medication.code.coding.system
                        Definition

                        The identification of the code system that defines the meaning of the symbol in the code.

                        ShortIdentity of the terminology system
                        Comments

                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to be unambiguous about the source of the definition of the symbol.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        40. Medication.code.coding.version
                        Definition

                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                        ShortVersion of the system - if relevant
                        Comments

                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        42. Medication.code.coding.code
                        Definition

                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                        ShortSymbol in syntax defined by the system
                        Control0..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to refer to a particular code in the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        44. Medication.code.coding.display
                        Definition

                        A representation of the meaning of the code in the system, following the rules of the system.

                        ShortRepresentation defined by the system
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        46. Medication.code.coding.userSelected
                        Definition

                        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                        ShortIf this coding was chosen directly by the user
                        Comments

                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                        Control0..1
                        Typeboolean
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        48. Medication.code.coding:pbs
                        Slice Namepbs
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control0..*
                        BindingThe codes SHALL be taken from PBS Item Codes
                        (required to http://terminology.hl7.org.au/ValueSet/pbs-item)
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        Obligations
                          ObligationsActor
                          SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                          SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                          Summarytrue
                          Requirements

                          Allows for alternative encodings within a code system, and translations to other code systems.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          50. Medication.code.coding:pbs.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          52. Medication.code.coding:pbs.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Medication.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 54. Medication.code.coding:pbs.extension:medicationClass
                            Slice NamemedicationClass
                            Definition

                            The type of information covered by the medication coding, e.g. branded product with no strength or form.

                            ShortMedication type
                            Control0..1
                            TypeExtension(Medication Type) (Extension Type: Coding)
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            56. Medication.code.coding:pbs.system
                            Definition

                            The identification of the code system that defines the meaning of the symbol in the code.

                            ShortIdentity of the terminology system
                            Comments

                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                            Control0..1
                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to be unambiguous about the source of the definition of the symbol.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            58. Medication.code.coding:pbs.version
                            Definition

                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                            ShortVersion of the system - if relevant
                            Comments

                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                            NoteThis is a business version Id, not a resource version Id (see discussion)
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            60. Medication.code.coding:pbs.code
                            Definition

                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                            ShortSymbol in syntax defined by the system
                            Control0..1
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to refer to a particular code in the system.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            62. Medication.code.coding:pbs.display
                            Definition

                            A representation of the meaning of the code in the system, following the rules of the system.

                            ShortRepresentation defined by the system
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            64. Medication.code.coding:pbs.userSelected
                            Definition

                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                            ShortIf this coding was chosen directly by the user
                            Comments

                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                            Control0..1
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            66. Medication.code.coding:amt
                            Slice Nameamt
                            Definition

                            A reference to a code defined by a terminology system.

                            ShortCode defined by a terminology system
                            Comments

                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                            Control0..*
                            BindingThe codes SHALL be taken from Australian Medication .
                            (required to https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1)
                            TypeCoding
                            Is Modifierfalse
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              SHALL:populate-if-knownhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder
                              SHALL:no-errorhttp://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester
                              Summarytrue
                              Requirements

                              Allows for alternative encodings within a code system, and translations to other code systems.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              68. Medication.code.coding:amt.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              70. Medication.code.coding:amt.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on Medication.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 72. Medication.code.coding:amt.extension:medicationClass
                                Slice NamemedicationClass
                                Definition

                                The type of information covered by the medication coding, e.g. branded product with no strength or form.

                                ShortMedication type
                                Control0..1
                                TypeExtension(Medication Type) (Extension Type: Coding)
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                74. Medication.code.coding:amt.system
                                Definition

                                The identification of the code system that defines the meaning of the symbol in the code.

                                ShortIdentity of the terminology system
                                Comments

                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                Control0..1
                                Typeuri
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to be unambiguous about the source of the definition of the symbol.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                76. Medication.code.coding:amt.version
                                Definition

                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                ShortVersion of the system - if relevant
                                Comments

                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                78. Medication.code.coding:amt.code
                                Definition

                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                ShortSymbol in syntax defined by the system
                                Control0..1
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to refer to a particular code in the system.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                80. Medication.code.coding:amt.display
                                Definition

                                A representation of the meaning of the code in the system, following the rules of the system.

                                ShortRepresentation defined by the system
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                82. Medication.code.coding:amt.userSelected
                                Definition

                                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                ShortIf this coding was chosen directly by the user
                                Comments

                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                Control0..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                84. Medication.code.text
                                Definition

                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. This may be a brand or generic name as suitable for the intent of the entry.

                                ShortMedication primary text
                                Comments

                                Very often the text is the same as a displayName of one of the codings.

                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                86. Medication.status
                                Definition

                                A code to indicate if the medication is in active use.

                                Shortactive | inactive | entered-in-error
                                Comments

                                This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.

                                Control0..1
                                BindingThe codes SHALL be taken from Medication Status Codes
                                (required to http://hl7.org/fhir/ValueSet/medication-status|4.0.1)

                                A coded concept defining if the medication is in active use.

                                Typecode
                                Is Modifiertrue because This element changes the interpretation of all descriptive attributes.
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                88. Medication.manufacturer
                                Definition

                                Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product it is the manufacturer of the actual physical medicine product.

                                ShortPhysical product manufacturer organisation
                                Control0..1
                                This element is affected by the following invariants: inv-dh-med-01
                                TypeReference(ADHA Core Organization)
                                Is Modifierfalse
                                Must Supporttrue
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                90. Medication.form
                                Definition

                                Describes the form of the item. Powder; tablets; capsule.

                                Shortpowder | tablets | capsule +
                                Comments

                                When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.

                                Control0..1
                                BindingThe codes SHOULD be taken from Medication Form .
                                (preferred to https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1)
                                TypeCodeableConcept
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                92. Medication.amount
                                Definition

                                Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

                                ShortAmount of drug in package
                                Control0..1
                                TypeRatio
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                94. Medication.ingredient
                                Definition

                                Identifies a particular constituent of interest in the product. Can be coded with AMT.

                                ShortActive or inactive ingredient
                                Comments

                                The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.

                                Control0..*
                                TypeBackboneElement
                                Is Modifierfalse
                                Must Supporttrue
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                inv-dh-med-02: If present, an item reference shall at least have a reference or a display ((item as Reference).exists() implies (item as Reference).all($this.reference.exists() or $this.display.exists()))
                                96. Medication.ingredient.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                98. Medication.ingredient.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                100. Medication.ingredient.modifierExtension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                102. Medication.ingredient.item[x]
                                Definition

                                The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

                                ShortThe actual ingredient or content
                                Control1..1
                                This element is affected by the following invariants: inv-dh-med-02
                                BindingThe codes SHOULD be taken from AMT Medicinal Product and Substances
                                (preferred to http://terminology.hl7.org.au/ValueSet/amt-mp-codes)
                                TypeChoice of: CodeableConcept, Reference(ADHA Core Substance, ADHA Core Medication)
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Must Supporttrue
                                Must Support TypesNo must-support rules about the choice of types/profiles
                                Summaryfalse
                                Requirements

                                The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                104. Medication.ingredient.isActive
                                Definition

                                Indication of whether this ingredient affects the therapeutic action of the drug.

                                ShortActive ingredient indicator
                                Control0..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Requirements

                                True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                106. Medication.ingredient.strength
                                Definition

                                Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

                                ShortQuantity/strength of ingredient present
                                Control0..1
                                TypeRatio
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                108. Medication.batch
                                Definition

                                Information that only applies to packages (not products).

                                ShortDetails about packaged medications
                                Control0..1
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                110. Medication.batch.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                112. Medication.batch.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                114. Medication.batch.modifierExtension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                116. Medication.batch.lotNumber
                                Definition

                                The assigned lot number of a batch of the specified product.

                                ShortIdentifier assigned to batch
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                118. Medication.batch.expirationDate
                                Definition

                                When this specific batch of product will expire.

                                ShortWhen batch will expire
                                Control0..1
                                TypedateTime
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))