AU Base Implementation Guide
4.2.2-ballot - Ballot
This page is part of the Australian Base IG (v4.2.2-ballot: AU Base R4.2 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/StructureDefinition/au-accessionnumber | Version: 4.2.2-ballot | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: AUAccessionNumber | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
This identifier profile defines an accession number in an Australian context. Accession numbers are typically assigned by a diagnostic imaging system or clinical laboratory system and depending on the domain an accession number may for example identify a specimen, imaging examination, or biological polymer sequence.
Profile specific implementation guidance:
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 | Accession Number | |
type | 1..1 | CodeableConcept | Coded identifier type for accession number Binding: Accession Number Type (required) | |
system | 1..1 | uri | System identifier namespace for the organisation that assigned the accession number | |
value | 1..1 | string | Accession number | |
assigner | 1..1 | Reference(Organization) | Organisation that assigned the accession number | |
display | 1..1 | string | Name of the assigning organisation | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Identifier.type | required | AccessionNumberTypehttp://terminology.hl7.org.au/ValueSet/accession-number-type from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Accession Number | |
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 accession number Binding: Accession Number Type (required) |
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the accession number Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | Accession number Example General: 123456 |
assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the accession number |
display | Σ | 1..1 | string | Name of the assigning organisation |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | required | AccessionNumberTypehttp://terminology.hl7.org.au/ValueSet/accession-number-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Accession Number | |
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 accession number Binding: Accession Number Type (required) |
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the accession number Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | Accession number 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 accession number |
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 | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | required | AccessionNumberTypehttp://terminology.hl7.org.au/ValueSet/accession-number-type from this IG | |
Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Differential View
This structure is derived from Identifier
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Accession Number | |
type | 1..1 | CodeableConcept | Coded identifier type for accession number Binding: Accession Number Type (required) | |
system | 1..1 | uri | System identifier namespace for the organisation that assigned the accession number | |
value | 1..1 | string | Accession number | |
assigner | 1..1 | Reference(Organization) | Organisation that assigned the accession number | |
display | 1..1 | string | Name of the assigning organisation | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Identifier.type | required | AccessionNumberTypehttp://terminology.hl7.org.au/ValueSet/accession-number-type from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Accession Number | |
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 accession number Binding: Accession Number Type (required) |
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the accession number Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | Accession number Example General: 123456 |
assigner | Σ | 1..1 | Reference(Organization) | Organisation that assigned the accession number |
display | Σ | 1..1 | string | Name of the assigning organisation |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | required | AccessionNumberTypehttp://terminology.hl7.org.au/ValueSet/accession-number-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Accession Number | |
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 accession number Binding: Accession Number Type (required) |
system | Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the accession number Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | Accession number 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 accession number |
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 | URI |
Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Identifier.type | required | AccessionNumberTypehttp://terminology.hl7.org.au/ValueSet/accession-number-type from this IG | |
Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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
Other representations of profile: CSV, Excel, Schematron