Primary Care Implementation Guide

AU Primary Care Implementation Guide - Local Development build (vnull). See the Directory of published versions

1.0 StructureDefinition-au-primarycaremedicinelist

AU Primary Care Allergy Intolerance List Profile [FMM Level 0]

This profile defines a medicine list structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

Examples thanks to Best Practice and Jim Steel .. not yet checked for conformance to this IG .. Note id has been included due to IG builder requirements

​Medicine List 1

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

https://aehrc.com/fhir/StructureDefinition/AUPrimaryCareMedicineList

This profile defines a medicine list structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.

This profile builds on AUMedicineList.

This profile was published on Wed Nov 06 14:07:15 AEST 2019 as a draft by null.

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

This profile contains the following variations from AU Medicine List:

  1. status fixedValue ‘current’
  2. mode fixedValue ‘snapshot’
  3. entry
    • item mustSupport (Reference: AUPrimaryCareMedicationStatement)
  4. emptyReason mustSupport
NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*A list of medications in an Australian primary care practice-to-practice record transfer context.
... status 1..1codeFixed Value: current
... mode 1..1codeFixed Value: snapshot
... date S0..1dateTime
... entry S0..*BackboneElement
.... item S1..1Reference(AU Primary Care Medication Statement)
... emptyReason S0..1CodeableConcept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*A list of medications in an Australian primary care practice-to-practice record transfer context.
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person I0..1Reference()Related person that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
Fixed Value: current
... mode ?!ΣI1..1codeworking | snapshot | changes
Binding: ListMode (required)
Fixed Value: snapshot
... title ΣI0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code ΣI0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter I0..1Reference(Encounter)Context in which list created
... date SΣI0..1dateTimeWhen the list was prepared
... source ΣI0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy I0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note I0..*AnnotationComments about the list
... entry SI0..*BackboneElementMedicine list entry
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... change-description I0..1stringDescription of the change to the item
URL: http://hl7.org.au/fhir/StructureDefinition/change-description
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag I0..1CodeableConcept​Medicine item change
Binding: http://hl7.org.au/fhir/ValueSet/medicine-item-change (preferred)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date I0..1dateTimeWhen item added to list
.... item SI1..1Reference(AU Primary Care Medication Statement)Actual entry
... emptyReason SI0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

This profile contains the following variations from AU Medicine List:

  1. status fixedValue ‘current’
  2. mode fixedValue ‘snapshot’
  3. entry
    • item mustSupport (Reference: AUPrimaryCareMedicationStatement)
  4. emptyReason mustSupport

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*A list of medications in an Australian primary care practice-to-practice record transfer context.
... status 1..1codeFixed Value: current
... mode 1..1codeFixed Value: snapshot
... date S0..1dateTime
... entry S0..*BackboneElement
.... item S1..1Reference(AU Primary Care Medication Statement)
... emptyReason S0..1CodeableConcept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*A list of medications in an Australian primary care practice-to-practice record transfer context.
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person I0..1Reference()Related person that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
Fixed Value: current
... mode ?!ΣI1..1codeworking | snapshot | changes
Binding: ListMode (required)
Fixed Value: snapshot
... title ΣI0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code ΣI0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter I0..1Reference(Encounter)Context in which list created
... date SΣI0..1dateTimeWhen the list was prepared
... source ΣI0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy I0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note I0..*AnnotationComments about the list
... entry SI0..*BackboneElementMedicine list entry
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... change-description I0..1stringDescription of the change to the item
URL: http://hl7.org.au/fhir/StructureDefinition/change-description
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag I0..1CodeableConcept​Medicine item change
Binding: http://hl7.org.au/fhir/ValueSet/medicine-item-change (preferred)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date I0..1dateTimeWhen item added to list
.... item SI1..1Reference(AU Primary Care Medication Statement)Actual entry
... emptyReason SI0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-primarycaremedicinelist

none defined