AU Base Implementation Guide
4.1.2-preview - Preview
AU Base Implementation Guide
4.1.2-preview - Preview
This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/StructureDefinition/medication-brand-name | Version: 4.1.2-preview | |||
| 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):
Profile specific implementation guidance:
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..1 | Extension | Medication brand name | |
  id | 0..1 | string | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/medication-brand-name" | |
 value[x] | 1..1 | string | Brand or product name | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension of type string: 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.
Maturity: 1
Differential View
This structure is derived from Extension
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | Medication brand name | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/medication-brand-name" | |
| value[x] | 1..1 | string | Brand or product name | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.2-preview based on FHIR 4.0.1. Generated 2023-11-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change