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
| 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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Endpoint |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
![]() ![]() ![]() |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
![]() ![]() |
Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Secure Messaging Target Identifier |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text) |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems |
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required) |
![]() ![]() |
Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
![]() ![]() |
SΣ | 0..1 | string | Friendly name for the endpoint |
![]() ![]() |
S | 0..* | ContactPoint | Endpoint operator contact |
![]() ![]() |
Σ | 0..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
![]() ![]() |
Σ | 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. |
![]() ![]() |
Σ | 0..1 | url | URL address of the endpoint |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.div.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AUPDSecureMessagingEndpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record | |
![]() ![]() |
1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle | |
![]() ![]() |
1..1 | Meta | Metadata on Endpoint | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Version specific identifier | ||
![]() ![]() ![]() |
1..1 | instant | The timestamp when the resource was last updated | |
![]() ![]() ![]() |
0..0 | Identifies where the resource comes from | ||
![]() ![]() ![]() |
0..0 | Profiles this resource claims to conform to | ||
![]() ![]() ![]() |
0..0 | Security Labels applied to this resource | ||
![]() ![]() ![]() |
0..0 | Tags applied to this resource | ||
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
![]() ![]() ![]() |
0..0 | PEM X509 Certificate | ||
![]() ![]() ![]() |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
S | 1..1 | Identifier | Secure Messaging Target Identifier |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target | |
![]() ![]() ![]() ![]() |
1..1 | string | Secure messaging target identifier value | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text) | |
![]() ![]() ![]() |
S | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems |
![]() ![]() |
S | 1..1 | code | active | suspended | off Binding: Endpoint Status (required) |
![]() ![]() |
0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) | |
![]() ![]() |
S | 0..1 | string | Friendly name for the endpoint |
![]() ![]() |
1..0 | Directory entry managing organisation | ||
![]() ![]() |
S | 0..* | ContactPoint | Endpoint operator contact |
![]() ![]() |
0..0 | Interval the endpoint is expected to be operational | ||
![]() ![]() |
0..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) | |
![]() ![]() |
Σ | 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. |
![]() ![]() |
0..1 | url | URL address of the endpoint | |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| 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. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Endpoint |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
![]() ![]() ![]() |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
![]() ![]() |
Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Secure Messaging Target Identifier |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text) |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems |
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required) |
![]() ![]() |
Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
![]() ![]() |
SΣ | 0..1 | string | Friendly name for the endpoint |
![]() ![]() |
S | 0..* | ContactPoint | Endpoint operator contact |
![]() ![]() |
Σ | 0..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
![]() ![]() |
Σ | 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. |
![]() ![]() |
Σ | 0..1 | url | URL address of the endpoint |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.div.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from 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:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Endpoint |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
![]() ![]() ![]() |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
![]() ![]() |
Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Secure Messaging Target Identifier |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text) |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems |
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required) |
![]() ![]() |
Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
![]() ![]() |
SΣ | 0..1 | string | Friendly name for the endpoint |
![]() ![]() |
S | 0..* | ContactPoint | Endpoint operator contact |
![]() ![]() |
Σ | 0..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
![]() ![]() |
Σ | 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. |
![]() ![]() |
Σ | 0..1 | url | URL address of the endpoint |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.div.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AUPDSecureMessagingEndpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record | |
![]() ![]() |
1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle | |
![]() ![]() |
1..1 | Meta | Metadata on Endpoint | |
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..0 | Version specific identifier | ||
![]() ![]() ![]() |
1..1 | instant | The timestamp when the resource was last updated | |
![]() ![]() ![]() |
0..0 | Identifies where the resource comes from | ||
![]() ![]() ![]() |
0..0 | Profiles this resource claims to conform to | ||
![]() ![]() ![]() |
0..0 | Security Labels applied to this resource | ||
![]() ![]() ![]() |
0..0 | Tags applied to this resource | ||
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
![]() ![]() ![]() |
0..0 | PEM X509 Certificate | ||
![]() ![]() ![]() |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
S | 1..1 | Identifier | Secure Messaging Target Identifier |
![]() ![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target | |
![]() ![]() ![]() ![]() |
1..1 | string | Secure messaging target identifier value | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text) | |
![]() ![]() ![]() |
S | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems |
![]() ![]() |
S | 1..1 | code | active | suspended | off Binding: Endpoint Status (required) |
![]() ![]() |
0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) | |
![]() ![]() |
S | 0..1 | string | Friendly name for the endpoint |
![]() ![]() |
1..0 | Directory entry managing organisation | ||
![]() ![]() |
S | 0..* | ContactPoint | Endpoint operator contact |
![]() ![]() |
0..0 | Interval the endpoint is expected to be operational | ||
![]() ![]() |
0..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) | |
![]() ![]() |
Σ | 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. |
![]() ![]() |
0..1 | url | URL address of the endpoint | |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUPDSecureMessagingEndpoint | Australian Secure Message Directory Endpoint Record | |
![]() ![]() |
Σ | 1..1 | id | Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle |
![]() ![]() |
Σ | 1..1 | Meta | Metadata on Endpoint |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
Σ | 1..1 | instant | The timestamp when the resource was last updated |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
![]() ![]() ![]() |
0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
![]() ![]() ![]() |
0..* | string | PEM X509 certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
![]() ![]() |
Σ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Secure Messaging Target Identifier |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Secure messaging target identifier value Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued the smdTarget identifier (may be just text) |
![]() ![]() ![]() |
SΣ | 0..1 | NHSDResourceIdentifier | Identifies this endpoint across multiple systems |
![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | off Binding: Endpoint Status (required) |
![]() ![]() |
Σ | 0..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
![]() ![]() |
SΣ | 0..1 | string | Friendly name for the endpoint |
![]() ![]() |
S | 0..* | ContactPoint | Endpoint operator contact |
![]() ![]() |
Σ | 0..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
![]() ![]() |
Σ | 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. |
![]() ![]() |
Σ | 0..1 | url | URL address of the endpoint |
![]() ![]() |
0..* | string | Usage depends on the channel type | |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.div.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from 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:
Other representations of profile: CSV, Excel, Schematron
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. ———–