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-localorderidentifier | Version: 4.1.0-ballot | |||
| Active as of 2022-11-10 | Maturity Level: 1 | Computable Name: AULocalOrderIdentifier | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This identifier profile defines a local order identifier in an Australian context.
A local order identifier is an organisation’s identifier for an order in that organisation’s local system set of orders.
Typically a local order identifier will be either a placer identifier[1] or a filler identifier[2] (sometimes known as filler order number). A placer identifier is an identifier for a request or group of requests where the identifier is issued by the entity making the request. A filler identifier is an identifier for a request or group of requests where the identifier is issued by the entity that produces the observations or fulfills the request.
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 order 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 Order Identifier | |
 type | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | |
| system | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier | |
| value | 1..1 | string | Order identifier | |
 assigner | 1..1 | Reference(Organization) | Organisation that assigned the order identifier | |
  display | 1..1 | string | Name of the assigning organisation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.type | required | OrderIdentifierType |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Order 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 order identifier Binding: Order Identifier Type (required) |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Order identifier Example General: 123456 |
 assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the order identifier |
| display | Σ | 1..1 | string | Name of the assigning organisation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | required | OrderIdentifierType |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Order 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 order identifier Binding: Order Identifier Type (required) |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Order 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 order 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 |
| Identifier.use | required | IdentifierUse |
| Identifier.type | required | OrderIdentifierType |
| 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 Order Identifier | |
| type | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | |
| system | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier | |
| value | 1..1 | string | Order identifier | |
| assigner | 1..1 | Reference(Organization) | Organisation that assigned the order identifier | |
| display | 1..1 | string | Name of the assigning organisation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.type | required | OrderIdentifierType |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Order 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 order identifier Binding: Order Identifier Type (required) |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Order identifier Example General: 123456 |
| assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the order identifier |
| display | Σ | 1..1 | string | Name of the assigning organisation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | required | OrderIdentifierType |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Local Order 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 order identifier Binding: Order Identifier Type (required) |
| system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Order 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 order 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 |
| Identifier.use | required | IdentifierUse |
| Identifier.type | required | OrderIdentifierType |
| 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