AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

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

Data Type Profile: AU Local Order Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier Version: 4.1.2-preview
Standards status: Trial-use 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 or a filler identifier (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.

Usage Notes

Profile specific implementation guidance:

  • An organisation should use their own local system identifier namespace but if that is not available then see the guidance on Business Identifiers on using an HPI-O to construct a legal globally unique identifier system for local identifiers.

Usage:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... type 1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system 1..1uriSystem identifier namespace for the organisation that assigned the order identifier
... value 1..1stringOrder identifier
.... display 1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Identifier.typerequiredOrderIdentifierType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
... assigner Σ1..1Reference(Organization)Organisation that assigned the order identifier
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typerequiredOrderIdentifierType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... system Σ1..1uriSystem identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringOrder identifier
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ1..1Reference(Organization)Organisation that assigned the order identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typerequiredOrderIdentifierType
Identifier.assigner.typeextensibleResourceType

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()

This structure is derived from Identifier

Summary

Mandatory: 5 elements

Maturity: 1

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... type 1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system 1..1uriSystem identifier namespace for the organisation that assigned the order identifier
... value 1..1stringOrder identifier
.... display 1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Identifier.typerequiredOrderIdentifierType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptCoded identifier type for local order identifier
Binding: Order Identifier Type (required)
... system Σ1..1uriSystem identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
... assigner Σ1..1Reference(Organization)Organisation that assigned the order identifier
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typerequiredOrderIdentifierType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierLocal Order Identifier
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... system Σ1..1uriSystem identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringOrder identifier
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ1..1Reference(Organization)Organisation that assigned the order identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringName of the assigning organisation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typerequiredOrderIdentifierType
Identifier.assigner.typeextensibleResourceType

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()

This structure is derived from Identifier

Summary

Mandatory: 5 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron