Australian Provider Directory Implementation Guide (PD 1)
This page is part of the Australian Provider Directory IG (v1.0.0: PD 1 on FHIR STU3) based on FHIR R3. The current version which supercedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions 
Australian Organisation Directory Entry Profile
Provider directory entry for an organisation.
Organisation Directory Entry Example
The official URL for this profile is:
http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-organisation
This profile builds on AUBaseOrganisation.
This profile was published on Tue May 14 00:00:00 AEST 2019 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Australian Organisation Directory Entry
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | Australian Organisation Directory Entry | ||
 meta | 0..1 | Meta | Metadata about the resource (extended) | |
  extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
 meta-source | S | 0..* | uri | Preadopt STU4 Meta.source URL: http://hl7.org.au/fhir/StructureDefinition/meta-source |
| identifier | 0..* | Identifier | Organisation Directory Entry Identifiers | |
| identifier | S | 0..* | Identifier | HPI-O for Directory Entry Organisation |
| active | S | 1..1 | boolean | Status of Directroy Entry Organisation |
| name | S | 1..1 | string | Name of Directroy Entry Organisation |
| telecom | S | 0..* | ContactPoint | Contact Details of Directroy Entry Organisation |
| address | S | 0..* | Address | Addresses of Directroy Entry Organisation |
 state | 0..1 | string | Binding: Australian States and Territories (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Australian Organisation Directory Entry | |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource (extended) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| meta-source | S | 0..* | uri | Preadopt STU4 Meta.source URL: http://hl7.org.au/fhir/StructureDefinition/meta-source |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/meta-source" | |
 valueUri | 1..1 | uri | Source System URI | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | Σ | 0..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: Common Tags (example) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | ΣI | Identifier | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system | |
| identifier | SΣI | 0..* | Identifier | HPI-O for Directory Entry Organisation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for HPI-O Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI"}]} |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: HPI-O |
| system | Σ | 1..1 | uri | Namespace for HPI-O Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 |
| value | Σ | 1..1 | string | HPI-O number Example General': 123456 Example HPI-O number': 8003621566684455 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Australian Business Number (ABN) inv-asic-abn-length: ABN shall be exactly 11 digits |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for ABN Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ABN |
| system | Σ | 1..1 | uri | Namespace for ABN Fixed Value: http://hl7.org.au/id/abn |
| value | Σ | 1..1 | string | ABN Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Australian Company Number (ACN) inv-asic-acn-length: ACN shall be exactly 9 digits |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for ACN Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ACN |
| system | Σ | 1..1 | uri | Namespace for ACN Fixed Value: http://hl7.org.au/id/acn |
| value | Σ | 1..1 | string | ACN Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-asic-arbn-length: ARBN shall be exactly 9 digits |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ARBN |
| system | Σ | 1..1 | uri | Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn |
| value | Σ | 1..1 | string | ARBN Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | My Health Record Assigned Identity for Organisations (PAI-O) inv-paio-value-0: PAI-O shall be an exactly 16 digit number inv-paio-value-1: PAI-O prefix is 800364 inv-paio-value-2: The identifier shall pass the Luhn algorithm check |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for PAI-O Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: PAI-O |
| system | Σ | 1..1 | uri | Namespace for PAI-O Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 |
| value | Σ | 1..1 | string | PAI-O number Example General': 123456 Example PAI-O number': 8003647500000328 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Contracted Service Provider (CSP) Number inv-csp-0: CSP number is exactly 16 characters inv-csp-1: CSP number prefix is 800363 |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for CSP number Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: CSP |
| system | Σ | 1..1 | uri | Namespace for CSP number Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0 |
| value | Σ | 1..1 | string | CSP number Example General': 123456 Example CSP number': 8003635500000327 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | National Association of Testing Authorities (NATA) Accreditation Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for NATA accreditation number Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: NATA Accreditation Number |
| system | Σ | 1..1 | uri | Namespace for NATA accreditation number Fixed Value: http://hl7.org.au/id/nata-accreditation |
| value | Σ | 1..1 | string | NATA accreditation number Example General': 123456 Example NATA accreditation number': 24482 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!SΣ | 1..1 | boolean | Status of Directroy Entry Organisation |
| type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | SΣI | 1..1 | string | Name of Directroy Entry Organisation |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | SI | 0..* | ContactPoint | Contact Details of Directroy Entry Organisation |
| address | SI | 0..* | Address | Addresses of Directroy Entry Organisation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General': home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
| text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General': 137 Nowhere Street |
| city | Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon |
| district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required) |
| postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
| partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
Australian Organisation Directory Entry
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | Australian Organisation Directory Entry | ||
| meta | 0..1 | Meta | Metadata about the resource (extended) | |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| meta-source | S | 0..* | uri | Preadopt STU4 Meta.source URL: http://hl7.org.au/fhir/StructureDefinition/meta-source |
| identifier | 0..* | Identifier | Organisation Directory Entry Identifiers | |
| identifier | S | 0..* | Identifier | HPI-O for Directory Entry Organisation |
| active | S | 1..1 | boolean | Status of Directroy Entry Organisation |
| name | S | 1..1 | string | Name of Directroy Entry Organisation |
| telecom | S | 0..* | ContactPoint | Contact Details of Directroy Entry Organisation |
| address | S | 0..* | Address | Addresses of Directroy Entry Organisation |
| state | 0..1 | string | Binding: Australian States and Territories (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Australian Organisation Directory Entry | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource (extended) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| meta-source | S | 0..* | uri | Preadopt STU4 Meta.source URL: http://hl7.org.au/fhir/StructureDefinition/meta-source |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.org.au/fhir/StructureDefinition/meta-source" | |
| valueUri | 1..1 | uri | Source System URI | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | Σ | 0..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: Common Tags (example) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | Identifier | Organisation Directory Entry Identifiers Slice: Unordered, Open by value:system | |
| identifier | SΣI | 0..* | Identifier | HPI-O for Directory Entry Organisation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for HPI-O Binding: v2 Identifier Type - AU Extended (required) Required Pattern: {"coding":[{"system":"http://hl7.org.au/fhir/v2/0203","code":"NOI"}]} |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: HPI-O |
| system | Σ | 1..1 | uri | Namespace for HPI-O Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0 |
| value | Σ | 1..1 | string | HPI-O number Example General': 123456 Example HPI-O number': 8003621566684455 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Australian Business Number (ABN) inv-asic-abn-length: ABN shall be exactly 11 digits |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for ABN Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ABN |
| system | Σ | 1..1 | uri | Namespace for ABN Fixed Value: http://hl7.org.au/id/abn |
| value | Σ | 1..1 | string | ABN Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Australian Company Number (ACN) inv-asic-acn-length: ACN shall be exactly 9 digits |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Coded identifier type for ACN Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ACN |
| system | Σ | 1..1 | uri | Namespace for ACN Fixed Value: http://hl7.org.au/id/acn |
| value | Σ | 1..1 | string | ACN Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Australian Registered Body Number (ARBN) inv-asic-arbn-length: ARBN shall be exactly 9 digits |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: ARBN |
| system | Σ | 1..1 | uri | Namespace for ARBN Fixed Value: http://hl7.org.au/id/arbn |
| value | Σ | 1..1 | string | ARBN Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | My Health Record Assigned Identity for Organisations (PAI-O) inv-paio-value-0: PAI-O shall be an exactly 16 digit number inv-paio-value-1: PAI-O prefix is 800364 inv-paio-value-2: The identifier shall pass the Luhn algorithm check |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for PAI-O Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: PAI-O |
| system | Σ | 1..1 | uri | Namespace for PAI-O Fixed Value: http://ns.electronichealth.net.au/id/pcehr/paio/1.0 |
| value | Σ | 1..1 | string | PAI-O number Example General': 123456 Example PAI-O number': 8003647500000328 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | Contracted Service Provider (CSP) Number inv-csp-0: CSP number is exactly 16 characters inv-csp-1: CSP number prefix is 800363 |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for CSP number Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: CSP |
| system | Σ | 1..1 | uri | Namespace for CSP number Fixed Value: http://ns.electronichealth.net.au/id/hi/csp/1.0 |
| value | Σ | 1..1 | string | CSP number Example General': 123456 Example CSP number': 8003635500000327 Max Length: 16 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | ΣI | 0..* | Identifier | National Association of Testing Authorities (NATA) Accreditation Number |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Identifier type for NATA accreditation number Binding: Identifier Type Codes (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept Fixed Value: NATA Accreditation Number |
| system | Σ | 1..1 | uri | Namespace for NATA accreditation number Fixed Value: http://hl7.org.au/id/nata-accreditation |
| value | Σ | 1..1 | string | NATA accreditation number Example General': 123456 Example NATA accreditation number': 24482 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!SΣ | 1..1 | boolean | Status of Directroy Entry Organisation |
| type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | SΣI | 1..1 | string | Name of Directroy Entry Organisation |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | SI | 0..* | ContactPoint | Contact Details of Directroy Entry Organisation |
| address | SI | 0..* | Address | Addresses of Directroy Entry Organisation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General': home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
| text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General': 137 Nowhere Street |
| city | Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon |
| district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: Australian States and Territories (required) |
| postalCode | Σ | 0..1 | string | Postal code for area Example General': 9132 |
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
| partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the requirements for search and read operations.
Read: Organisation
Read identified organisation resource content.
GET [base]/Organization/[id]
Example: GET [base]/Organization/1234
Support: MUST support read Organisation
Implementation Notes: (how to read resource)
Search: Active Status
Search based on active status of the organisation record.
GET [base]/Organization?active=[status]
Example: GET [base]/Organization?active=true
Support: MUST support search Organization by active status (true | false).
Implementation Notes: (how to search by token)
Search: HPI-O
Search based on identifier token.
GET [base]/Organization?identifier=[system]|[value]
Example: GET [base]/Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328
Support: SHOULD support search by HPI-O.
Implementation Notes: (how to search by token)
Search: Name
Search for a organisation by name.
GET [base]/Organization?name=[string]
Example: GET [base]/Organization?name=southern%20clinic
Support:
Implementation Notes: (how to search by string)
Search: Combination
© PD 1 on FHIR STU3 (IG Publisher v3.0.1-11917) generated on Tue, May 14, 2019 11:42+1000. |
