NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: NHSD Secure Messaging Endpoint

Official URL: http://fhir.nhsd.com.au/StructureDefinition/nhsd-endpoint | Version: 4.0.1
Draft as of 2017-02-14 | Computable Name: NHSDSecureMessagingEndpoint
Copyright/Legal: National Health Services Directory© 2018+; Licensed Under Creative Commons No Rights Reserved.

A National Health Services Directory (NHSD) Endpoint

The NHSD Endpoint provides details of an endpoint for addressing a Secure message delivery.

### NHSD Endpoint Resource

1. Resource definition as per AU-PD and AU-BASE
2. Not supported: period

#### Examples

Usages:

- Refer to this Profile: NHSD HealthcareService and NHSD Practitioner Role

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 |  | 0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata on Endpoint
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
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:encryption-certificate-pem-x509 |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Slices for identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 1..1 | Identifier | Secure Messaging Target Identifier
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target
value | Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text)
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems
status | ?!S Σ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required)
connectionType | Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | Σ | 0..* | 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 | Σ | 0..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Endpoint.status | required | Endpoint Status(a valid code from Standard List of Endpoint Status) `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status` From this IG
Endpoint.connectionType | extensible | AustralianServiceInterfaces `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces`
Endpoint.payloadType | extensible | AustralianEndpointPayloadTypes `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type`
Endpoint.payloadMimeType | required | Mime Types(a valid code from `urn:ietf:bcp:13`) `http://hl7.org/fhir/ValueSet/mimetypes|4.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 AUPDSecureMessagingEndpoint

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint |  | 0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record
id |  | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
meta |  | 1..1 | Meta | Metadata on Endpoint
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 1..1 | instant | The timestamp when the resource was last updated
source |  | 0..0 |  |
profile |  | 0..0 |  |
security |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
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..0 |  |
extension:encryption-certificate-pem-x509 |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
modifierExtension |  | 0..0 |  |
Slices for identifier |  | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S | 1..1 | Identifier | Secure Messaging Target Identifier
id |  | 0..0 |  |
extension |  | 0..0 |  |
use |  | 0..0 |  |
type |  | 0..0 |  |
system |  | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target
value |  | 1..1 | string | Secure messaging target identifier value
period |  | 0..0 |  |
assigner |  | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text)
identifier:rid | S | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems
status | S | 1..1 | code | active | suspended | off Binding: Endpoint Status (required)
connectionType |  | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S | 0..1 | string | Friendly name for the endpoint
managingOrganization |  | 1..0 |  |
contact | S | 0..* | ContactPoint | Endpoint operator contact
period |  | 0..0 |  |
payloadType |  | 0..* | 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 |  | 0..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Endpoint.status | required | Endpoint Status(a valid code from Standard List of Endpoint Status) `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status` From this IG
Endpoint.connectionType | extensible | AustralianServiceInterfaces `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces`
Endpoint.payloadType | extensible | AustralianEndpointPayloadTypes `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type`
Endpoint.payloadMimeType | required | Mime Types(a valid code from `urn:ietf:bcp:13`) `http://hl7.org/fhir/ValueSet/mimetypes|4.0.0` From the FHIR Standard

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint |  | 0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata on Endpoint
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
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:encryption-certificate-pem-x509 |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Slices for identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 1..1 | Identifier | Secure Messaging Target Identifier
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target
value | Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text)
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems
status | ?!S Σ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required)
connectionType | Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | Σ | 0..* | 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 | Σ | 0..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Endpoint.status | required | Endpoint Status(a valid code from Standard List of Endpoint Status) `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status` From this IG
Endpoint.connectionType | extensible | AustralianServiceInterfaces `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces`
Endpoint.payloadType | extensible | AustralianEndpointPayloadTypes `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type`
Endpoint.payloadMimeType | required | Mime Types(a valid code from `urn:ietf:bcp:13`) `http://hl7.org/fhir/ValueSet/mimetypes|4.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 AUPDSecureMessagingEndpoint

Summary

Mandatory: 6 elements
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 26 elements

Structures

This structure refers to these other structures:

- nhsd-resource-identifier (http://fhir.nhsd.com.au/StructureDefinition/nhsd-resource-identifier)
- NHSD Organisation (http://fhir.nhsd.com.au/StructureDefinition/nhsd-organisation)

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

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint |  | 0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata on Endpoint
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
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:encryption-certificate-pem-x509 |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Slices for identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 1..1 | Identifier | Secure Messaging Target Identifier
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target
value | Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text)
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems
status | ?!S Σ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required)
connectionType | Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | Σ | 0..* | 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 | Σ | 0..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Endpoint.status | required | Endpoint Status(a valid code from Standard List of Endpoint Status) `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status` From this IG
Endpoint.connectionType | extensible | AustralianServiceInterfaces `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces`
Endpoint.payloadType | extensible | AustralianEndpointPayloadTypes `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type`
Endpoint.payloadMimeType | required | Mime Types(a valid code from `urn:ietf:bcp:13`) `http://hl7.org/fhir/ValueSet/mimetypes|4.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 AUPDSecureMessagingEndpoint

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint |  | 0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record
id |  | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
meta |  | 1..1 | Meta | Metadata on Endpoint
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 1..1 | instant | The timestamp when the resource was last updated
source |  | 0..0 |  |
profile |  | 0..0 |  |
security |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
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..0 |  |
extension:encryption-certificate-pem-x509 |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
modifierExtension |  | 0..0 |  |
Slices for identifier |  | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S | 1..1 | Identifier | Secure Messaging Target Identifier
id |  | 0..0 |  |
extension |  | 0..0 |  |
use |  | 0..0 |  |
type |  | 0..0 |  |
system |  | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target
value |  | 1..1 | string | Secure messaging target identifier value
period |  | 0..0 |  |
assigner |  | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text)
identifier:rid | S | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems
status | S | 1..1 | code | active | suspended | off Binding: Endpoint Status (required)
connectionType |  | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S | 0..1 | string | Friendly name for the endpoint
managingOrganization |  | 1..0 |  |
contact | S | 0..* | ContactPoint | Endpoint operator contact
period |  | 0..0 |  |
payloadType |  | 0..* | 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 |  | 0..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Endpoint.status | required | Endpoint Status(a valid code from Standard List of Endpoint Status) `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status` From this IG
Endpoint.connectionType | extensible | AustralianServiceInterfaces `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces`
Endpoint.payloadType | extensible | AustralianEndpointPayloadTypes `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type`
Endpoint.payloadMimeType | required | Mime Types(a valid code from `urn:ietf:bcp:13`) `http://hl7.org/fhir/ValueSet/mimetypes|4.0.0` From the FHIR Standard

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint |  | 0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record
id | Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
meta | Σ | 1..1 | Meta | Metadata on Endpoint
extension |  | 0..0 |  |
lastUpdated | Σ | 1..1 | instant | The timestamp when the resource was last updated
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:encryption-certificate-pem-x509 |  | 0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Slices for identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system
identifier:smdtarget | S Σ | 1..1 | Identifier | Secure Messaging Target Identifier
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target
value | Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text)
identifier:rid | S Σ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems
status | ?!S Σ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required)
connectionType | Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible)
name | S Σ | 0..1 | string | Friendly name for the endpoint
contact | S | 0..* | ContactPoint | Endpoint operator contact
payloadType | Σ | 0..* | 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 | Σ | 0..1 | url | URL address of the endpoint
header |  | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Endpoint.status | required | Endpoint Status(a valid code from Standard List of Endpoint Status) `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status` From this IG
Endpoint.connectionType | extensible | AustralianServiceInterfaces `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces`
Endpoint.payloadType | extensible | AustralianEndpointPayloadTypes `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type`
Endpoint.payloadMimeType | required | Mime Types(a valid code from `urn:ietf:bcp:13`) `http://hl7.org/fhir/ValueSet/mimetypes|4.0.0` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 AUPDSecureMessagingEndpoint

Summary

Mandatory: 6 elements
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 26 elements

Structures

This structure refers to these other structures:

- nhsd-resource-identifier (http://fhir.nhsd.com.au/StructureDefinition/nhsd-resource-identifier)
- NHSD Organisation (http://fhir.nhsd.com.au/StructureDefinition/nhsd-organisation)

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

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: NHSD Endpoint supports read Endpoint

Implementation Notes: [(how to read resource)

Search: Endpoint Currently NHSD does not support search endpoints. ———–