AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Data Type Profile: AU Local Report Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-localreportidentifier Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 1 Computable Name: AULocalReportIdentifier

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines a local report identifier in an Australian context. A local report identifier is an organisation's identifier for a report in that organisation's local system set of reports. A report identifier must uniquely identify the report from all other reports in a particular system (e.g. diagnostic imaging system, clinical laboratory system, document management system, referral systems). In some laboratory systems, the report identifier may be a concatenation of a lab number and report panel code (e.g. 19P123456-FBC), where the panel code makes the identifier unique from other reports under the same lab number.

Usage Notes

In many systems the report identifier is fulfilled by the concept filler order number in the HL7 V2 specification if there is only a single filler order number per report. When sending a filler order number the AU Local Order Identifier is the recommended applicable profile.

In diagnostic imaging and some laboratory systems the report identifier is fulfilled by the concept accession number if there is only a single accession number per report. When sending an accession number the AU Accession Number is the recommended applicable profile.

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • No changes
  • Formal Views of Profile Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Local Report Identifier
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for local report 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:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "LRI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri System identifier namespace for the organisation that assigned the report identifier
    Example General: http://www.acme.com/identifiers/patient
    Identifier.value This element is included in summaries. 1..1 string Report identifier
    Example General: 123456
    Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organisation that assigned the report identifier
    Identifier.assigner.display This element is included in summaries. 1..1 string Name of the assigning organisation

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Local Report Identifier
    Identifier.type 1..1 CodeableConcept Coded identifier type for local report identifier
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "LRI"
        }
      ]
    }
    Identifier.system 1..1 uri System identifier namespace for the organisation that assigned the report identifier
    Identifier.value 1..1 string Report identifier
    Identifier.assigner.display 1..1 string Name of the assigning organisation

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Local Report Identifier
    Identifier.id 0..1 string Unique id for inter-element referencing
    Identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for local report 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:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "LRI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri System identifier namespace for the organisation that assigned the report identifier
    Example General: http://www.acme.com/identifiers/patient
    Identifier.value This element is included in summaries. 1..1 string Report identifier
    Example General: 123456
    Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organisation that assigned the report identifier
    Identifier.assigner.id 0..1 string Unique id for inter-element referencing
    Identifier.assigner.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
    Identifier.assigner.type This element is included in summaries. 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.assigner.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
    Identifier.assigner.display This element is included in summaries. 1..1 string Name of the assigning organisation

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
    Identifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()

    This structure is derived from Identifier

    Summary

    Mandatory: 5 elements

    Maturity: 1

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Local Report Identifier
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for local report 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:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "LRI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri System identifier namespace for the organisation that assigned the report identifier
    Example General: http://www.acme.com/identifiers/patient
    Identifier.value This element is included in summaries. 1..1 string Report identifier
    Example General: 123456
    Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organisation that assigned the report identifier
    Identifier.assigner.display This element is included in summaries. 1..1 string Name of the assigning organisation

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

    Differential View

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Local Report Identifier
    Identifier.type 1..1 CodeableConcept Coded identifier type for local report identifier
    Required Pattern:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "LRI"
        }
      ]
    }
    Identifier.system 1..1 uri System identifier namespace for the organisation that assigned the report identifier
    Identifier.value 1..1 string Report identifier
    Identifier.assigner 1..1 Reference(Organization) Organisation that assigned the report identifier
    Identifier.assigner.display 1..1 string Name of the assigning organisation

    doco Documentation for this format

    Snapshot ViewView

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Local Report Identifier
    Identifier.id 0..1 string Unique id for inter-element referencing
    Identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for local report 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:
    {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
          "code" : "LRI"
        }
      ]
    }
    Identifier.system This element is included in summaries. 1..1 uri System identifier namespace for the organisation that assigned the report identifier
    Example General: http://www.acme.com/identifiers/patient
    Identifier.value This element is included in summaries. 1..1 string Report identifier
    Example General: 123456
    Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Identifier.assigner This element is included in summaries. 1..1 Reference(Organization) Organisation that assigned the report identifier
    Identifier.assigner.id 0..1 string Unique id for inter-element referencing
    Identifier.assigner.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
    Identifier.assigner.type This element is included in summaries. 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.assigner.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
    Identifier.assigner.display This element is included in summaries. 1..1 string Name of the assigning organisation

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
    Identifier.assigner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    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()

    This structure is derived from Identifier

    Summary

    Mandatory: 5 elements

    Maturity: 1

     

    Other representations of profile: CSV, Excel, Schematron