AU Base Implementation Guide
4.1.0 - Trial Use Australia flag

This page is part of the AU Base Implementation Guide 4.1.0. It is based on FHIR R4. For a full list of available versions, see the Directory of published versions

Extension: Medication Brand Name

Official URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name Version: 4.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: MedicationBrandName

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This extension applies to the Medication, MedicationRequest, MedicationDispense amd MedicationStatement resources and is used to represent the brand name of a medication. This extension is not to be the sole representation of the medication concept; it shall not be used as a substitute for medication code (e.g. Medication.code or MedicationStatement.medicationCodeableConcept).

If a system can only supply branded product information in text form, that information will be supplied in the text portion of that code e.g. code.text or medicationCodeableConcept.text. This extension only supports the name portion of a medication concept, not the branded product or product pack information. It is available for use for where a system needs to separate out the brand name string for handling or other processing.

This extension may be used on the following element(s):

  • Element ID Medication
  • Element ID MedicationRequest
  • Element ID MedicationDispense
  • Element ID MedicationStatement

Usage Notes

Profile specific implementation guidance:

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionMedication brand name
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-brand-name"
... value[x] 1..1stringBrand or product name

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionMedication brand name
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-brand-name"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 1 element
Fixed Value: 1 element

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionMedication brand name
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-brand-name"
... value[x] 1..1stringBrand or product name

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionMedication brand name
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/medication-brand-name"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
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()