Australian Base Implementation Guide
This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions 
AU Local Dispense Identifier [FMM 1]
This identifier profile defines a local dispense identifier in an Australian context. A local dispense identifier is an organisation’s identifier for a prescription in that organisation’s local system set of dispense records.
A dispense record identifier is typically assigned by the dispensing system and allows linking of a dispensing record to the dispensing system’s local identifier.
No extensions are used in this profile.
It is preferable that an organisation uses their own local system identifier namespace but if that is not available then an organisation can use their HPI-O to construct a legal globally unique identifier system for their local identifiers.
See the Australian Digital Health Agency’s R4 FAQ for guidance on constructing an HPI-O scoped[1] local dispense identifier.
First dispense for Reaptan against Prescription for Reaptan
Second dispense for Reaptan against Prescription for Reaptan
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-localdispenseidentifier
This identifier profile defines a local dispense identifier in an Australian context.
This profile builds on Identifier.
This profile was published on 2020-10-09 as a draft by Health Level Seven Australia (Medications WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Identifier | 0..* | Identifier | Local Dispense Identifier | |
 type | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LDI | |
| system | 1..1 | uri | System identifier namespace for the organisation that assigned the dispense identifier | |
| value | 1..1 | string | Dispense identifier | |
| assigner | 1..1 | Reference(Organization) | Organisation that assigned the dispense identifier | |
| display | 1..1 | string | Name of the assigning organisation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Dispense Identifier | |
 id | 0..1 | string | Unique id for inter-element referencing | |
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 type | Σ | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LDI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the dispense identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Dispense identifier Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the dispense identifier |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Name of the assigning organisation |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Dispense Identifier | |
| type | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LDI | |
| system | 1..1 | uri | System identifier namespace for the organisation that assigned the dispense identifier | |
| value | 1..1 | string | Dispense identifier | |
| assigner | 1..1 | Reference(Organization) | Organisation that assigned the dispense identifier | |
| display | 1..1 | string | Name of the assigning organisation | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Dispense Identifier | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 1..1 | CodeableConcept | Coded identifier type for local dispense identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LDI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the dispense identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Dispense identifier Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the dispense identifier |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Name of the assigning organisation |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-localdispenseidentifier
none defined
© AU Base on FHIR R4
(IG Publisher v4.0.1-a53ec6ee1b) generated on Mon, May 30, 2022 21:52+1000. |
