Health Connect Australia Provider Directory FHIR Implementation Guide
26.0.0
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
| Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint | Version: 26.0.0 | |||
| Active as of 2026-11-03 | 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 introduced in this profile:
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.
The following guidance expands on operational and implementation expectations for this Endpoint profile.
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.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.
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.
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.
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.
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:
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:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| 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. |
| 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:  | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  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 |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
| |||||||||
| extension:receiving-application |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
| |||||||||
| extension:encryption-certificate-pem-x509 |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
| |||||||||
 extension:suppressed |
0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
| |||||||||
   Slices for extension |
Content/Rules for all slices | |||||||||||
  extension:suppressedBy |
1..1 | Extension | Who initiated the suppression | |||||||||
 value[x] |
||||||||||||
 coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||
| extension:deactivated |
0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
| |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation | |||||||||
| value[x] |
||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||
| Slices for identifier |
2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:HCPD_SMD_Target_Identifier |
0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier | |||||||||
| identifier:HCPD_Source_Identifier |
1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD. | |||||||||
 identifier:HCPD_Local_Identifier |
1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint | |||||||||
 status |
1..1 | code | Only endpoints with status ‘Active’ are exposed externally.
| |||||||||
| connectionType |
1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
| |||||||||
| name |
0..1 | string | To enable consistent and correct identification of the endpoint
| |||||||||
| payloadType |
1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
| |||||||||
| payloadMimeType |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
| |||||||||
| address |
1..1 | url | URL address of the endpoint
| |||||||||
| Documentation for this format | ||||||||||||
| 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 |
| 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: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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.
| |||||||||
| 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 |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility Constraints: ext-1
| |||||||||
| extension:receiving-application |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Constraints: ext-1
| |||||||||
| extension:encryption-certificate-pem-x509 |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 Constraints: ext-1
| |||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||
 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 |
1..1 | Extension | Who initiated the 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 | "suppressedBy" | |||||||||
| value[x] |
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 |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||
| extension:includeSelf |
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] |
0..1 | boolean | Value of extension | |||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||
| extension:deactivated |
0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||
| 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 |
1..1 | Extension | Who initiated the deactivation 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] |
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 |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||
| 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 |
2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:HCPD_SMD_Target_Identifier |
0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier | |||||||||
| identifier:HCPD_Source_Identifier |
1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD. | |||||||||
| identifier:HCPD_Local_Identifier |
1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint | |||||||||
| status |
1..1 | code | Only endpoints with status ‘Active’ are exposed externally. Binding: EndpointStatus (required): The status of the endpoint.
| |||||||||
| connectionType |
1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
| |||||||||
| name |
0..1 | string | To enable consistent and correct identification of the endpoint
| |||||||||
 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 |
1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
| |||||||||
| payloadMimeType |
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.
| |||||||||
| address |
1..1 | url | URL address of the endpoint
| |||||||||
| header |
0..* | string | Usage depends on the channel type | |||||||||
| Documentation for this format | ||||||||||||
| 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. |
| 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:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility Constraints: ext-1
| |||||||||
| extension:receiving-application |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Constraints: ext-1
| |||||||||
| extension:encryption-certificate-pem-x509 |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 Constraints: ext-1
| |||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||
| 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 |
1..1 | Extension | Who initiated the suppression Constraints: ext-1 | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||
| url |
1..1 | uri | "suppressedBy" | |||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||
| extension:includeSelf |
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] |
0..1 | boolean | Value of extension | |||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||
| extension:deactivated |
0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||
| 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 |
1..1 | Extension | Who initiated the deactivation Constraints: ext-1 | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||
| url |
1..1 | uri | "deactivatedBy" | |||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension | |||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||
| 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 |
2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:HCPD_SMD_Target_Identifier |
0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier | |||||||||
| identifier:HCPD_Source_Identifier |
1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD. | |||||||||
| identifier:HCPD_Local_Identifier |
1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint | |||||||||
| status |
1..1 | code | Only endpoints with status ‘Active’ are exposed externally. Binding: EndpointStatus (required): The status of the endpoint.
| |||||||||
| connectionType |
1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
| |||||||||
| name |
0..1 | string | To enable consistent and correct identification of the endpoint
| |||||||||
| payloadType |
1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
| |||||||||
| payloadMimeType |
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.
| |||||||||
| address |
1..1 | url | URL address of the endpoint
| |||||||||
| Documentation for this format | ||||||||||||
| 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. |
| 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: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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 |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
| |||||||||
| extension:receiving-application |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
| |||||||||
| extension:encryption-certificate-pem-x509 |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
| |||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed
| |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:suppressedBy |
1..1 | Extension | Who initiated the suppression | |||||||||
| value[x] |
||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||
| extension:deactivated |
0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated
| |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:deactivatedBy |
1..1 | Extension | Who initiated the deactivation | |||||||||
| value[x] |
||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: | |||||||||
| Slices for identifier |
2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:HCPD_SMD_Target_Identifier |
0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier | |||||||||
| identifier:HCPD_Source_Identifier |
1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD. | |||||||||
| identifier:HCPD_Local_Identifier |
1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint | |||||||||
| status |
1..1 | code | Only endpoints with status ‘Active’ are exposed externally.
| |||||||||
| connectionType |
1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
| |||||||||
| name |
0..1 | string | To enable consistent and correct identification of the endpoint
| |||||||||
| payloadType |
1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
| |||||||||
| payloadMimeType |
0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
| |||||||||
| address |
1..1 | url | URL address of the endpoint
| |||||||||
| Documentation for this format | ||||||||||||
| 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 |
| 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: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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.
| |||||||||
| 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 |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility Constraints: ext-1
| |||||||||
| extension:receiving-application |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication Constraints: ext-1
| |||||||||
| extension:encryption-certificate-pem-x509 |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 Constraints: ext-1
| |||||||||
| extension:suppressed |
0..1 | (Complex) | indicates whether the Endpoint should be hidden. URL: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed Constraints: ext-1
| |||||||||
| 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 |
1..1 | Extension | Who initiated the 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 | "suppressedBy" | |||||||||
| value[x] |
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 |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||
| extension:includeSelf |
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] |
0..1 | boolean | Value of extension | |||||||||
| url |
1..1 | uri | "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/suppressed" | |||||||||
| extension:deactivated |
0..1 | (Complex) | Indicates if Endpoint service is deactivated URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/deactivated Constraints: ext-1
| |||||||||
| 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 |
1..1 | Extension | Who initiated the deactivation 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] |
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 |
1..1 | Coding | Code defined by a terminology system Binding: ResponsiblePartyType_VS (26.0.0) (required) Fixed Value: | |||||||||
| 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 |
2..* | Identifier | Unique identifier of the endpoint record Slice: Unordered, Open by pattern:type, value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| identifier:HCPD_SMD_Target_Identifier |
0..1 | HCPD_SMD_Target_Identifier(26.0.0) | SMD Target Identifier | |||||||||
| identifier:HCPD_Source_Identifier |
1..1 | HCPD_Source_Identifier(26.0.0) | HC Endpoint Identifier attributed from source system. Source for Endpoint: NHSD. | |||||||||
| identifier:HCPD_Local_Identifier |
1..1 | HCPD_Local_Identifier(26.0.0) | Identifier attributed by the HCPD system for the Endpoint | |||||||||
| status |
1..1 | code | Only endpoints with status ‘Active’ are exposed externally. Binding: EndpointStatus (required): The status of the endpoint.
| |||||||||
| connectionType |
1..1 | Coding | To specify the service interface types Binding: AustralianServiceInterfaces (2.1.0-ci-build) (extensible)
| |||||||||
| name |
0..1 | string | To enable consistent and correct identification of the endpoint
| |||||||||
| 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 |
1..* | CodeableConcept | Endpoint payload type Binding: AustralianEndpointPayloadTypes (2.1.0-ci-build) (extensible)
| |||||||||
| payloadMimeType |
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.
| |||||||||
| address |
1..1 | url | URL address of the endpoint
| |||||||||
| header |
0..* | string | Usage depends on the channel type | |||||||||
| Documentation for this format | ||||||||||||
| 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. |
| 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:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
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.
The following search parameters are defined by this IG and SHOULD be supported:
hcepi (Endpoint.identifier where type = Resource Identifier)
GET /Endpoint?hcepi=EP001234567890payloadmimetype (Endpoint.payloadMimeType)
application/pdfapplication/fhir+xmlapplication/fhir+jsonGET /Endpoint?payloadmimetype=application%2Ffhir%2Bjsonepurl (alias used in this IG for Endpoint.address)
GET /Endpoint?epurl=https://smd.sydneyhospital.org.au/secure-messaging/endpointsuppressed (Endpoint.extension where url = suppressedBy extension)
GET /Endpoint?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|practitioner-initiatedGET /Endpoint?suppressed=practitioner-initiatedGET /Endpoint?suppressed=http://digitalhealth.gov.au/fhir/cc/CodeSystem/responsible-party-type|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)
GET /Endpoint?name=My%20GP%20Serviceconnection-type (R4) (Endpoint.connectionType)
hl7-fhir-rest or other interface codes).GET /Endpoint?connection-type=http://terminology.hl7.org.au/CodeSystem/endpoint-connection-type|secure-messagingpayload-type (R4) (Endpoint.payloadType)
GET /Endpoint?payload-type=http://hl7.org.au/fhir/pd/CodeSystem/endpoint-payload-type|some-payloadstatus (R4) (Endpoint.status)
active, suspended, error, off, entered-in-error, test.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 |
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 EndpointGET /Endpoint/303?_revinclude=HealthcareService:endpoint&_revinclude=Location:endpoint
This query returns the Endpoint resource along with all HealthcareServices and Locations that use this Endpoint.
IG © 2026+ Australian Digital Health Agency. Package au.gov.digitalhealth.fhir.hcpd#26.0.0 based on FHIR 4.0.1. Generated 2026-11-03
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
