Australian Base Implementation Guide (AU Base 2)
This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
AU Care Agency Employee Identifier [FMM Level 0]
This identifier profile defines a My Health Record assigned Care Agency Employee (CAE) identifier[1] in an Australian context. A CAE identifier may be issued to an employee of, or person under contracted arrangement with, a Care Agency who wishes to participate in the My Health Record.
Examples
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-careagencyemployeeidentifier
This identifier profile defines a Care Agency Employee (CAE) identifier in an Australian context.
This profile builds on Identifier.
This profile was published on Mon Jul 20 00:00:00 AEST 2020 as a draft by Health Level Seven Australia (Patient Administration WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Identifier | I | 0..* | Identifier | Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check |
 type | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) | |
  text | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier | |
| system | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 | |
| value | 1..1 | string | CAE identifier Example CAE identifier: 9003600003999997 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | I | 0..* | Identifier | Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check |
 id | 0..1 | string | Unique id for inter-element referencing | |
 extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
 type | ΣI | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier |
| system | ΣI | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 |
| value | ΣI | 1..1 | string | CAE identifier Example General: 123456 Example CAE identifier: 9003600003999997 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
 assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | I | 0..* | Identifier | Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check |
| type | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) | |
| text | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier | |
| system | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 | |
| value | 1..1 | string | CAE identifier Example CAE identifier: 9003600003999997 | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | I | 0..* | Identifier | Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Identifier type for CAE identifier Binding: V2 Identifier Type - AU Extended (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system |
| text | ΣI | 0..1 | string | Plain text representation of the concept Fixed Value: Care Agency Employee Identifier |
| system | ΣI | 1..1 | uri | Namespace for CAE identifier Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0 |
| value | ΣI | 1..1 | string | CAE identifier Example General: 123456 Example CAE identifier: 9003600003999997 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-careagencyemployeeidentifier
none defined
© AU Base 2 on FHIR R4 (IG Publisher v4.0.1-a53ec6ee1b) generated on Thu, Jul 30, 2020 13:57+1000. |
