# Health Connect Australia Provider Directory FHIR Implementation Guide

26.0.0 - Snapshot HL7 AU Connectathon Aug 25 & 26, 2026

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-Snapshot-26.0.0-HL7AU-Connectathon-Aug-25-26/ and changes regularly. See the Directory of published versions

## Resource Profile: HCPD Endpoint

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint | Version: 26.0.0
Active as of 2026-08-14 | Computable Name: HCPD_Endpoint
Copyright/Legal: 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 Health Connect Provider Directory entry for a technical endpoint.

No data is entered directly into Health Connect; all Directory content is sourced from authoritative systems including PCA, HI-Service, and NHSD.

### Extensions

Extensions introduced in this profile:

- Endpoint: AU Receiving Facility
- Endpoint: AU Receiving Application
- Endpoint: Encryption Certificate PEM X509
- Endpoint: Suppressed
- Endpoint: Deactivated

### Visibility and Suppression

The HCPD Endpoint profile supports the Suppressed extension, however its application is conceptually driven by organizational visibility decisions. When an HCPD Organization elects to hide their visibility from those searching the Health Connect Provider Directory system by applying the suppressed extension with an `organisation-initiated` code, all associated Endpoint resources (whether referenced from HealthcareService, Location, or PractitionerRole) are automatically suppressed and excluded from Provider Directory listings. This cascading suppression ensures that when an organization chooses to hide their visibility, related endpoints "come for the ride" and are similarly hidden from display, maintaining consistency across the directory.

### Usage notes

The following guidance expands on operational and implementation expectations for this Endpoint profile.

- Purpose: An `Endpoint` in Health Connect describes how to communicate with a service (address, protocol, payloads and contact details). Directory consumers use this information to establish connections, and operational tooling uses it to monitor and validate connectivity.

#### Guidance on the use of endpoints

The HCPD IG offers flexibility with the use of endpoints. The IG supports referencing an endpoint from the HealthcareService, Location & PractitionerRole resources. The recommended hierarchy for when endpoints SHOULD be applied is as follows:

- When a HealthcareService, with it's associated referenced Location and PractitionerRoles exist within the same space then an endpoint at this level is suggested.

- When a Location requires differentiation from the referenced HealthcareService due to operational or business requirements, then referencing an endpoint at this level may make sense for the particular use case.

- If a high degree of granular communication is required then referencing an endpoint from the PractitionerRole resource could be applicable.

#### Implementation requirements vs. processing

Implementers SHALL process all elements marked as Must Support (MS) in this profile to be conformant. However, certain elements that are mandatory do not need to be processed by Health Connect Provider Directory Requester Actors.

#### Initial endpoint scope and future expansion

Health Connect initially expects published `Endpoint` resources to describe Secure Messaging endpoints (SMD-capable targets and related secure messaging transports). Requesters and search clients should expect SMD-specific metadata and prioritise handling SMD attributes (SMD Target Identifier, encryption certificate, and routing identifiers). Over time, clients may be able to handle additional protocol metadata (for example, FHIR REST endpoint details) as publishers begin to expose FHIR and other transport types.

#### Identifiers and stable handles

The Endpoint profile uses two stable identifier slices for Directory management and routing:

- HCPD Local Identifier (HCPD-LI) - Unique identifier attributed by the HCPD system.

- HCPD SMD Target Identifier - a slice used only when the endpoint (or associated practitioner/service) supports Secure Messaging Delivery (SMD). When present the SMD identifier SHALL be globally unique and SHALL be treated as an immutable routing handle for secure point‑to‑point or hub‑mediated messaging. Publishers SHOULD only populate this slice for endpoints that actually support SMD.

### Reciprocal relationships

In FHIR, linkage to resources is owned by the referencing resources (`HealthcareService.endpoint`, `PractitionerRole.endpoint`, `Location.endpoint`). The Endpoint resource itself has no back‑reference slots to those resources. Consequently:

- Reciprocity cannot be enforced within the Endpoint profile (there is no standard element on Endpoint to list referencing HealthcareService / Location / PractitionerRole resources).
- Directory governance MUST ensure that when a referencing resource adds or removes an Endpoint, any operational expectations (availability, deprecation, auditing) are handled in process.

#### Invariants

##### Invariant: inv-ep-01-status-values

Description: Endpoint.`status` must be `active`, `suspended`, or `off`. The `error` and `test` statuses are not used in HCPD.

Implementation note: This rule is enforced as an error - HCPD only recognises active, suspended, and off states for an Endpoint. Publishing systems MUST NOT set `status` to `error` or `test`. When an Endpoint is no longer available it should be set to `off`; `suspended` may be used when the endpoint is temporarily unavailable.

Usages:

- Refer to this Profile: HCPD HealthcareService, HCPD Location, HCPD PractitionerRole and HCPD Provenance
- Examples for this Profile: Sydney Private Clinic – FHIR Referral Endpoint and Sydney General Hospital SMD Endpoint
- CapabilityStatements using this Profile: Health Connect Provider Directory 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
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint(4.0.1) | Health Connect Endpoint Constraints: inv-01-status-values
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:receiving-facility | SO | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:receiving-application | SO | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:encryption-certificate-pem-x509 | SO | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:suppressed | SO | 0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHALL:ignore | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | SO Σ | 2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
identifier:HCPD_SMD_Target_Identifier | S Σ | 0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier
identifier:HCPD_Source_Identifier | S Σ | 1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD.
identifier:HCPD_Local_Identifier | S Σ | 1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint
status | ?!SO Σ | 1..1 | code | Only endpoints with status ‘Active’ are exposed externally. Binding: EndpointStatus (required): The status of the endpoint.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
connectionType | SO Σ | 1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
name | SO Σ | 0..1 | string | To enable consistent and correct identification of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadType | SO Σ | 1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadMimeType | SO Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
address | SO Σ | 1..1 | url | URL address of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.extension:suppressed.​extension:suppressedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.extension:deactivated.​extension:deactivatedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-status-values | error | Endpoint | Endpoint.status must be 'active', 'suspended', or 'off'. The 'error' and 'test' statuses are not used in HCPD. | `status = 'active' or status = 'suspended' or status = 'off'`

This structure is derived from Endpoint

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint(4.0.1) | Health Connect Endpoint
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receiving-facility | SO | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:receiving-application | SO | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:encryption-certificate-pem-x509 | SO | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:suppressed | SO | 0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHALL:ignore | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
Slices for identifier | SO | 2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
identifier:HCPD_SMD_Target_Identifier | S | 0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier
identifier:HCPD_Source_Identifier | S | 1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD.
identifier:HCPD_Local_Identifier | S | 1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint
status | SO | 1..1 | code | Only endpoints with status ‘Active’ are exposed externally.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
connectionType | SO | 1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
name | SO | 0..1 | string | To enable consistent and correct identification of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadType | SO | 1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadMimeType | SO | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
address | SO | 1..1 | url | URL address of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-status-values | error | Endpoint | Endpoint.status must be 'active', 'suspended', or 'off'. The 'error' and 'test' statuses are not used in HCPD. | `status = 'active' or status = 'suspended' or status = 'off'`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint(4.0.1) | Health Connect Endpoint Constraints: inv-01-status-values
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:receiving-facility | SO | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:receiving-application | SO | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:encryption-certificate-pem-x509 | SO | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:suppressed | SO | 0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
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
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHALL:ignore | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
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
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | SO Σ | 2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
identifier:HCPD_SMD_Target_Identifier | S Σ | 0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier
identifier:HCPD_Source_Identifier | S Σ | 1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD.
identifier:HCPD_Local_Identifier | S Σ | 1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint
status | ?!SO Σ | 1..1 | code | Only endpoints with status ‘Active’ are exposed externally. Binding: EndpointStatus (required): The status of the endpoint.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
connectionType | SO Σ | 1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
name | SO Σ | 0..1 | string | To enable consistent and correct identification of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact |  | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting)
period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational
payloadType | SO Σ | 1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadMimeType | SO Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
address | SO Σ | 1..1 | url | URL address of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Endpoint.extension:suppressed.​extension:suppressedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.extension:deactivated.​extension:deactivatedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-status-values | error | Endpoint | Endpoint.status must be 'active', 'suspended', or 'off'. The 'error' and 'test' statuses are not used in HCPD. | `status = 'active' or status = 'suspended' or status = 'off'`

This structure is derived from Endpoint

Summary

Mandatory: 2 elements
Must-Support: 17 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- HCPD SMD Target Identifier (HCPD-SMDTI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-smd-target-identifier|26.0.0)
- HCPD Source Identifier (HCPD-SI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-source-identifier|26.0.0)
- HCPD Local Identifier (HCPD-LI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-local-identifier|26.0.0)

Extensions

This structure refers to these extensions:

- http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility|6.0.0
- http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication|6.0.0
- http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509|6.0.0
- http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed|26.0.0
- http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated|26.0.0

Slices

This structure defines the following Slices:

- The element 2 is sliced based on the values of Endpoint.identifier

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint(4.0.1) | Health Connect Endpoint Constraints: inv-01-status-values
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:receiving-facility | SO | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:receiving-application | SO | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:encryption-certificate-pem-x509 | SO | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:suppressed | SO | 0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHALL:ignore | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | SO Σ | 2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
identifier:HCPD_SMD_Target_Identifier | S Σ | 0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier
identifier:HCPD_Source_Identifier | S Σ | 1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD.
identifier:HCPD_Local_Identifier | S Σ | 1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint
status | ?!SO Σ | 1..1 | code | Only endpoints with status ‘Active’ are exposed externally. Binding: EndpointStatus (required): The status of the endpoint.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
connectionType | SO Σ | 1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
name | SO Σ | 0..1 | string | To enable consistent and correct identification of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadType | SO Σ | 1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadMimeType | SO Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
address | SO Σ | 1..1 | url | URL address of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.extension:suppressed.​extension:suppressedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.extension:deactivated.​extension:deactivatedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-status-values | error | Endpoint | Endpoint.status must be 'active', 'suspended', or 'off'. The 'error' and 'test' statuses are not used in HCPD. | `status = 'active' or status = 'suspended' or status = 'off'`

Differential View

This structure is derived from Endpoint

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint(4.0.1) | Health Connect Endpoint
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receiving-facility | SO | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:receiving-application | SO | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:encryption-certificate-pem-x509 | SO | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:suppressed | SO | 0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHALL:ignore | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy |  | 1..1 | Extension | Extension
value[x] |  |  |  |
coding | S | 1..1 | Coding | Code defined by a terminology system Fixed Value: As shown (Organisation initiated)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
Slices for identifier | SO | 2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
identifier:HCPD_SMD_Target_Identifier | S | 0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier
identifier:HCPD_Source_Identifier | S | 1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD.
identifier:HCPD_Local_Identifier | S | 1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint
status | SO | 1..1 | code | Only endpoints with status ‘Active’ are exposed externally.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
connectionType | SO | 1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
name | SO | 0..1 | string | To enable consistent and correct identification of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadType | SO | 1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadMimeType | SO | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
address | SO | 1..1 | url | URL address of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-status-values | error | Endpoint | Endpoint.status must be 'active', 'suspended', or 'off'. The 'error' and 'test' statuses are not used in HCPD. | `status = 'active' or status = 'suspended' or status = 'off'`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint(4.0.1) | Health Connect Endpoint Constraints: inv-01-status-values
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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:receiving-facility | SO | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:receiving-application | SO | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:encryption-certificate-pem-x509 | SO | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
extension:suppressed | SO | 0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:suppressedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "suppressedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
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
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
extension:includeSelf | S | 0..1 | Extension | Controls Organization self-suppression Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "includeSelf"
value[x] | S | 0..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed"
extension:deactivated | SO | 0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHALL:ignore | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:deactivatedBy | S | 1..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "deactivatedBy"
value[x] | S | 1..1 | CodeableConcept | Value of extension
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
coding | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: As shown (Organisation initiated)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: organisation-initiated
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
url |  | 1..1 | uri | "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
Slices for identifier | SO Σ | 2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
identifier:HCPD_SMD_Target_Identifier | S Σ | 0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier
identifier:HCPD_Source_Identifier | S Σ | 1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD.
identifier:HCPD_Local_Identifier | S Σ | 1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint
status | ?!SO Σ | 1..1 | code | Only endpoints with status ‘Active’ are exposed externally. Binding: EndpointStatus (required): The status of the endpoint.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
connectionType | SO Σ | 1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
name | SO Σ | 0..1 | string | To enable consistent and correct identification of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact |  | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting)
period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational
payloadType | SO Σ | 1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
payloadMimeType | SO Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
address | SO Σ | 1..1 | url | URL address of the endpoint
Obligations | Actor
SHALL:populate-if-known | Health Connect Provider Directory Responder Actor
SHOULD:handle | Health Connect Provider Directory Requester Actor
SHOULD:handle | Health Connect Provider Directory Bulk Export Requester Actor
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Endpoint.extension:suppressed.​extension:suppressedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.extension:deactivated.​extension:deactivatedBy.​value[x].coding | Base | required | Responsible Party Type | 📍26.0.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📍2.1.0-ci-build | AU Provider Directory Implementation Guide vnull
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
inv-01-status-values | error | Endpoint | Endpoint.status must be 'active', 'suspended', or 'off'. The 'error' and 'test' statuses are not used in HCPD. | `status = 'active' or status = 'suspended' or status = 'off'`

This structure is derived from Endpoint

Summary

Mandatory: 2 elements
Must-Support: 17 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- HCPD SMD Target Identifier (HCPD-SMDTI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-smd-target-identifier|26.0.0)
- HCPD Source Identifier (HCPD-SI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-source-identifier|26.0.0)
- HCPD Local Identifier (HCPD-LI) (http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-local-identifier|26.0.0)

Extensions

This structure refers to these extensions:

- http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility|6.0.0
- http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication|6.0.0
- http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509|6.0.0
- http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed|26.0.0
- http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated|26.0.0

Slices

This structure defines the following Slices:

- The element 2 is sliced based on the values of Endpoint.identifier

Other representations of profile: CSV, Excel, Schematron

### Notes:

### Search parameters

This IG defines and introduces several search parameters in addition to those inherited from R4, that make it easier to find and filter `HCPD Endpoint` resources in Health Connect implementations.

#### Search parameters defined in this IG

The following search parameters are defined by this IG and SHOULD be supported:

- `hcepi` (Endpoint.identifier where type = Resource Identifier)
  - Find endpoint records by the HCPD identifier assigned in Health Connect. Uses token matching for exact value matching.
  - Example: `GET /Endpoint?hcepi=EP001234567890`
- `payloadmimetype` (Endpoint.payloadMimeType)
  - Search for endpoints that advertise support for a specific MIME type for payloads.
- Typical values present in this IG's example data are:
  - `application/pdf`
  - `application/fhir+xml`
  - `application/fhir+json`
  - Example: `GET /Endpoint?payloadmimetype=application%2Ffhir%2Bjson`
- `epurl` (alias used in this IG for Endpoint.address)
  - Convenience alias used in this IG's documentation to search by endpoint address.
  - Example: `GET /Endpoint?epurl=https://smd.sydneyhospital.org.au/secure-messaging/endpoint`
- `suppressed` (Endpoint.extension where url = suppressedBy extension)
  - Search for endpoints by their suppression status. Use token semantics with a code from the Responsible Party Type CodeSystem.
  - Example (system|code): `GET /Endpoint?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|practitioner-initiated`
  - Example (code only): `GET /Endpoint?suppressed=practitioner-initiated`
  - Example (system only): `GET /Endpoint?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|`

#### Search parameters from R4

The following search parameters are inherited from FHIR R4 and have been deemed useful for implementation within this IG. They SHOULD be supported:

- `name (R4)` (Endpoint.name)
  - Search for endpoints by name (partial matches may be supported).
  - Example: `GET /Endpoint?name=My%20GP%20Service`
- `connection-type (R4)` (Endpoint.connectionType)
  - Search for endpoints by connection type (for example, `hl7-fhir-rest` or other interface codes).
  - Example: `GET /Endpoint?connection-type=http://terminology.hl7.org.au/CodeSystem/endpoint-connection-type|secure-messaging`
- `payload-type (R4)` (Endpoint.payloadType)
  - Search for endpoints by payload type (CodeableConcept). Use AU PD Endpoint payload type ValueSet codes where applicable.
  - Example: `GET /Endpoint?payload-type=http://hl7.org.au/fhir/pd/CodeSystem/endpoint-payload-type|some-payload`
- `status (R4)` (Endpoint.status)
  - Filter endpoints by their operational status. Use token semantics with one of the defined status values: `active`, `suspended`, `error`, `off`, `entered-in-error`, `test`.
  - Example: `GET /Endpoint?status=active`

Note: Support for _id is mandatory for a responder and optional for a requester. Where the expectation for a search parameter differs between actors, the table below will reflect the stronger conformance requirement.

Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | ---
_id | SHOULD | `token` |
status (R4) | SHOULD | `token` |
hcepi | SHOULD | `token` |
name (R4) | SHOULD | `string` |
connection-type (R4) | SHOULD | `token` |
payload-type (R4) | SHOULD | `token` |
epurl | SHOULD | `uri` |
suppressed | SHOULD | `token` |
payloadmimetype | SHOULD | `token` |
name+connection-type | SHOULD | `string`+`token` |
name+payload-type | SHOULD | `string`+`token` |
connection-type+payloadmimetype | SHOULD | `token`+`token` |

### Search reverse include parameters

This implementation supports the following `_revinclude` parameters when searching for Endpoint resources:

- `_revinclude=HealthcareService:endpoint` - Include HealthcareService resources that reference this Endpoint
- `_revinclude=Location:endpoint` - Include Location resources that reference this Endpoint
- `_revinclude=PractitionerRole:endpoint` - Include PractitionerRole resources that reference this Endpoint
- `_revinclude=Provenance:target` - Include Provenance resources that track changes to this Endpoint

#### Example usage

    GET /Endpoint/303?_revinclude=HealthcareService:endpoint&_revinclude=Location:endpoint

This query returns the Endpoint resource along with all HealthcareServices and Locations that use this Endpoint.