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

Australian Digital Health Agency FHIR Implementation Guide, 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/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ADHAListPractitionerMedicineReview - Detailed Descriptions

Draft as of 2024-09-12

Definitions for the dh-list-medication-use-pmr-1 resource profile.

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

0. List
Definition

A list of medicines at a point in time that describes medicine item use for an individual from a practitioner medicines review e.g. Pharmacist Shared Medicines List. The list may be partial, or complete, and may be a history or scoped to may be taking the medication now or has taken the medication in the past or will be taking the medication in the future.

ShortA list of medicine items for a patient at a point in time from a medicines review
Invariantsinv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 (encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2'))
2. List.extension
SlicingThis element introduces a set of slices on List.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. List.extension:sourceRelatedPerson
    Slice NamesourceRelatedPerson
    Control0..0
    This element is affected by the following invariants: ele-1, inv-dh-lst-01, inv-dh-lst-03
    TypeExtension(Author as a RelatedPerson) (Extension Type: Reference(RelatedPerson))
    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())
    6. List.extension:packed-in-daa
    Slice Namepacked-in-daa
    Control0..1
    TypeExtension(Medicines Packed in Dose Administration Aid Indicator) (Extension Type: CodeableConcept)
    Must Supporttrue
    8. List.title
    Control1..?
    10. List.encounter
    Control1..?
    12. List.source
    Control1..?
    TypeReference(ADHA Authoring PractitionerRole)
    14. List.entry
    ShortMedicine item information, may include change information
    16. List.entry.flag
    BindingThe codes SHALL be taken from Medicine Item Change from Practitioner Medicines Review .
    (required to https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2)

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

    0. List
    Definition

    A list of medicines at a point in time that describes medicine item use for an individual from a practitioner medicines review e.g. Pharmacist Shared Medicines List. The list may be partial, or complete, and may be a history or scoped to may be taking the medication now or has taken the medication in the past or will be taking the medication in the future.


    A list is a curated collection of resources.

    ShortA list of medicine items for a patient at a point in time from a medicines reviewA list is a curated collection of resources
    Control0..*
    Is Modifierfalse
    Summaryfalse
    Alternate NamesCollection, WorkingList, Organizer
    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())
    lst-1: A list can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
    lst-2: The deleted flag can only be used if the mode of the list is "changes" (mode = 'changes' or entry.deleted.empty())
    lst-3: An entry date can only be used if the mode of the list is "working" (mode = 'working' or entry.date.empty())
    inv-dh-lst-01: The list shall have at least a source or a source relating person (source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists())
    inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier (source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()))
    inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier (extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists())
    inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 (encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2'))
    lst-1: A list can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
    lst-2: The deleted flag can only be used if the mode of the list is "changes" (mode = 'changes' or entry.deleted.empty())
    lst-3: An entry date can only be used if the mode of the list is "working" (mode = 'working' or entry.date.empty())
    2. List.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. List.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 List.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. List.extension:sourceRelatedPerson
      Slice NamesourceRelatedPerson
      Definition

      Reference to related person that authored the resource and takes responsibility for its content.

      ShortRelated person that authored the resource
      Control0..0
      This element is affected by the following invariants: ele-1, inv-dh-lst-01, inv-dh-lst-03
      TypeExtension(Author as a RelatedPerson) (Extension Type: Reference(RelatedPerson))
      Is Modifierfalse
      Must Supporttrue
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      8. List.extension:packed-in-daa
      Slice Namepacked-in-daa
      Definition

      Indicates whether one or more items in a medicines list are packed in a Dose Administration Aid (DAA).

      ShortInclusion of medicines packed in a Dose Administration Aid (DAA) indicator
      Control0..1
      TypeExtension(Medicines Packed in Dose Administration Aid Indicator) (Extension Type: CodeableConcept)
      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. List.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. List.identifier
      Definition

      Identifier for the List assigned for business purposes outside the context of FHIR.

      ShortBusiness identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      14. List.status
      Definition

      Indicates the current state of this list.

      Shortcurrent | retired | entered-in-error
      Comments

      This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

      Control1..1
      BindingThe codes SHALL be taken from ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/list-status|4.0.1)

      The current state of the list.

      Typecode
      Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Pattern Valuecurrent
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. List.mode
      Definition

      How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

      Shortworking | snapshot | changes
      Comments

      This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

      Control1..1
      BindingThe codes SHALL be taken from ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1
      (required to http://hl7.org/fhir/ValueSet/list-mode|4.0.1)

      The processing mode that applies to this list.

      Typecode
      Is Modifiertrue because If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Lists are used in various ways, and it must be known in what way it is safe to use them.

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

      A label for the list assigned by the author.

      ShortDescriptive name for the list
      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Allows customization beyond just the code identifying the kind of list.

      Example<br/><b>General</b>:Dr. Jane's Patients
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. List.code
      Definition

      This code defines the purpose of the list - why it was created.

      ShortWhat the purpose of this list is
      Comments

      If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.

      Control10..1
      BindingThe codes SHALL be taken from For example codes, see History Of Medication Use List Type .http://hl7.org/fhir/ValueSet/list-example-codes
      (required to https://healthterminologies.gov.au/fhir/ValueSet/history-of-medication-use-list-type-1)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.

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

      The common subject (or patient) of the resources that are in the list if there is one.

      ShortIf all resources have the same subject
      Comments

      Some purely arbitrary lists do not have a common subject, so this is optional.

      Control10..1
      This element is affected by the following invariants: inv-dh-lst-04
      TypeReference(ADHA Core Patient, Patient, Group, Device, Location)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      The primary purpose of listing the subject explicitly is to help with finding the right list.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      inv-dh-lst-04: At least reference or a valid identifier shall be present (reference.exists() or identifier.where(system.count() + value.count() >1).exists())
      24. List.encounter
      Definition

      The encounter that is the context in which this list was created.

      ShortContext in which list created
      Control10..1
      TypeReference(ADHA Core Encounter, Encounter)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. List.date
      Definition

      The date that the list was prepared.

      ShortWhen the list was prepared
      Comments

      The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.

      Control10..1
      This element is affected by the following invariants: inv-dh-lst-06
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Requirements

      Identifies how current the list is which affects relevance.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      inv-dh-lst-06: Date shall be at least to day (toString().length() >= 10)
      28. List.source
      Definition

      The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

      ShortWho and/or what defined the list contents (aka Author)
      Comments

      The primary source is the entity that made the decisions what items are in the list. This may be software or user.

      Control10..1
      This element is affected by the following invariants: inv-dh-lst-01, inv-dh-lst-02
      TypeReference(ADHA Authoring PractitionerRole, Practitioner, PractitionerRole, Patient, Device)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Allows follow-up as well as context.

      Alternate NamesAuthor
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. List.note
      Definition

      Comments that apply to the overall list.

      ShortComments about the list
      Control0..*
      TypeAnnotation
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. List.entry
      Definition

      Entries in this list.

      ShortMedicine item information, may include change informationEntries in the list
      Comments

      If there are no entries in the list, an emptyReason SHOULD be provided.

      Control0..*
      This element is affected by the following invariants: lst-1
      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-lst-05: All observations shall conform to ADHA Simple Observation (item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1'))
      34. List.entry.extension:changeDescription
      Slice NamechangeDescription
      Definition

      Description of a change including the reason for change.

      ShortDescription of the change to medicine item use
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Change Description) (Extension Type: string)
      Is Modifierfalse
      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())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      36. List.entry.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())
      38. List.entry.flag
      Definition

      The flag allows the system constructing the list to indicate the role and significance of the item in the list.

      ShortStatus/Workflow information about this item
      Comments

      The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is "changes".

      Control0..1
      BindingThe codes SHALL be taken from For example codes, see Medicine Item Change from Practitioner Medicines Review .http://hl7.org/fhir/ValueSet/list-item-flag
      (required to https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.

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

      True if this item is marked as deleted in the list.

      ShortIf this item is actually marked as deleted
      Comments

      If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.

      Control0..1
      This element is affected by the following invariants: lst-2
      Typeboolean
      Is Modifiertrue because If deleted is true, then the item included in the list isn't actually part of the list anymore
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Requirements

      The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted".

      Meaning if MissingList items are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes'
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. List.entry.item
      Definition

      A reference to the actual resource from which data was derived.

      ShortActual entry
      Control1..1
      This element is affected by the following invariants: inv-dh-lst-05
      TypeReference(ADHA Core MedicationStatement, AU Assertion of No Relevant Finding, Resource)
      Is Modifierfalse
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. List.entry.item.reference
      Definition

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      ShortLiteral reference, Relative, internal or absolute URL
      Comments

      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Control10..1
      This element is affected by the following invariants: ref-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()))
      46. List.emptyReason
      Definition

      If the list is empty, why the list is empty.

      ShortWhy list is empty
      Comments

      The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

      Control0..1
      This element is affected by the following invariants: lst-1
      BindingThe codes SHALL be taken from The codes SHOULD be taken from Non-Clinical Empty Reason .http://hl7.org/fhir/ValueSet/list-empty-reason
      (required to https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Requirements

      Allows capturing things like "none exist" or "not asked" which can be important for most lists.

      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. List
      Definition

      A list of medicines at a point in time that describes medicine item use for an individual from a practitioner medicines review e.g. Pharmacist Shared Medicines List. The list may be partial, or complete, and may be a history or scoped to may be taking the medication now or has taken the medication in the past or will be taking the medication in the future.

      ShortA list of medicine items for a patient at a point in time from a medicines review
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Alternate NamesCollection, WorkingList, Organizer
      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())
      lst-1: A list can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
      lst-2: The deleted flag can only be used if the mode of the list is "changes" (mode = 'changes' or entry.deleted.empty())
      lst-3: An entry date can only be used if the mode of the list is "working" (mode = 'working' or entry.date.empty())
      inv-dh-lst-01: The list shall have at least a source or a source relating person (source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists())
      inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier (source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists()))
      inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier (extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists())
      inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 (encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2'))
      2. List.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. List.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. List.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. List.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. List.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. List.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. List.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 List.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. List.extension:sourceRelatedPerson
        Slice NamesourceRelatedPerson
        Definition

        Reference to related person that authored the resource and takes responsibility for its content.

        ShortRelated person that authored the resource
        Control0..0
        This element is affected by the following invariants: ele-1, inv-dh-lst-01, inv-dh-lst-03
        TypeExtension(Author as a RelatedPerson) (Extension Type: Reference(RelatedPerson))
        Is Modifierfalse
        Must Supporttrue
        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. List.extension:packed-in-daa
        Slice Namepacked-in-daa
        Definition

        Indicates whether one or more items in a medicines list are packed in a Dose Administration Aid (DAA).

        ShortInclusion of medicines packed in a Dose Administration Aid (DAA) indicator
        Control0..1
        TypeExtension(Medicines Packed in Dose Administration Aid Indicator) (Extension Type: CodeableConcept)
        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. List.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. List.identifier
        Definition

        Identifier for the List assigned for business purposes outside the context of FHIR.

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

        Indicates the current state of this list.

        Shortcurrent | retired | entered-in-error
        Comments

        This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

        Control1..1
        BindingThe codes SHALL be taken from ListStatus
        (required to http://hl7.org/fhir/ValueSet/list-status|4.0.1)

        The current state of the list.

        Typecode
        Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Pattern Valuecurrent
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. List.mode
        Definition

        How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

        Shortworking | snapshot | changes
        Comments

        This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

        Control1..1
        BindingThe codes SHALL be taken from ListMode
        (required to http://hl7.org/fhir/ValueSet/list-mode|4.0.1)

        The processing mode that applies to this list.

        Typecode
        Is Modifiertrue because If set to "changes", the list is considered incomplete, while the other two codes indicate the list is complete, which changes the understanding of the elements listed
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Lists are used in various ways, and it must be known in what way it is safe to use them.

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

        A label for the list assigned by the author.

        ShortDescriptive name for the list
        Control1..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Allows customization beyond just the code identifying the kind of list.

        Example<br/><b>General</b>:Dr. Jane's Patients
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. List.code
        Definition

        This code defines the purpose of the list - why it was created.

        ShortWhat the purpose of this list is
        Comments

        If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.

        Control1..1
        BindingThe codes SHALL be taken from History Of Medication Use List Type .
        (required to https://healthterminologies.gov.au/fhir/ValueSet/history-of-medication-use-list-type-1)
        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.

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

        The common subject (or patient) of the resources that are in the list if there is one.

        ShortIf all resources have the same subject
        Comments

        Some purely arbitrary lists do not have a common subject, so this is optional.

        Control1..1
        This element is affected by the following invariants: inv-dh-lst-04
        TypeReference(ADHA Core Patient)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        The primary purpose of listing the subject explicitly is to help with finding the right list.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-dh-lst-04: At least reference or a valid identifier shall be present (reference.exists() or identifier.where(system.count() + value.count() >1).exists())
        34. List.encounter
        Definition

        The encounter that is the context in which this list was created.

        ShortContext in which list created
        Control1..1
        TypeReference(ADHA Core Encounter)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. List.date
        Definition

        The date that the list was prepared.

        ShortWhen the list was prepared
        Comments

        The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.

        Control1..1
        This element is affected by the following invariants: inv-dh-lst-06
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        Identifies how current the list is which affects relevance.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        inv-dh-lst-06: Date shall be at least to day (toString().length() >= 10)
        38. List.source
        Definition

        The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

        ShortWho and/or what defined the list contents (aka Author)
        Comments

        The primary source is the entity that made the decisions what items are in the list. This may be software or user.

        Control1..1
        This element is affected by the following invariants: inv-dh-lst-01, inv-dh-lst-02
        TypeReference(ADHA Authoring PractitionerRole)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Allows follow-up as well as context.

        Alternate NamesAuthor
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. List.orderedBy
        Definition

        What order applies to the items in the list.

        ShortWhat order the list has
        Comments

        Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

        Control0..1
        BindingThe codes SHOULD be taken from ListOrderCodes
        (preferred to http://hl7.org/fhir/ValueSet/list-order)

        What order applies to the items in a list.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

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

        Comments that apply to the overall list.

        ShortComments about the list
        Control0..*
        TypeAnnotation
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. List.entry
        Definition

        Entries in this list.

        ShortMedicine item information, may include change information
        Comments

        If there are no entries in the list, an emptyReason SHOULD be provided.

        Control0..*
        This element is affected by the following invariants: lst-1
        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-lst-05: All observations shall conform to ADHA Simple Observation (item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1'))
        46. List.entry.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
        48. List.entry.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 List.entry.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 50. List.entry.extension:changeDescription
          Slice NamechangeDescription
          Definition

          Description of a change including the reason for change.

          ShortDescription of the change to medicine item use
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Change Description) (Extension Type: string)
          Is Modifierfalse
          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())
          52. List.entry.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())
          54. List.entry.flag
          Definition

          The flag allows the system constructing the list to indicate the role and significance of the item in the list.

          ShortStatus/Workflow information about this item
          Comments

          The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is "changes".

          Control0..1
          BindingThe codes SHALL be taken from Medicine Item Change from Practitioner Medicines Review .
          (required to https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2)
          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Requirements

          This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.

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

          True if this item is marked as deleted in the list.

          ShortIf this item is actually marked as deleted
          Comments

          If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list.

          Control0..1
          This element is affected by the following invariants: lst-2
          Typeboolean
          Is Modifiertrue because If deleted is true, then the item included in the list isn't actually part of the list anymore
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Requirements

          The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted".

          Meaning if MissingList items are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes'
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          58. List.entry.date
          Definition

          When this item was added to the list.

          ShortWhen item added to list
          Control0..1
          TypedateTime
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Requirements

          The date may be significant for understanding the meaning of items in a working list.

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

          A reference to the actual resource from which data was derived.

          ShortActual entry
          Control1..1
          This element is affected by the following invariants: inv-dh-lst-05
          TypeReference(ADHA Core MedicationStatement, AU Assertion of No Relevant Finding)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          62. List.entry.item.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
          64. List.entry.item.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 List.entry.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 66. List.entry.item.reference
            Definition

            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

            ShortLiteral reference, Relative, internal or absolute URL
            Comments

            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

            Control1..1
            This element is affected by the following invariants: ref-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()))
            68. List.entry.item.type
            Definition

            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

            ShortType the reference refers to (e.g. "Patient")
            Comments

            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from ResourceType
            (extensible to http://hl7.org/fhir/ValueSet/resource-types)

            Aa resource (or, for logical models, the URI of the logical model).

            Typeuri
            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()))
            70. List.entry.item.identifier
            Definition

            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

            ShortLogical reference, when literal reference is not known
            Comments

            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

            Plain text narrative that identifies the resource in addition to the resource reference.

            ShortText alternative for the resource
            Comments

            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

            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()))
            74. List.emptyReason
            Definition

            If the list is empty, why the list is empty.

            ShortWhy list is empty
            Comments

            The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

            Control0..1
            This element is affected by the following invariants: lst-1
            BindingThe codes SHALL be taken from Non-Clinical Empty Reason .
            (required to https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            Allows capturing things like "none exist" or "not asked" which can be important for most lists.

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