MediRecords FHIR Implementation Guide
1.4.1 - release


Resource Profile: MR Medication

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-medication
Version:1.4.1
Name:MRMedication
Title:MR Medication
Status:Active as of 2025-02-03 04:29:41+0000
Definition:

MediRecords Medication profile to record details about a single Medication, Ingredient, or Substance

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://fhir.medirecords.com/StructureDefinition/mr-medication

Formal Views of Profile Content

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

This structure is derived from AUBaseMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication AUBaseMedication
... meta S 0..1 MRMeta Metadata about a resource
... Slices for extension Content/Rules for all slices
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
.... medication-strength S 0..1 string Medication strength
URL: http://hl7.org.au/fhir/StructureDefinition/medication-strength
.... medication-pack-size S 0..1 string MediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
.... is-extemporaneous S 0..1 boolean Extemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
... code
.... Slices for coding Content/Rules for all slices
..... coding:pbs S 0..1 Coding PBS Item Code
..... coding:amt S 0..1 Coding AMT Medicines
..... coding:atc S 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc
.... text S 0..1 string Medication primary text
.... text S 0..1 string Plain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
... id Σ 0..1 id Logical id of this artifact
... meta S 0..1 MRMeta Metadata about a resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
.... medication-strength S 0..1 string Medication strength
URL: http://hl7.org.au/fhir/StructureDefinition/medication-strength
.... medication-pack-size S 0..1 string MediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
.... is-extemporaneous S 0..1 boolean Extemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs SΣ 0..1 Coding PBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:amt SΣ 0..1 Coding AMT Medicines
Binding: Australian Medication . (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:atc SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Medication primary text
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Physical product manufacturer organisation
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: Medication Form . (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity/strength of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
... meta 0..1 MRMeta Metadata about a resource
... Slices for extension Content/Rules for all slices
.... brandName 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
.... medication-strength 0..1 string Medication strength
URL: http://hl7.org.au/fhir/StructureDefinition/medication-strength
.... medication-pack-size 0..1 string MediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
.... is-extemporaneous 0..1 boolean Extemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
... code Σ 0..1 CodeableConcept Coding for the medicine
.... Slices for coding Content/Rules for all slices
..... coding:pbs Σ 0..1 Coding PBS Item Code
Binding: PBS Item Codes (preferred)
..... coding:amt Σ 0..1 Coding AMT Medicines
Binding: Australian Medication . (preferred)
..... coding:atc Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Medication primary text
.... text Σ 0..1 string Plain text representation of the concept

doco Documentation for this format

Differential View

This structure is derived from AUBaseMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication AUBaseMedication
... meta S 0..1 MRMeta Metadata about a resource
... Slices for extension Content/Rules for all slices
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
.... medication-strength S 0..1 string Medication strength
URL: http://hl7.org.au/fhir/StructureDefinition/medication-strength
.... medication-pack-size S 0..1 string MediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
.... is-extemporaneous S 0..1 boolean Extemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
... code
.... Slices for coding Content/Rules for all slices
..... coding:pbs S 0..1 Coding PBS Item Code
..... coding:amt S 0..1 Coding AMT Medicines
..... coding:atc S 0..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc
.... text S 0..1 string Medication primary text
.... text S 0..1 string Plain text representation of the concept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* AUBaseMedication A medication in an Australian healthcare context
... id Σ 0..1 id Logical id of this artifact
... meta S 0..1 MRMeta Metadata about a resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... brandName S 0..1 string Medication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
.... genericName S 0..1 string Medication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
.... medication-strength S 0..1 string Medication strength
URL: http://hl7.org.au/fhir/StructureDefinition/medication-strength
.... medication-pack-size S 0..1 string MediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
.... is-extemporaneous S 0..1 boolean Extemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Coding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs SΣ 0..1 Coding PBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:gtin Σ 0..* Coding Medication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:amt SΣ 0..1 Coding AMT Medicines
Binding: Australian Medication . (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... medicationClass 0..1 Coding Medication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:mimsPackage Σ 0..1 Coding MIMS Package
Binding: MIMS (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:atc SΣ 0..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Medication primary text
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Physical product manufacturer organisation
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: Medication Form . (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity/strength of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.code.coding:pbspreferredPBSItemCodes
http://terminology.hl7.org.au/ValueSet/pbs-item
Medication.code.coding:gtinpreferredGTIN
http://terminology.hl7.org/ValueSet/v3-GTIN
Medication.code.coding:amtpreferredAustralianMedication .
https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1
Medication.code.coding:mimsPackagepreferredMIMS
http://terminology.hl7.org.au/ValueSet/mims
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredMedicationForm .
https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1
Medication.ingredient.item[x]preferredAMTMedicinalProductAndSubstances
http://terminology.hl7.org.au/ValueSet/amt-mp-codes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()