# Health Connect Australia Provider Directory FHIR Implementation Guide

26.0.0 - Trial

Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD/ and changes regularly. See the Directory of published versions

## Resource Profile: HCPD Export Response List

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list | Version: 26.0.0
Active as of 2026-06-17 | Computable Name: HCPD_Export_Response_List
Usage:Jurisdiction: Australia
Copyright/Legal: Copyright © 2026 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This profile defines a List resource used in context of the Bulk Data Extraction capability. This communicates which resources should be removed from downstream systems. It MAY contain identifiers from ALL HCPD resource types.

This profile addresses the business requirement for indicating to downstream client requester systems which resources should be cleansed, once parties have indicated their intent to not have their data published on HCPD.

## Scope

This section describes the structure and intended use for a HCPD Export Response List resource. This resource is used ONLY within the context of the Bulk Data Extract capability of the HCPD system. Practitioners and Organizations may elect to no longer have their data published on the HCPD system. This intent can be communicated through the upstream data ingestion source (PCA) and will subsequently cascade to HCPD.

The HCPD Export Response List resource is used to communicate to Client Requestor Actors which resources SHALL be removed from their local systems. Conformance with this requirement is mandatory. Client Requestor Actors SHALL establish and maintain processes to ensure that the identified resources are removed in accordance with this specification.

## Usage notes

The List resource contains entries with identifiers organized by resource type slicing based on the identifier system. Each entry represents a resource that must be removed from downstream systems.

### Supported identifier systems

Resource Type(s) | Identifier System | Identifier Name
--- | --- | ---
Organization | http://ns.electronichealth.net.au/id/hi/hpio/1.0 | HPI-O
Organization | http://ns.electronichealth.net.au/id/hi/hspo/1.0 | HSP-O
Practitioner | http://ns.electronichealth.net.au/id/hi/hpii/1.0 | HPI-I
Location, HealthcareService, PractitionerRole, Endpoint | http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier | HCPD Local Identifier

## Usage notes

The HCPD Export Response List resource contains identifiers for HCPD resources that should be removed, i.e. (Organization, HealthcareService, Location, Practitioner, PractitionerRole & EndPoint instances).

- Individual resources are flagged for removal via use of the `entry` elements with `entry.item.identifier` values.
- Each entry contains an `entry.item.identifier` with the `system|value` pair of the resource to be removed.
- The identifier systems indicate the resource type and particular identifiers that are used and can be expected by implementers:

### Implementation requirements and processing

Client Requestor Actors of the Bulk Data Extract capability SHALL establish processes/mechanisms where identifiers contained within a `HCPD Export Response List` resource can be referenced to resources, and then those resources are to be purged from their local systems.

Usages:

- Examples for this Profile: List/example-hcpd-export-response-list-1
- CapabilityStatements using this Profile: Health Connect Provider Directory Bulk Export Requester and Health Connect Provider Directory Responder

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
List | C | 0..* | List(4.0.1) | HCPD BDE List Resource for Bulk Data Extract Constraints: lst-1, lst-2, lst-3
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title | S Σ | 1..1 | string | Fixed title for HCPD removal list Required Pattern: HCPD Resources for Removal
Slices for entry | S C | 1..* | BackboneElement | Identifiers for removal by HCPD client systems Slice: Unordered, Open by pattern:item.identifier.system
entry:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
entry:Practitioner | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HPI-I identifier for practitioner removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
entry:Organization_HPIO | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HPI-O identifier for organization removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
entry:Organization_HSPO | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HSP-O identifier for organization removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hspo/1.0
entry:HCPD_Local | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HCPD local identifier for Location, HealthcareService, Endpoint, or PractitionerRole removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | List | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | List.implicitRules, List.modifierExtension, List.status, List.mode, List.title, List.entry, List.entry.modifierExtension, List.entry.deleted, List.entry.item, List.entry:Practitioner, List.entry:Practitioner.modifierExtension, List.entry:Practitioner.deleted, List.entry:Practitioner.item, List.entry:Practitioner.item.identifier, List.entry:Practitioner.item.identifier.use, List.entry:Practitioner.item.identifier.system, List.entry:Organization_HPIO, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HPIO.deleted, List.entry:Organization_HPIO.item, List.entry:Organization_HPIO.item.identifier, List.entry:Organization_HPIO.item.identifier.use, List.entry:Organization_HPIO.item.identifier.system, List.entry:Organization_HSPO, List.entry:Organization_HSPO.modifierExtension, List.entry:Organization_HSPO.deleted, List.entry:Organization_HSPO.item, List.entry:Organization_HSPO.item.identifier, List.entry:Organization_HSPO.item.identifier.use, List.entry:Organization_HSPO.item.identifier.system, List.entry:HCPD_Local, List.entry:HCPD_Local.modifierExtension, List.entry:HCPD_Local.deleted, List.entry:HCPD_Local.item, List.entry:HCPD_Local.item.identifier, List.entry:HCPD_Local.item.identifier.use, List.entry:HCPD_Local.item.identifier.system | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | List.modifierExtension, List.entry.modifierExtension, List.entry:Practitioner.modifierExtension, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HSPO.modifierExtension, List.entry:HCPD_Local.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
lst-1 | error | List | A list can only have an emptyReason if it is empty | `emptyReason.empty() or entry.empty()`
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" | `mode = 'changes' or entry.deleted.empty()`
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" | `mode = 'working' or entry.date.empty()`

This structure is derived from List

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
List |  | 0..* | List(4.0.1) | HCPD BDE List Resource for Bulk Data Extract
status |  | 1..1 | code | current | retired | entered-in-error Required Pattern: current
mode |  | 1..1 | code | working | snapshot | changes Required Pattern: working
title | S | 1..1 | string | Fixed title for HCPD removal list Required Pattern: HCPD Resources for Removal
Slices for entry | S | 1..* | BackboneElement | Identifiers for removal by HCPD client systems Slice: Unordered, Open by pattern:item.identifier.system
entry:Practitioner |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HPI-I identifier for practitioner removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
entry:Organization_HPIO |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HPI-O identifier for organization removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
entry:Organization_HSPO |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HSP-O identifier for organization removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hspo/1.0
entry:HCPD_Local |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HCPD local identifier for Location, HealthcareService, Endpoint, or PractitionerRole removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
List | C | 0..* | List(4.0.1) | HCPD BDE List Resource for Bulk Data Extract Constraints: lst-1, lst-2, lst-3
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier |  | 0..* | Identifier | Business identifier
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title | S Σ | 1..1 | string | Fixed title for HCPD removal list Required Pattern: HCPD Resources for Removal
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject
encounter |  | 0..1 | Reference(Encounter) | Context in which list created
date | Σ | 0..1 | dateTime | When the list was prepared
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author)
orderedBy |  | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
note |  | 0..* | Annotation | Comments about the list
Slices for entry | S C | 1..* | BackboneElement | Identifiers for removal by HCPD client systems Slice: Unordered, Open by pattern:item.identifier.system
entry:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
entry:Practitioner | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HPI-I identifier for practitioner removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
entry:Organization_HPIO | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HPI-O identifier for organization removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
entry:Organization_HSPO | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HSP-O identifier for organization removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hspo/1.0
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
entry:HCPD_Local | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HCPD local identifier for Location, HealthcareService, Endpoint, or PractitionerRole removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
emptyReason | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.code | Base | example | Example Use Codes for List | 📍4.0.1 | FHIR Std.
List.orderedBy | Base | preferred | List Order Codes | 📍4.0.1 | FHIR Std.
List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | List | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | List.meta, List.implicitRules, List.language, List.text, List.extension, List.modifierExtension, List.identifier, List.status, List.mode, List.title, List.code, List.subject, List.encounter, List.date, List.source, List.orderedBy, List.note, List.entry, List.entry.extension, List.entry.modifierExtension, List.entry.flag, List.entry.deleted, List.entry.date, List.entry.item, List.entry:Practitioner, List.entry:Practitioner.extension, List.entry:Practitioner.modifierExtension, List.entry:Practitioner.flag, List.entry:Practitioner.deleted, List.entry:Practitioner.date, List.entry:Practitioner.item, List.entry:Practitioner.item.extension, List.entry:Practitioner.item.reference, List.entry:Practitioner.item.type, List.entry:Practitioner.item.identifier, List.entry:Practitioner.item.identifier.extension, List.entry:Practitioner.item.identifier.use, List.entry:Practitioner.item.identifier.type, List.entry:Practitioner.item.identifier.system, List.entry:Practitioner.item.identifier.value, List.entry:Practitioner.item.identifier.period, List.entry:Practitioner.item.identifier.assigner, List.entry:Practitioner.item.display, List.entry:Organization_HPIO, List.entry:Organization_HPIO.extension, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HPIO.flag, List.entry:Organization_HPIO.deleted, List.entry:Organization_HPIO.date, List.entry:Organization_HPIO.item, List.entry:Organization_HPIO.item.extension, List.entry:Organization_HPIO.item.reference, List.entry:Organization_HPIO.item.type, List.entry:Organization_HPIO.item.identifier, List.entry:Organization_HPIO.item.identifier.extension, List.entry:Organization_HPIO.item.identifier.use, List.entry:Organization_HPIO.item.identifier.type, List.entry:Organization_HPIO.item.identifier.system, List.entry:Organization_HPIO.item.identifier.value, List.entry:Organization_HPIO.item.identifier.period, List.entry:Organization_HPIO.item.identifier.assigner, List.entry:Organization_HPIO.item.display, List.entry:Organization_HSPO, List.entry:Organization_HSPO.extension, List.entry:Organization_HSPO.modifierExtension, List.entry:Organization_HSPO.flag, List.entry:Organization_HSPO.deleted, List.entry:Organization_HSPO.date, List.entry:Organization_HSPO.item, List.entry:Organization_HSPO.item.extension, List.entry:Organization_HSPO.item.reference, List.entry:Organization_HSPO.item.type, List.entry:Organization_HSPO.item.identifier, List.entry:Organization_HSPO.item.identifier.extension, List.entry:Organization_HSPO.item.identifier.use, List.entry:Organization_HSPO.item.identifier.type, List.entry:Organization_HSPO.item.identifier.system, List.entry:Organization_HSPO.item.identifier.value, List.entry:Organization_HSPO.item.identifier.period, List.entry:Organization_HSPO.item.identifier.assigner, List.entry:Organization_HSPO.item.display, List.entry:HCPD_Local, List.entry:HCPD_Local.extension, List.entry:HCPD_Local.modifierExtension, List.entry:HCPD_Local.flag, List.entry:HCPD_Local.deleted, List.entry:HCPD_Local.date, List.entry:HCPD_Local.item, List.entry:HCPD_Local.item.extension, List.entry:HCPD_Local.item.reference, List.entry:HCPD_Local.item.type, List.entry:HCPD_Local.item.identifier, List.entry:HCPD_Local.item.identifier.extension, List.entry:HCPD_Local.item.identifier.use, List.entry:HCPD_Local.item.identifier.type, List.entry:HCPD_Local.item.identifier.system, List.entry:HCPD_Local.item.identifier.value, List.entry:HCPD_Local.item.identifier.period, List.entry:HCPD_Local.item.identifier.assigner, List.entry:HCPD_Local.item.display, List.emptyReason | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | List.extension, List.modifierExtension, List.entry.extension, List.entry.modifierExtension, List.entry:Practitioner.extension, List.entry:Practitioner.modifierExtension, List.entry:Practitioner.item.extension, List.entry:Practitioner.item.identifier.extension, List.entry:Organization_HPIO.extension, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HPIO.item.extension, List.entry:Organization_HPIO.item.identifier.extension, List.entry:Organization_HSPO.extension, List.entry:Organization_HSPO.modifierExtension, List.entry:Organization_HSPO.item.extension, List.entry:Organization_HSPO.item.identifier.extension, List.entry:HCPD_Local.extension, List.entry:HCPD_Local.modifierExtension, List.entry:HCPD_Local.item.extension, List.entry:HCPD_Local.item.identifier.extension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
lst-1 | error | List | A list can only have an emptyReason if it is empty | `emptyReason.empty() or entry.empty()`
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" | `mode = 'changes' or entry.deleted.empty()`
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" | `mode = 'working' or entry.date.empty()`

This structure is derived from List

Summary

Mandatory: 2 elements(8 nested mandatory elements)
Must-Support: 10 elements
Fixed: 4 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of List.entry

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
List | C | 0..* | List(4.0.1) | HCPD BDE List Resource for Bulk Data Extract Constraints: lst-1, lst-2, lst-3
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title | S Σ | 1..1 | string | Fixed title for HCPD removal list Required Pattern: HCPD Resources for Removal
Slices for entry | S C | 1..* | BackboneElement | Identifiers for removal by HCPD client systems Slice: Unordered, Open by pattern:item.identifier.system
entry:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
entry:Practitioner | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HPI-I identifier for practitioner removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
entry:Organization_HPIO | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HPI-O identifier for organization removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
entry:Organization_HSPO | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HSP-O identifier for organization removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hspo/1.0
entry:HCPD_Local | C | 0..* | BackboneElement | Entries in the list
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
item |  | 1..1 | Reference(Resource) | Actual entry
identifier | S Σ | 1..1 | Identifier | HCPD local identifier for Location, HealthcareService, Endpoint, or PractitionerRole removal
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | List | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | List.implicitRules, List.modifierExtension, List.status, List.mode, List.title, List.entry, List.entry.modifierExtension, List.entry.deleted, List.entry.item, List.entry:Practitioner, List.entry:Practitioner.modifierExtension, List.entry:Practitioner.deleted, List.entry:Practitioner.item, List.entry:Practitioner.item.identifier, List.entry:Practitioner.item.identifier.use, List.entry:Practitioner.item.identifier.system, List.entry:Organization_HPIO, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HPIO.deleted, List.entry:Organization_HPIO.item, List.entry:Organization_HPIO.item.identifier, List.entry:Organization_HPIO.item.identifier.use, List.entry:Organization_HPIO.item.identifier.system, List.entry:Organization_HSPO, List.entry:Organization_HSPO.modifierExtension, List.entry:Organization_HSPO.deleted, List.entry:Organization_HSPO.item, List.entry:Organization_HSPO.item.identifier, List.entry:Organization_HSPO.item.identifier.use, List.entry:Organization_HSPO.item.identifier.system, List.entry:HCPD_Local, List.entry:HCPD_Local.modifierExtension, List.entry:HCPD_Local.deleted, List.entry:HCPD_Local.item, List.entry:HCPD_Local.item.identifier, List.entry:HCPD_Local.item.identifier.use, List.entry:HCPD_Local.item.identifier.system | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | List.modifierExtension, List.entry.modifierExtension, List.entry:Practitioner.modifierExtension, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HSPO.modifierExtension, List.entry:HCPD_Local.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
lst-1 | error | List | A list can only have an emptyReason if it is empty | `emptyReason.empty() or entry.empty()`
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" | `mode = 'changes' or entry.deleted.empty()`
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" | `mode = 'working' or entry.date.empty()`

Differential View

This structure is derived from List

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
List |  | 0..* | List(4.0.1) | HCPD BDE List Resource for Bulk Data Extract
status |  | 1..1 | code | current | retired | entered-in-error Required Pattern: current
mode |  | 1..1 | code | working | snapshot | changes Required Pattern: working
title | S | 1..1 | string | Fixed title for HCPD removal list Required Pattern: HCPD Resources for Removal
Slices for entry | S | 1..* | BackboneElement | Identifiers for removal by HCPD client systems Slice: Unordered, Open by pattern:item.identifier.system
entry:Practitioner |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HPI-I identifier for practitioner removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
entry:Organization_HPIO |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HPI-O identifier for organization removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
entry:Organization_HSPO |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HSP-O identifier for organization removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hspo/1.0
entry:HCPD_Local |  | 0..* | BackboneElement | Entries in the list
item |  |  |  |
identifier | S | 1..1 | Identifier | HCPD local identifier for Location, HealthcareService, Endpoint, or PractitionerRole removal
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
List | C | 0..* | List(4.0.1) | HCPD BDE List Resource for Bulk Data Extract Constraints: lst-1, lst-2, lst-3
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier |  | 0..* | Identifier | Business identifier
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working
title | S Σ | 1..1 | string | Fixed title for HCPD removal list Required Pattern: HCPD Resources for Removal
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject
encounter |  | 0..1 | Reference(Encounter) | Context in which list created
date | Σ | 0..1 | dateTime | When the list was prepared
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author)
orderedBy |  | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
note |  | 0..* | Annotation | Comments about the list
Slices for entry | S C | 1..* | BackboneElement | Identifiers for removal by HCPD client systems Slice: Unordered, Open by pattern:item.identifier.system
entry:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
entry:Practitioner | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HPI-I identifier for practitioner removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
entry:Organization_HPIO | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HPI-O identifier for organization removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hpio/1.0
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
entry:Organization_HSPO | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HSP-O identifier for organization removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/hi/hspo/1.0
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
entry:HCPD_Local | C | 0..* | BackboneElement | Entries in the list
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
flag |  | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.
deleted | ?!C | 0..1 | boolean | If this item is actually marked as deleted
date |  | 0..1 | dateTime | When item added to list
item |  | 1..1 | Reference(Resource) | Actual entry
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
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 | S Σ | 1..1 | Identifier | HCPD local identifier for Location, HealthcareService, Endpoint, or PractitionerRole removal
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..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.
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://digitalhealth.gov.au/fhir/hcpd/id/hcpd-local-identifier
value | Σ | 0..1 | string | The value that is unique 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)
display | Σ | 0..1 | string | Text alternative for the resource
emptyReason | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.code | Base | example | Example Use Codes for List | 📍4.0.1 | FHIR Std.
List.orderedBy | Base | preferred | List Order Codes | 📍4.0.1 | FHIR Std.
List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Practitioner.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HPIO.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:Organization_HSPO.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.entry:HCPD_Local.​item.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | List | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | List | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | List | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | List.meta, List.implicitRules, List.language, List.text, List.extension, List.modifierExtension, List.identifier, List.status, List.mode, List.title, List.code, List.subject, List.encounter, List.date, List.source, List.orderedBy, List.note, List.entry, List.entry.extension, List.entry.modifierExtension, List.entry.flag, List.entry.deleted, List.entry.date, List.entry.item, List.entry:Practitioner, List.entry:Practitioner.extension, List.entry:Practitioner.modifierExtension, List.entry:Practitioner.flag, List.entry:Practitioner.deleted, List.entry:Practitioner.date, List.entry:Practitioner.item, List.entry:Practitioner.item.extension, List.entry:Practitioner.item.reference, List.entry:Practitioner.item.type, List.entry:Practitioner.item.identifier, List.entry:Practitioner.item.identifier.extension, List.entry:Practitioner.item.identifier.use, List.entry:Practitioner.item.identifier.type, List.entry:Practitioner.item.identifier.system, List.entry:Practitioner.item.identifier.value, List.entry:Practitioner.item.identifier.period, List.entry:Practitioner.item.identifier.assigner, List.entry:Practitioner.item.display, List.entry:Organization_HPIO, List.entry:Organization_HPIO.extension, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HPIO.flag, List.entry:Organization_HPIO.deleted, List.entry:Organization_HPIO.date, List.entry:Organization_HPIO.item, List.entry:Organization_HPIO.item.extension, List.entry:Organization_HPIO.item.reference, List.entry:Organization_HPIO.item.type, List.entry:Organization_HPIO.item.identifier, List.entry:Organization_HPIO.item.identifier.extension, List.entry:Organization_HPIO.item.identifier.use, List.entry:Organization_HPIO.item.identifier.type, List.entry:Organization_HPIO.item.identifier.system, List.entry:Organization_HPIO.item.identifier.value, List.entry:Organization_HPIO.item.identifier.period, List.entry:Organization_HPIO.item.identifier.assigner, List.entry:Organization_HPIO.item.display, List.entry:Organization_HSPO, List.entry:Organization_HSPO.extension, List.entry:Organization_HSPO.modifierExtension, List.entry:Organization_HSPO.flag, List.entry:Organization_HSPO.deleted, List.entry:Organization_HSPO.date, List.entry:Organization_HSPO.item, List.entry:Organization_HSPO.item.extension, List.entry:Organization_HSPO.item.reference, List.entry:Organization_HSPO.item.type, List.entry:Organization_HSPO.item.identifier, List.entry:Organization_HSPO.item.identifier.extension, List.entry:Organization_HSPO.item.identifier.use, List.entry:Organization_HSPO.item.identifier.type, List.entry:Organization_HSPO.item.identifier.system, List.entry:Organization_HSPO.item.identifier.value, List.entry:Organization_HSPO.item.identifier.period, List.entry:Organization_HSPO.item.identifier.assigner, List.entry:Organization_HSPO.item.display, List.entry:HCPD_Local, List.entry:HCPD_Local.extension, List.entry:HCPD_Local.modifierExtension, List.entry:HCPD_Local.flag, List.entry:HCPD_Local.deleted, List.entry:HCPD_Local.date, List.entry:HCPD_Local.item, List.entry:HCPD_Local.item.extension, List.entry:HCPD_Local.item.reference, List.entry:HCPD_Local.item.type, List.entry:HCPD_Local.item.identifier, List.entry:HCPD_Local.item.identifier.extension, List.entry:HCPD_Local.item.identifier.use, List.entry:HCPD_Local.item.identifier.type, List.entry:HCPD_Local.item.identifier.system, List.entry:HCPD_Local.item.identifier.value, List.entry:HCPD_Local.item.identifier.period, List.entry:HCPD_Local.item.identifier.assigner, List.entry:HCPD_Local.item.display, List.emptyReason | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | List.extension, List.modifierExtension, List.entry.extension, List.entry.modifierExtension, List.entry:Practitioner.extension, List.entry:Practitioner.modifierExtension, List.entry:Practitioner.item.extension, List.entry:Practitioner.item.identifier.extension, List.entry:Organization_HPIO.extension, List.entry:Organization_HPIO.modifierExtension, List.entry:Organization_HPIO.item.extension, List.entry:Organization_HPIO.item.identifier.extension, List.entry:Organization_HSPO.extension, List.entry:Organization_HSPO.modifierExtension, List.entry:Organization_HSPO.item.extension, List.entry:Organization_HSPO.item.identifier.extension, List.entry:HCPD_Local.extension, List.entry:HCPD_Local.modifierExtension, List.entry:HCPD_Local.item.extension, List.entry:HCPD_Local.item.identifier.extension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
lst-1 | error | List | A list can only have an emptyReason if it is empty | `emptyReason.empty() or entry.empty()`
lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" | `mode = 'changes' or entry.deleted.empty()`
lst-3 | error | List | An entry date can only be used if the mode of the list is "working" | `mode = 'working' or entry.date.empty()`

This structure is derived from List

Summary

Mandatory: 2 elements(8 nested mandatory elements)
Must-Support: 10 elements
Fixed: 4 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of List.entry

Other representations of profile: CSV, Excel, Schematron