AU Base Implementation Guide
4.1.0 - Trial Use
AU Base Implementation Guide
4.1.0 - Trial Use
This page is part of the AU Base Implementation Guide 4.1.0. It is 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-employeenumber | Version: 4.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUEmployeeNumber | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This identifier profile defines an employee number (sometimes referred to as an employee identifier (EI)) in an Australian context. An employee number is an organisation’s identifier for an individual employed by that organisation.
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 | Employee Number | |
 type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| system | 1..1 | uri | System identifier namespace for the employing organisation | |
| value | 1..1 | string | Employee number | |
| assigner | 1..1 | Reference(Organization) | Employing organisation | |
| display | 1..1 | string | Employing organisation's name | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Employee 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 | Description of 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: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| system | Σ | 1..1 | uri | System identifier namespace for the employing organisation Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Employee number Example General: 123456 |
 assigner | Σ | 1..1 | Reference(Organization) | Employing organisation |
| display | Σ | 1..1 | string | Employing organisation's name |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: EI |
| 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 | Employee 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 | Description of 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: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 1..1 | uri | System identifier namespace for the employing organisation Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Employee number Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Employing organisation |
| 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 | Employing organisation's name |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: EI |
| Identifier.assigner.type | extensible | ResourceType |
| 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 | Employee Number | |
| type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| system | 1..1 | uri | System identifier namespace for the employing organisation | |
| value | 1..1 | string | Employee number | |
| assigner | 1..1 | Reference(Organization) | Employing organisation | |
| display | 1..1 | string | Employing organisation's name | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Identifier | Employee 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 | Description of 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: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| system | Σ | 1..1 | uri | System identifier namespace for the employing organisation Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Employee number Example General: 123456 |
| assigner | Σ | 1..1 | Reference(Organization) | Employing organisation |
| display | Σ | 1..1 | string | Employing organisation's name |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: EI |
| 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 | Employee 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 | Description of 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: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: EI | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 1..1 | uri | System identifier namespace for the employing organisation Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Employee number Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 1..1 | Reference(Organization) | Employing organisation |
| 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 | Employing organisation's name |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | Pattern: EI |
| Identifier.assigner.type | extensible | ResourceType |
| 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
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.0 based on FHIR 4.0.1. Generated 2023-02-24
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change