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 2024-10-28 02:34:31+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 S0..1MRMetaMetadata about a resource
​... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
​... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
​... medication-pack-size S0..1stringMediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
​... is-extemporaneous S0..1booleanExtemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
​... code
​.... coding:pbs S0..1CodingPBS Item Code
​.... coding:amt S0..1CodingAMT Medicines
​.... coding:atc S0..1CodingCode defined by a terminology system
​..... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.whocc.no/atc
​.... text S0..1stringMedication primary text
​... form
​.... text S0..1stringPlain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA medication in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta S0..1MRMetaMetadata about a resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... medication-strength S0..1stringMedication strength
URL: http://hl7.org.au/fhir/StructureDefinition/medication-strength
... medication-pack-size S0..1stringMediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
... is-extemporaneous S0..1booleanExtemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs SΣ0..1CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:amt SΣ0..1CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:atc SΣ0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.whocc.no/atc
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: Medication Form . (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept
... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
​.. Medication 0..*AUBaseMedicationA medication in an Australian healthcare context
​... meta 0..1MRMetaMetadata about a resource
​... brandName 0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
​... genericName 0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
​... medication-pack-size 0..1stringMediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
​... is-extemporaneous 0..1booleanExtemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
​... code Σ0..1CodeableConceptCoding for the medicine
​.... coding:pbs Σ0..1CodingPBS Item Code
Binding: PBS Item Codes (preferred)
​.... coding:amt Σ0..1CodingAMT Medicines
Binding: Australian Medication . (preferred)
​.... coding:atc Σ0..1CodingCode defined by a terminology system
​.... text Σ0..1stringMedication primary text
​... form 0..1CodeableConceptpowder | tablets | capsule +
​.... text Σ0..1stringPlain text representation of the concept

doco Documentation for this format

Differential View

This structure is derived from AUBaseMedication

NameFlagsCard.TypeDescription & Constraintsdoco
​.. Medication AUBaseMedication
​... meta S0..1MRMetaMetadata about a resource
​... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
​... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
​... medication-pack-size S0..1stringMediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
​... is-extemporaneous S0..1booleanExtemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
​... code
​.... coding:pbs S0..1CodingPBS Item Code
​.... coding:amt S0..1CodingAMT Medicines
​.... coding:atc S0..1CodingCode defined by a terminology system
​..... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.whocc.no/atc
​.... text S0..1stringMedication primary text
​... form
​.... text S0..1stringPlain text representation of the concept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*AUBaseMedicationA medication in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta S0..1MRMetaMetadata about a resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... brandName S0..1stringMedication brand name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
... genericName S0..1stringMedication generic drug name
URL: http://hl7.org.au/fhir/StructureDefinition/medication-generic-name
... medication-strength S0..1stringMedication strength
URL: http://hl7.org.au/fhir/StructureDefinition/medication-strength
... medication-pack-size S0..1stringMediRecords Medication Pack Size
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-pack-size
... is-extemporaneous S0..1booleanExtemporaneous compounded medicines indicator extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-medication-extemporaneous
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code Σ0..1CodeableConceptCoding for the medicine
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:pbs SΣ0..1CodingPBS Item Code
Binding: PBS Item Codes (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://pbs.gov.au/code/item
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:gtin Σ0..*CodingMedication Package Global Trade Item Number (GTIN)
Binding: GTIN (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.gs1.org/gtin
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:amt SΣ0..1CodingAMT Medicines
Binding: Australian Medication . (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... medicationClass 0..1CodingMedication type
URL: http://hl7.org.au/fhir/StructureDefinition/medication-type
Binding: Medication Type (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:mimsPackage Σ0..1CodingMIMS Package
Binding: MIMS (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.mims.com.au/codes
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:atc SΣ0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.whocc.no/atc
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringMedication primary text
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Physical product manufacturer organisation
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: Medication Form . (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept
... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
Binding: AMT Medicinal Product and Substances (preferred)
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity/strength of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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()