AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

Resource Profile: AU Base Endpoint

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-endpoint Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 1 Computable Name: AUBaseEndpoint

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines an endpoint structure that localises core concepts, including terminology, for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

Potentially useful extensions:

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • New Content

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Endpoint 0..* Endpoint(4.0.1) An endpoint in an Australian healthcare context
    Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Endpoint.Slices for extension Content/Rules for all slices
    Endpoint.Slices for extension.extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
    URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
    Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
    Constraints: ext-1
    Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
    Binding: EndpointStatus (required): The status of the endpoint.
    Endpoint.connectionType This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
    Binding: Endpoint Connection Type - AU Extended (extensible)
    Endpoint.payloadType This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    Binding: Endpoint Payload Type - AU Extended (preferred)
    Endpoint.address This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
    Endpoint.connectionType Base extensible Endpoint Connection Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadType Base preferred Endpoint Payload Type - AU Extended 📦7.0.0-ci-build This IG

    Constraints

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

    This structure is derived from Endpoint

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Endpoint 0..* Endpoint(4.0.1) An endpoint in an Australian healthcare context
    Endpoint.Slices for extension Content/Rules for all slices
    Endpoint.Slices for extension.extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
    URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
    Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
    Endpoint.connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
    Binding: Endpoint Connection Type - AU Extended (extensible)
    Endpoint.payloadType 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    Binding: Endpoint Payload Type - AU Extended (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Endpoint.connectionType Base extensible Endpoint Connection Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadType Base preferred Endpoint Payload Type - AU Extended 📦7.0.0-ci-build This IG
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Endpoint 0..* Endpoint(4.0.1) An endpoint in an Australian healthcare context
    Endpoint.id This element is included in summaries. 0..1 id Logical id of this artifact
    Endpoint.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Endpoint.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Endpoint.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
    Endpoint.contained 0..* Resource Contained, inline Resources
    Endpoint.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Endpoint.Slices for extension.extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
    URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
    Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
    Constraints: ext-1
    Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Endpoint.identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
    Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
    Binding: EndpointStatus (required): The status of the endpoint.
    Endpoint.connectionType This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
    Binding: Endpoint Connection Type - AU Extended (extensible)
    Endpoint.name This element is included in summaries. 0..1 string A name that this endpoint can be identified by
    Endpoint.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
    Endpoint.contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
    Endpoint.period This element is included in summaries. 0..1 Period Interval the endpoint is expected to be operational
    Endpoint.payloadType This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    Binding: Endpoint Payload Type - AU Extended (preferred)
    Endpoint.payloadMimeType This element is included in summaries. 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.
    Endpoint.address This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint
    Endpoint.header 0..* string Usage depends on the channel type

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Endpoint.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
    Endpoint.connectionType Base extensible Endpoint Connection Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadType Base preferred Endpoint Payload Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

    Constraints

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

    This structure is derived from Endpoint

    Summary

    Extensions

    This structure refers to these extensions:

    Maturity: 1

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Endpoint 0..* Endpoint(4.0.1) An endpoint in an Australian healthcare context
    Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Endpoint.Slices for extension Content/Rules for all slices
    Endpoint.Slices for extension.extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
    URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
    Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
    Constraints: ext-1
    Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
    Binding: EndpointStatus (required): The status of the endpoint.
    Endpoint.connectionType This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
    Binding: Endpoint Connection Type - AU Extended (extensible)
    Endpoint.payloadType This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    Binding: Endpoint Payload Type - AU Extended (preferred)
    Endpoint.address This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
    Endpoint.connectionType Base extensible Endpoint Connection Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadType Base preferred Endpoint Payload Type - AU Extended 📦7.0.0-ci-build This IG

    Constraints

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

    Differential View

    This structure is derived from Endpoint

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Endpoint 0..* Endpoint(4.0.1) An endpoint in an Australian healthcare context
    Endpoint.Slices for extension Content/Rules for all slices
    Endpoint.Slices for extension.extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
    URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
    Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
    Endpoint.connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
    Binding: Endpoint Connection Type - AU Extended (extensible)
    Endpoint.payloadType 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    Binding: Endpoint Payload Type - AU Extended (preferred)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Endpoint.connectionType Base extensible Endpoint Connection Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadType Base preferred Endpoint Payload Type - AU Extended 📦7.0.0-ci-build This IG

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Endpoint 0..* Endpoint(4.0.1) An endpoint in an Australian healthcare context
    Endpoint.id This element is included in summaries. 0..1 id Logical id of this artifact
    Endpoint.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Endpoint.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Endpoint.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
    Endpoint.contained 0..* Resource Contained, inline Resources
    Endpoint.Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    Endpoint.Slices for extension.extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
    URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
    Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
    Constraints: ext-1
    Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Endpoint.identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
    Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
    Binding: EndpointStatus (required): The status of the endpoint.
    Endpoint.connectionType This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
    Binding: Endpoint Connection Type - AU Extended (extensible)
    Endpoint.name This element is included in summaries. 0..1 string A name that this endpoint can be identified by
    Endpoint.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
    Endpoint.contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
    Endpoint.period This element is included in summaries. 0..1 Period Interval the endpoint is expected to be operational
    Endpoint.payloadType This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
    Binding: Endpoint Payload Type - AU Extended (preferred)
    Endpoint.payloadMimeType This element is included in summaries. 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.
    Endpoint.address This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint
    Endpoint.header 0..* string Usage depends on the channel type

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Endpoint.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
    Endpoint.connectionType Base extensible Endpoint Connection Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadType Base preferred Endpoint Payload Type - AU Extended 📦7.0.0-ci-build This IG
    Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

    Constraints

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

    This structure is derived from Endpoint

    Summary

    Extensions

    This structure refers to these extensions:

    Maturity: 1

     

    Other representations of profile: CSV, Excel, Schematron