AU Provider Directory Implementation Guide
2.1.0-ci-build - Draft

AU Provider Directory Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.1.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-pd/ and changes regularly. See the Directory of published versions

## Resource Profile: AU PD Secure Messaging Endpoint

Official URL: http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-sm-endpoint | Version: 2.1.0-ci-build
Standards status: Draft | Maturity Level: 0 | Computable Name: AUPDSecureMessagingEndpoint
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines content for describing details of an endpoint that would be adequate for addressing a secure message.

### Usage Notes

Profile specific implementation guidance:

At least one of the following defined identifier types, known to this profile, SHALL be supplied:

- PD Secure Messaging Delivery Target Identifier

Usages:

- Refer to this Profile: AU PD Healthcare Service and AU PD Practitioner Role
- Examples for this Profile: Telstra Health Secure Messaging Endpoint and Medical Objects Test Secure Messaging Endpoint

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint | Australian Secure Message Directory Endpoint Record Constraints: au-pd-ep-01
meta | Σ | 0..1 | Meta | Metadata on Endpoint
source | S Σ | 0..1 | uri | Identifies where the resource comes from
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:receivingFacility |  | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
extension:receivingApplication |  | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
extension:dataEnciphermentCertificate |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 0..* | PDSMDTargetIdentifier | Secure Messaging Target Identifier
status | ?!S Σ | 1..1 | code | Required status Binding: EndpointStatus (required): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
managingOrganization | S Σ | 1..1 | Reference(Organization) | Directory entry managing organisation
display | Σ | 1..1 | string | Directory entry managing organisation display details
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | S Σ | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible)
address | S Σ | 1..1 | url | URL address of the endpoint
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 | Australian Service Interfaces | 📦2.1.0-ci-build | This IG
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-ep-01 | error | Endpoint | At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint | Australian Secure Message Directory Endpoint Record Constraints: au-pd-ep-01
meta |  | 0..1 | Meta | Metadata on Endpoint
source | S | 0..1 | uri | Identifies where the resource comes from
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receivingFacility |  | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
extension:receivingApplication |  | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
extension:dataEnciphermentCertificate |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Slices for identifier | S | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S | 0..* | PDSMDTargetIdentifier | Secure Messaging Target Identifier
status | S | 1..1 | code | Required status
connectionType | S | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S | 0..1 | string | Friendly name for the endpoint
managingOrganization | S | 1..1 | Reference(Organization) | Directory entry managing organisation
display |  | 1..1 | string | Directory entry managing organisation display details
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | S | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible)
address | S | 1..1 | url | URL address of the endpoint
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📦2.1.0-ci-build | This IG
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-ep-01 | error | Endpoint | At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint | Australian Secure Message Directory Endpoint Record Constraints: au-pd-ep-01
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata on Endpoint
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | S Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receivingFacility |  | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
extension:receivingApplication |  | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
extension:dataEnciphermentCertificate |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 0..* | PDSMDTargetIdentifier | Secure Messaging Target Identifier
status | ?!S Σ | 1..1 | code | Required status Binding: EndpointStatus (required): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
managingOrganization | S Σ | 1..1 | Reference(Organization) | Directory entry managing organisation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Directory entry managing organisation display details
contact | S | 0..* | ContactPoint | Endpoint operator contact
period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational
payloadType | S Σ | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (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 | S Σ | 1..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Endpoint.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
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 | Australian Service Interfaces | 📦2.1.0-ci-build | This IG
Endpoint.managingOrganization.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📦2.1.0-ci-build | This IG
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-ep-01 | error | Endpoint | At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`
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

Mandatory: 3 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- PD Secure Messaging Delivery Target Identifier (http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-smdtargetidentifier)

Extensions

This structure refers to these extensions:

- http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
- http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
- http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509

Slices

This structure defines the following Slices:

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

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint | Australian Secure Message Directory Endpoint Record Constraints: au-pd-ep-01
meta | Σ | 0..1 | Meta | Metadata on Endpoint
source | S Σ | 0..1 | uri | Identifies where the resource comes from
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:receivingFacility |  | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
extension:receivingApplication |  | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
extension:dataEnciphermentCertificate |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 0..* | PDSMDTargetIdentifier | Secure Messaging Target Identifier
status | ?!S Σ | 1..1 | code | Required status Binding: EndpointStatus (required): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
managingOrganization | S Σ | 1..1 | Reference(Organization) | Directory entry managing organisation
display | Σ | 1..1 | string | Directory entry managing organisation display details
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | S Σ | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible)
address | S Σ | 1..1 | url | URL address of the endpoint
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 | Australian Service Interfaces | 📦2.1.0-ci-build | This IG
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-ep-01 | error | Endpoint | At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`
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()`

Differential View

This structure is derived from Endpoint

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint | Australian Secure Message Directory Endpoint Record Constraints: au-pd-ep-01
meta |  | 0..1 | Meta | Metadata on Endpoint
source | S | 0..1 | uri | Identifies where the resource comes from
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receivingFacility |  | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
extension:receivingApplication |  | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
extension:dataEnciphermentCertificate |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Slices for identifier | S | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S | 0..* | PDSMDTargetIdentifier | Secure Messaging Target Identifier
status | S | 1..1 | code | Required status
connectionType | S | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S | 0..1 | string | Friendly name for the endpoint
managingOrganization | S | 1..1 | Reference(Organization) | Directory entry managing organisation
display |  | 1..1 | string | Directory entry managing organisation display details
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | S | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible)
address | S | 1..1 | url | URL address of the endpoint
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Endpoint.connectionType | Base | extensible | Australian Service Interfaces | 📦2.1.0-ci-build | This IG
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📦2.1.0-ci-build | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-ep-01 | error | Endpoint | At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | Endpoint | Australian Secure Message Directory Endpoint Record Constraints: au-pd-ep-01
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata on Endpoint
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | S Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:receivingFacility |  | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
extension:receivingApplication |  | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
extension:dataEnciphermentCertificate |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 0..* | PDSMDTargetIdentifier | Secure Messaging Target Identifier
status | ?!S Σ | 1..1 | code | Required status Binding: EndpointStatus (required): The status of the endpoint.
connectionType | S Σ | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
managingOrganization | S Σ | 1..1 | Reference(Organization) | Directory entry managing organisation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 1..1 | string | Directory entry managing organisation display details
contact | S | 0..* | ContactPoint | Endpoint operator contact
period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational
payloadType | S Σ | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (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 | S Σ | 1..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Endpoint.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
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 | Australian Service Interfaces | 📦2.1.0-ci-build | This IG
Endpoint.managingOrganization.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Endpoint.payloadType | Base | extensible | Australian Endpoint Payload Types | 📦2.1.0-ci-build | This IG
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-pd-ep-01 | error | Endpoint | At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present | `identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`
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

Mandatory: 3 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- PD Secure Messaging Delivery Target Identifier (http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-smdtargetidentifier)

Extensions

This structure refers to these extensions:

- http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
- http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
- http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509

Slices

This structure defines the following Slices:

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

Maturity: 0

Other representations of profile: CSV, Excel, Schematron

### Notes:

Read: Endpoint Read identified endpoint resource content.

`GET [base]/Endpoint/[id]`

Example: `GET [base]/Endpoint/1234`

Support: MUST support read Endpoint

Implementation Notes: [(how to read resource)

Search: Active Status

Search based on active status of the endpoint record.

`GET [base]/Endpoint?status=[code]`

Example: `GET [base]/Endpoint?status=active`

Support: MUST support search Organization by active status code (active | suspended | error | off | entered-in-error | test)

Implementation Notes: (how to search by token)

Search: Identifier (Secure Messaging Target Identifier)

Search based on identifier token.

`GET [base]/Endpoint?identifier=[system]|[value]`

Example: `GET [base]/Endpoint?identifier=http://ns.electronichealth.net.au/smd/target|http://ns.argusdca.com.au/smd/id/hostname/ACC5959010000000`

Support: MUST support search by Secure Messaging Target Identifier

Implementation Notes: (how to search by token)

Search: Connection Type (Service Interface)

Search based on token for a protocol to be used to connnect to the endpoint.

`GET [base]/Endpoint?connection-type=[system]|[code]`

Example: `GET [base]/Endpoint?connection-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010`

Support: MUST support search by Connection Type.

Implementation Notes: (how to search by token)

Search: Payload Type (Service Category)

Search based on token for the type of content supported by the endpoint.

`GET [base]/Endpoint?payload-type=[system]|[code]`

Example: `GET [base]/Endpoint?payload-type=http://hl7.org.au/fhir/CodeSystem/endpoint-payload-type|http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706`

Support: MUST support search by Payload Type.

Implementation Notes: (how to search by token)

Search: Receiving Facility Extension Elements (Custom)

Search based string element content in the au-receivingfacility extension1. (namespace-id, universal-id, universal-id-type)

`GET [base]/Endpoint?au-receivingfacility-namespace-id=[string]&au-receivingfacility-universal-id=[string]&au-receivingfacility-universal-id-type=[string]`

Example: `GET [base]/Endpoint?au-receivingfacility-namespace-id=Buderim Medical Center&au-receivingfacility-universal-id=877F9695-1298-4E6A-B432-0FDD46AD80B8&au-receivingfacility-universal-id-type=GUID`

Support: MUST support search by Receiving Facility Extension Elements.

Implementation Notes: (how to search by string)

- For searching explicitly for empty elements use :missing=true e.g. `au-receivingfacility-universal-id-type:missing=true`
- Definition: au-receivingfacility-namespace-id (MSH-6.1) search `extension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('namespace-id').value`
- Definition: au-receivingfacility-universal-id (MSH-6.2) search `extension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('universal-id').value`
- Definition: au-receivingfacility-universal-id-type (MSH-6.3) search `extension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('universal-id-type').value`