Primary Care Implementation Guide

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

1.0 StructureDefinition-au-primarycaremedication

AU Primary Care Medication Profile [FMM Level 0]

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

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

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

This profile builds on AUBaseMedication.

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 Base Medication:

  1. code mustSupport
    • code.coding:amt slice mustSupport
  2. form mustSupport
    • form.coding:snomedForm slice mustSupport
  3. ingredient.item[x]:itemCodeableConcept mustSupport
    • ingredient.item[x]:itemCodeableConcept:amtMP slice mustSupport
  4. ingredient.amount mustSupport
  5. Medication.extension:strengthText mustSupport
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*A medication 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
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... extension:strengthText SI0..*ExtensionExtension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifier for this medication
... code SΣI0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:amt SΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medication-type I0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringMedication primary text
... status ?!ΣI0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required)
... manufacturer ΣI0..1Reference(Organization)Physical product manufacturer organisation
... form SI0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
... amount ΣI0..1RatioAmount of drug in package
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] I1..1(Slice Definition)Medication ingredient
Slice: Unordered, Closed by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept SI0..1CodeableConceptCoded Ingredient Product
Binding: AMT Medicinal Product (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding:amtMP SΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
.... isActive I0..1booleanActive ingredient indicator
.... strength SI0..1RatioQuantity/strength of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber I0..1stringIdentifier assigned to batch
.... expirationDate I0..1dateTimeWhen batch will expire

doco Documentation for this format

This profile contains the following variations from AU Base Medication:

  1. code mustSupport
    • code.coding:amt slice mustSupport
  2. form mustSupport
    • form.coding:snomedForm slice mustSupport
  3. ingredient.item[x]:itemCodeableConcept mustSupport
    • ingredient.item[x]:itemCodeableConcept:amtMP slice mustSupport
  4. ingredient.amount mustSupport
  5. Medication.extension:strengthText mustSupport

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*A medication 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
... medication-brand-name I0..1stringMedication Brand Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... medication-generic-name I0..1stringMedication Generic Drug Name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... extension:strengthText SI0..*ExtensionExtension
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness identifier for this medication
... code SΣI0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs ΣI0..*CodingPBS Item Code
Binding: PBS Medicines Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:gtin ΣI0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN for Medicines (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:amt SΣI0..*CodingAMT Medicines
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medication-type I0..1CodingMedication Type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage ΣI0..1CodingMIMS Package
Binding: MIMS Terminology (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringMedication primary text
... status ?!ΣI0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required)
... manufacturer ΣI0..1Reference(Organization)Physical product manufacturer organisation
... form SI0..1CodeableConceptpowder | tablets | capsule +
Binding: https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
... amount ΣI0..1RatioAmount of drug in package
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] I1..1(Slice Definition)Medication ingredient
Slice: Unordered, Closed by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept SI0..1CodeableConceptCoded Ingredient Product
Binding: AMT Medicinal Product (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding:amtMP SΣI0..*CodingCode defined by a terminology system
...... text ΣI0..1stringPlain text representation of the concept
.... isActive I0..1booleanActive ingredient indicator
.... strength SI0..1RatioQuantity/strength of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber I0..1stringIdentifier assigned to batch
.... expirationDate I0..1dateTimeWhen batch will expire

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-primarycaremedication

none defined