AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 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/au-localprescriptionidentifier | Version: 4.1.0-ballot | |||
| Draft as of 2022-11-10 | Maturity Level: 2 | Computable Name: AULocalPrescriptionIdentifier | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This identifier profile defines a local prescription identifier (sometimes referred to as prescription number) in an Australian context.
A local prescription identifier is an organisation’s identifier for a prescription in that organisation’s local system set of prescriptions.
A local prescription identifier allows linking of a prescription to a system’s local identifier.
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 prescription identifier.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Identifier | 0..* | Identifier | Local Prescription Identifier | |
 type | 1..1 | CodeableConcept | Coded identifier type for local prescription 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: LPN | |
| system | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier | |
| value | 1..1 | string | Prescription identifier | |
| assigner | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier | |
| display | 1..1 | string | Name of the assigning organisation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Prescription Identifier | |
 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 prescription 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 |
| 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: LPN | |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Prescription identifier Example General: 123456 |
 assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier |
| display | Σ | 1..1 | string | Name of the assigning organisation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: LPN |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Prescription 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 prescription 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 | id | 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 | id | 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: LPN | |
| 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 prescription identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Prescription 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 prescription 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 | ΣC | 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 | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: LPN |
| Identifier.assigner.type | extensible | ResourceType |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Prescription Identifier | |
| type | 1..1 | CodeableConcept | Coded identifier type for local prescription 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: LPN | |
| system | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier | |
| value | 1..1 | string | Prescription identifier | |
| assigner | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier | |
| display | 1..1 | string | Name of the assigning organisation | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Prescription Identifier | |
| 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 prescription 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 |
| 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: LPN | |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the prescription identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Prescription identifier Example General: 123456 |
| assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the prescription identifier |
| display | Σ | 1..1 | string | Name of the assigning organisation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: LPN |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Prescription 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 prescription 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 | id | 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 | id | 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: LPN | |
| 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 prescription identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Prescription 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 prescription 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 | ΣC | 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 | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: LPN |
| Identifier.assigner.type | extensible | ResourceType |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron
none defined
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.0-ballot based on FHIR 4.0.1. Generated 2022-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change