Helix AU Core
0.1.0 - ci-build

Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Helix AU Core Endpoint

Official URL: http://medicaldirector.com/fhir/helix-au-core/StructureDefinition/HelixAUCoreEndpoint Version: 0.1.0
Draft as of 2025-08-12 Computable Name: HelixAUCoreEndpoint

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... 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
.... extension:receiving-facility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey Identifies this endpoint across multiple systems
.... identifier:hpi-o Σ 0..1 AUHPIO Identifies this endpoint across multiple systems
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEndpointIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... 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
... Slices for identifier S 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey Identifies this endpoint across multiple systems
.... identifier:hpi-o 0..1 AUHPIO Identifies this endpoint across multiple systems

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... 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
... 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
.... extension:receiving-facility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey Identifies this endpoint across multiple systems
.... identifier:hpi-o Σ 0..1 AUHPIO Identifies this endpoint across multiple systems
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
... name Σ 0..1 string A name that this endpoint can be identified by
... 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 The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... 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 The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEndpointIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Endpoint.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... 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
.... extension:receiving-facility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey Identifies this endpoint across multiple systems
.... identifier:hpi-o Σ 0..1 AUHPIO Identifies this endpoint across multiple systems
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEndpointIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... 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
... Slices for identifier S 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:authoring-key S 1..1 HelixBaseAuthoringKey Identifies this endpoint across multiple systems
.... identifier:hpi-o 0..1 AUHPIO Identifies this endpoint across multiple systems

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services
... 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
... 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
.... extension:receiving-facility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:type
.... identifier:authoring-key SΣ 1..1 HelixBaseAuthoringKey Identifies this endpoint across multiple systems
.... identifier:hpi-o Σ 0..1 AUHPIO Identifies this endpoint across multiple systems
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
... name Σ 0..1 string A name that this endpoint can be identified by
... 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 The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... 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 The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionType
http://hl7.org/fhir/ValueSet/endpoint-connection-type
From the FHIR Standard
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
From the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorEndpointIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Endpoint.identifier

 

Other representations of profile: CSV, Excel, Schematron