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:

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: doco
Endpoint 0..* AUPDSecureMessagingEndpoint Australian Secure Message Directory Endpoint Record
Endpoint.id This element is included in summaries. 1..1 id Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
Endpoint.meta This element is included in summaries. 1..1 Meta Metadata on Endpoint
Endpoint.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Endpoint.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:receivingFacility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Endpoint.Slices for extension.extension:receivingApplication 0..1 (Complex) HL7 V2 receiving application
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Endpoint.Slices for extension.extension:encryption-certificate-pem-x509 0..* string PEM X509 certificate
URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Endpoint.Slices for identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget This element must be supported. This element is included in summaries. 1..1 Identifier Secure Messaging Target Identifier
Endpoint.Slices for identifier.identifier:smdtarget.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget.system This element is included in summaries. 1..1 uri Secure Messaging Delivery Target Identifier
Fixed Value: http://ns.electronichealth.net.au/smd/target (no extensions allowed)
Endpoint.Slices for identifier.identifier:smdtarget.value This element is included in summaries. 1..1 string Secure messaging target identifier value
Example General: 123456
Endpoint.Slices for identifier.identifier:smdtarget.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued the smdTarget identifier (may be just text)
Endpoint.Slices for identifier.identifier:rid This element must be supported. This element is included in summaries. 0..1 NHSDResourceIdentifier Identifies this endpoint across multiple systems
Endpoint.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | suspended | off
Binding: Endpoint Status (required)
Endpoint.connectionType This element is included in summaries. 0..1 Coding Service interface type
Binding: Australian Service Interfaces (extensible)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string Friendly name for the endpoint
Endpoint.contact This element must be supported. 0..* ContactPoint Endpoint operator contact
Endpoint.payloadType This element is included in summaries. 0..* CodeableConcept Payload type
Binding: Australian Endpoint Payload Types (extensible)
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. 0..1 url URL address of the 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.status Base required Endpoint Status 📦4.0.1 This IG
Endpoint.connectionType Base extensible Australian Service Interfaces 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadType Base extensible Australian Endpoint Payload Types 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 → 4.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AUPDSecureMessagingEndpoint

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint 0..* AUPDSecureMessagingEndpoint Australian Secure Message Directory Endpoint Record
Endpoint.id 1..1 id Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
Endpoint.meta 1..1 Meta Metadata on Endpoint
Endpoint.meta.id 0..0 Unique id for inter-element referencing
Endpoint.meta.extension 0..0 Extension
Endpoint.meta.versionId 0..0 Version specific identifier
Endpoint.meta.lastUpdated 1..1 instant The timestamp when the resource was last updated
Endpoint.meta.source 0..0 Identifies where the resource comes from
Endpoint.meta.profile 0..0 Profiles this resource claims to conform to
Endpoint.meta.security 0..0 Security Labels applied to this resource
Endpoint.meta.tag 0..0 Tags applied to this resource
Endpoint.implicitRules 0..0 A set of rules under which this content was created
Endpoint.text 0..0 Text summary of the resource, for human interpretation
Endpoint.contained 0..0 Contained, inline Resources
Endpoint.extension 0..* Extension Extension
Endpoint.Slices for extension Content/Rules for all slices
Endpoint.Slices for extension.extension:receivingFacility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Endpoint.Slices for extension.extension:receivingApplication 0..1 (Complex) HL7 V2 receiving application
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Endpoint.Slices for extension.extension:dataEnciphermentCertificate 0..0 PEM X509 Certificate
Endpoint.Slices for extension.extension:encryption-certificate-pem-x509 0..* string PEM X509 certificate
URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Endpoint.modifierExtension 0..0 Extension
Endpoint.Slices for identifier 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget This element must be supported. 1..1 Identifier Secure Messaging Target Identifier
Endpoint.Slices for identifier.identifier:smdtarget.id 0..0 Unique id for inter-element referencing
Endpoint.Slices for identifier.identifier:smdtarget.extension 0..0 Extension
Endpoint.Slices for identifier.identifier:smdtarget.use 0..0 usual | official | temp | secondary | old (If known)
Endpoint.Slices for identifier.identifier:smdtarget.type 0..0 Description of identifier
Endpoint.Slices for identifier.identifier:smdtarget.system 1..1 uri Secure Messaging Delivery Target Identifier
Fixed Value: http://ns.electronichealth.net.au/smd/target (no extensions allowed)
Endpoint.Slices for identifier.identifier:smdtarget.value 1..1 string Secure messaging target identifier value
Endpoint.Slices for identifier.identifier:smdtarget.period 0..0 Time period when id is/was valid for use
Endpoint.Slices for identifier.identifier:smdtarget.assigner 0..1 Reference(Organization) Organization that issued the smdTarget identifier (may be just text)
Endpoint.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier Identifies this endpoint across multiple systems
Endpoint.status This element must be supported. 1..1 code active | suspended | off
Binding: Endpoint Status (required)
Endpoint.connectionType 0..1 Coding Service interface type
Binding: Australian Service Interfaces (extensible)
Endpoint.name This element must be supported. 0..1 string Friendly name for the endpoint
Endpoint.managingOrganization 1..0 Directory entry managing organisation
Endpoint.contact This element must be supported. 0..* ContactPoint Endpoint operator contact
Endpoint.period 0..0 Interval the endpoint is expected to be operational
Endpoint.payloadType 0..* CodeableConcept Payload type
Binding: Australian Endpoint Payload Types (extensible)
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 0..1 url URL address of the endpoint
Endpoint.header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Endpoint.status Base required Endpoint Status 📦4.0.1 This IG
Endpoint.connectionType Base extensible Australian Service Interfaces 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadType Base extensible Australian Endpoint Payload Types 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 → 4.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint 0..* AUPDSecureMessagingEndpoint Australian Secure Message Directory Endpoint Record
Endpoint.id This element is included in summaries. 1..1 id Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
Endpoint.meta This element is included in summaries. 1..1 Meta Metadata on Endpoint
Endpoint.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Endpoint.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:receivingFacility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Endpoint.Slices for extension.extension:receivingApplication 0..1 (Complex) HL7 V2 receiving application
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Endpoint.Slices for extension.extension:encryption-certificate-pem-x509 0..* string PEM X509 certificate
URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Endpoint.Slices for identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget This element must be supported. This element is included in summaries. 1..1 Identifier Secure Messaging Target Identifier
Endpoint.Slices for identifier.identifier:smdtarget.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget.system This element is included in summaries. 1..1 uri Secure Messaging Delivery Target Identifier
Fixed Value: http://ns.electronichealth.net.au/smd/target (no extensions allowed)
Endpoint.Slices for identifier.identifier:smdtarget.value This element is included in summaries. 1..1 string Secure messaging target identifier value
Example General: 123456
Endpoint.Slices for identifier.identifier:smdtarget.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued the smdTarget identifier (may be just text)
Endpoint.Slices for identifier.identifier:rid This element must be supported. This element is included in summaries. 0..1 NHSDResourceIdentifier Identifies this endpoint across multiple systems
Endpoint.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | suspended | off
Binding: Endpoint Status (required)
Endpoint.connectionType This element is included in summaries. 0..1 Coding Service interface type
Binding: Australian Service Interfaces (extensible)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string Friendly name for the endpoint
Endpoint.contact This element must be supported. 0..* ContactPoint Endpoint operator contact
Endpoint.payloadType This element is included in summaries. 0..* CodeableConcept Payload type
Binding: Australian Endpoint Payload Types (extensible)
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. 0..1 url URL address of the 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.status Base required Endpoint Status 📦4.0.1 This IG
Endpoint.connectionType Base extensible Australian Service Interfaces 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadType Base extensible Australian Endpoint Payload Types 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 → 4.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

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:

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: doco
Endpoint 0..* AUPDSecureMessagingEndpoint Australian Secure Message Directory Endpoint Record
Endpoint.id This element is included in summaries. 1..1 id Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
Endpoint.meta This element is included in summaries. 1..1 Meta Metadata on Endpoint
Endpoint.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Endpoint.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:receivingFacility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Endpoint.Slices for extension.extension:receivingApplication 0..1 (Complex) HL7 V2 receiving application
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Endpoint.Slices for extension.extension:encryption-certificate-pem-x509 0..* string PEM X509 certificate
URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Endpoint.Slices for identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget This element must be supported. This element is included in summaries. 1..1 Identifier Secure Messaging Target Identifier
Endpoint.Slices for identifier.identifier:smdtarget.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget.system This element is included in summaries. 1..1 uri Secure Messaging Delivery Target Identifier
Fixed Value: http://ns.electronichealth.net.au/smd/target (no extensions allowed)
Endpoint.Slices for identifier.identifier:smdtarget.value This element is included in summaries. 1..1 string Secure messaging target identifier value
Example General: 123456
Endpoint.Slices for identifier.identifier:smdtarget.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued the smdTarget identifier (may be just text)
Endpoint.Slices for identifier.identifier:rid This element must be supported. This element is included in summaries. 0..1 NHSDResourceIdentifier Identifies this endpoint across multiple systems
Endpoint.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | suspended | off
Binding: Endpoint Status (required)
Endpoint.connectionType This element is included in summaries. 0..1 Coding Service interface type
Binding: Australian Service Interfaces (extensible)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string Friendly name for the endpoint
Endpoint.contact This element must be supported. 0..* ContactPoint Endpoint operator contact
Endpoint.payloadType This element is included in summaries. 0..* CodeableConcept Payload type
Binding: Australian Endpoint Payload Types (extensible)
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. 0..1 url URL address of the 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.status Base required Endpoint Status 📦4.0.1 This IG
Endpoint.connectionType Base extensible Australian Service Interfaces 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadType Base extensible Australian Endpoint Payload Types 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 → 4.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from AUPDSecureMessagingEndpoint

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint 0..* AUPDSecureMessagingEndpoint Australian Secure Message Directory Endpoint Record
Endpoint.id 1..1 id Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
Endpoint.meta 1..1 Meta Metadata on Endpoint
Endpoint.meta.id 0..0 Unique id for inter-element referencing
Endpoint.meta.extension 0..0 Extension
Endpoint.meta.versionId 0..0 Version specific identifier
Endpoint.meta.lastUpdated 1..1 instant The timestamp when the resource was last updated
Endpoint.meta.source 0..0 Identifies where the resource comes from
Endpoint.meta.profile 0..0 Profiles this resource claims to conform to
Endpoint.meta.security 0..0 Security Labels applied to this resource
Endpoint.meta.tag 0..0 Tags applied to this resource
Endpoint.implicitRules 0..0 A set of rules under which this content was created
Endpoint.language 0..0 Language of the resource content
Endpoint.text 0..0 Text summary of the resource, for human interpretation
Endpoint.contained 0..0 Contained, inline Resources
Endpoint.extension 0..* Extension Extension
Endpoint.Slices for extension Content/Rules for all slices
Endpoint.Slices for extension.extension:receivingFacility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Endpoint.Slices for extension.extension:receivingApplication 0..1 (Complex) HL7 V2 receiving application
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Endpoint.Slices for extension.extension:dataEnciphermentCertificate 0..0 PEM X509 Certificate
Endpoint.Slices for extension.extension:encryption-certificate-pem-x509 0..* string PEM X509 certificate
URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Endpoint.modifierExtension 0..0 Extension
Endpoint.Slices for identifier 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget This element must be supported. 1..1 Identifier Secure Messaging Target Identifier
Endpoint.Slices for identifier.identifier:smdtarget.id 0..0 Unique id for inter-element referencing
Endpoint.Slices for identifier.identifier:smdtarget.extension 0..0 Extension
Endpoint.Slices for identifier.identifier:smdtarget.use 0..0 usual | official | temp | secondary | old (If known)
Endpoint.Slices for identifier.identifier:smdtarget.type 0..0 Description of identifier
Endpoint.Slices for identifier.identifier:smdtarget.system 1..1 uri Secure Messaging Delivery Target Identifier
Fixed Value: http://ns.electronichealth.net.au/smd/target (no extensions allowed)
Endpoint.Slices for identifier.identifier:smdtarget.value 1..1 string Secure messaging target identifier value
Endpoint.Slices for identifier.identifier:smdtarget.period 0..0 Time period when id is/was valid for use
Endpoint.Slices for identifier.identifier:smdtarget.assigner 0..1 Reference(Organization) Organization that issued the smdTarget identifier (may be just text)
Endpoint.Slices for identifier.identifier:rid This element must be supported. 0..1 NHSDResourceIdentifier Identifies this endpoint across multiple systems
Endpoint.status This element must be supported. 1..1 code active | suspended | off
Binding: Endpoint Status (required)
Endpoint.connectionType 0..1 Coding Service interface type
Binding: Australian Service Interfaces (extensible)
Endpoint.name This element must be supported. 0..1 string Friendly name for the endpoint
Endpoint.managingOrganization 1..0 Directory entry managing organisation
Endpoint.contact This element must be supported. 0..* ContactPoint Endpoint operator contact
Endpoint.period 0..0 Interval the endpoint is expected to be operational
Endpoint.payloadType 0..* CodeableConcept Payload type
Binding: Australian Endpoint Payload Types (extensible)
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 0..1 url URL address of the endpoint
Endpoint.header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Endpoint.status Base required Endpoint Status 📦4.0.1 This IG
Endpoint.connectionType Base extensible Australian Service Interfaces 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadType Base extensible Australian Endpoint Payload Types 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 → 4.0.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint 0..* AUPDSecureMessagingEndpoint Australian Secure Message Directory Endpoint Record
Endpoint.id This element is included in summaries. 1..1 id Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
Endpoint.meta This element is included in summaries. 1..1 Meta Metadata on Endpoint
Endpoint.meta.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.meta.lastUpdated This element is included in summaries. 1..1 instant The timestamp when the resource was last updated
Endpoint.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:receivingFacility 0..1 (Complex) HL7 V2 receiving facility
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
Endpoint.Slices for extension.extension:receivingApplication 0..1 (Complex) HL7 V2 receiving application
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
Endpoint.Slices for extension.extension:encryption-certificate-pem-x509 0..* string PEM X509 certificate
URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509
Endpoint.Slices for identifier This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget This element must be supported. This element is included in summaries. 1..1 Identifier Secure Messaging Target Identifier
Endpoint.Slices for identifier.identifier:smdtarget.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:smdtarget.system This element is included in summaries. 1..1 uri Secure Messaging Delivery Target Identifier
Fixed Value: http://ns.electronichealth.net.au/smd/target (no extensions allowed)
Endpoint.Slices for identifier.identifier:smdtarget.value This element is included in summaries. 1..1 string Secure messaging target identifier value
Example General: 123456
Endpoint.Slices for identifier.identifier:smdtarget.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued the smdTarget identifier (may be just text)
Endpoint.Slices for identifier.identifier:rid This element must be supported. This element is included in summaries. 0..1 NHSDResourceIdentifier Identifies this endpoint across multiple systems
Endpoint.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code active | suspended | off
Binding: Endpoint Status (required)
Endpoint.connectionType This element is included in summaries. 0..1 Coding Service interface type
Binding: Australian Service Interfaces (extensible)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string Friendly name for the endpoint
Endpoint.contact This element must be supported. 0..* ContactPoint Endpoint operator contact
Endpoint.payloadType This element is included in summaries. 0..* CodeableConcept Payload type
Binding: Australian Endpoint Payload Types (extensible)
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. 0..1 url URL address of the 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.status Base required Endpoint Status 📦4.0.1 This IG
Endpoint.connectionType Base extensible Australian Service Interfaces 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadType Base extensible Australian Endpoint Payload Types 📦2.0.1 hl7.fhir.au.pd v2.0
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 → 4.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

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:

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

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. ———–