Generated Narrative: StructureDefinition hcpd-endpoint Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Endpoint 0..* Endpoint(4.0.1) Health Connect Endpoint #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; 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 #xD; 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 #xD; extension:data-encipherment-certificate 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 #xD; Slices for identifier SO 1..* 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 #xD; identifier:HCPD_SMD_Target_Identifier S 0..* HCPD_SMD_Target_Identifier(26.0.0) SMD Target Identifier #xD; identifier:HCPD_Local_Identifier S 1..1 HCPD_Local_Identifier(26.0.0) Identifier attributed by the HCPD system for the Endpoint #xD; 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 #xD; 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 #xD; 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 #xD; 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 #xD; 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 #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
This profile defines a Health Connect Provider Directory entry for a technical endpoint.
Copyright © 2026 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)
Endpoint defined for use in Health Connect.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Values for routing HL7 V2 message payloads associated with an endpoint, suitable for MSH-6
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Values for routing HL7 V2 message payloads associated with an endpoint. Suitable for MSH-5.
Mechanism to hold the value of a X509 certificate as a string (base64 encoded PEM certificate).
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Unique identifier of the endpoint record
Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Secure Messaging Delivery target identifier for this endpoint
Identifier attributed by the HCPD system for the Endpoint
Unique identifier for the healthcare endpoint attributed from source system. Not a displayable field but can be used for system reference or internal business logic.
active | suspended | error | off | entered-in-error | test
active | suspended | error | off | test.
This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.
This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Protocol/Profile/Standard the endpoint supports.
For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.
To enable consistent and correct identification of the endpoint
A friendly name that this endpoint can be referred to with.
Organization that manages this endpoint (might not be the organization that exposes the endpoint)
The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.
Contact details for source (e.g. troubleshooting)
Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Interval the endpoint is expected to be operational
The interval during which the endpoint is expected to be operational.
REndpoint payload types that need to be transmitted over secure messaging, e.g. Discharge Summary, e-Referral, referral response message, acknowledgment etc.
The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.
The mime type of an attachment. Any valid mime type is allowed.
The uri that describes the actual end-point to connect to.
For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".
Additional headers / information to send as part of the notification.
Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.