NHSD Secure Messaging Endpoint - Definitions - NHSD Implementation Guide

idstring

Is Modifier false

Summary true

4. Endpoint.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata on EndpointMetadata about the resource

Control 10..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Endpoint.meta.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..01

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

8. Endpoint.meta.extension

Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Endpoint.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

10. Endpoint.meta.versionId

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Short Version specific identifier

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control 0..01

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Endpoint.meta.lastUpdated

Definition

When the resource last changed - e.g. when the version changed.

Short The timestamp when the resource was last updatedWhen the resource version last changed

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control 10..1

instant

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

14. Endpoint.meta.source

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Short Identifies where the resource comes from

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Control 0..01

uri

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

16. Endpoint.meta.profile

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Short Profiles this resource claims to conform to

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control 0..0*

Type canonical(StructureDefinition)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

18. Endpoint.meta.security

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Short Security Labels applied to this resource

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Control 0..0*

Unless not suitable, these codes SHALL be taken from All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels
(extensible to http://hl7.org/fhir/ValueSet/security-labels)

Security Labels from the Healthcare Privacy and Security Classification System.

Coding

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

20. Endpoint.meta.tag

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Short Tags applied to this resource

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control 0..0*

For example codes, see CommonTagshttp://hl7.org/fhir/ValueSet/common-tags
(example to http://hl7.org/fhir/ValueSet/common-tags)

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

Coding

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

22. Endpoint.implicitRules

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short A set of rules under which this content was created

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..01

uri

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

24. Endpoint.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control 0..01

The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

26. Endpoint.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control 0..01

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

28. Endpoint.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline Resources

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control 0..0*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

30. Endpoint.extension

Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short ExtensionAdditional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Endpoint.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

32. Endpoint.extension:receivingFacility

Slice Name receivingFacility

Definition

Values for routing HL7 V2 message payloads associated with an endpoint, suitable for MSH-6

Short HL7 V2 receiving facility

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Receiving Facility) (Complex Extension)

Is Modifier false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

34. Endpoint.extension:receivingApplication

Slice Name receivingApplication

Definition

Values for routing HL7 V2 message payloads associated with an endpoint. Suitable for MSH-5.

Short HL7 V2 receiving application

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(Receiving Application) (Complex Extension)

Is Modifier false

36. Endpoint.extension:dataEnciphermentCertificate

Slice Name dataEnciphermentCertificate

Definition

Mechanism hold the value of an X509 certificate as a string (base64 encoded PEM certificate)

Short PEM X509 Certificate

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(Encryption Certificate PEM X509) (Extension Type: string)

Is Modifier false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

38. Endpoint.extension:encryption-certificate-pem-x509

Slice Name encryption-certificate-pem-x509

Definition

Mechanism to hold the value of a X509 certificate as a string (base64 encoded PEM certificate).

Short PEM X509 certificate

Control 0..*

Type Extension(Encryption Certificate PEM X509) (Extension Type: string)

Is Modifier false

Summary false

40. Endpoint.modifierExtension

Definition

An Extension

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short ExtensionExtensions that cannot be ignored

Comments

Control 0..0*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content

42. Endpoint.identifier

Definition

Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

Short Identifies this endpoint across multiple systems

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Identifier

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Endpoint.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ system

44. Endpoint.identifier:smdtarget

Slice Name smdtarget

Definition

Secure messaging interface target identity included in addressing metadata. Thiis is the complete URL identifier that can be directly used in secure messaging. This identifier should be matched when selecting the encrypting certificate data used for payload encryption also referenced from this endpoint.

Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

Short Secure Messaging Target IdentifierIdentifies this endpoint across multiple systems

Note This is a business identifier, not a resource identifier (see discussion)

Control 10..1*

Identifier

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. Endpoint.identifier:smdtarget.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..01

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

XML Format In the XML format, this property is represented as an attribute.

Summary false

48. Endpoint.identifier:smdtarget.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Endpoint.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

50. Endpoint.identifier:smdtarget.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..01

The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.0)

Identifies the purpose for this identifier, if known .

code

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. Endpoint.identifier:smdtarget.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control 0..01

Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
(extensible to http://hl7.org/fhir/ValueSet/identifier-type)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

CodeableConcept

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. Endpoint.identifier:smdtarget.system

Definition

Target identifier suitable for Secure Message Delivery interface metatadat content; also allows lookup for responses.

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short Secure Messaging Delivery Target IdentifierThe namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 10..1

uri

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Value http://ns.electronichealth.net.au/smd/target

Example General: http://www.acme.com/identifiers/patient

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

56. Endpoint.identifier:smdtarget.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short Secure messaging target identifier valueThe value that is unique

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control 10..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General: 123456

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

58. Endpoint.identifier:smdtarget.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..01

Period

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

60. Endpoint.identifier:smdtarget.assigner

Definition

Organization that issued the smdTarget identifier (may be just text).

Organization that issued/manages the identifier.

Short Organization that issued the smdTarget identifier (may be just text)Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

62. Endpoint.identifier:rid

Slice Name rid

Definition

NHSD Endpoint Resource Identifier

Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

Short Identifies this endpoint across multiple systems

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1*

Type Identifier(nhsd-resource-identifier)

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. Endpoint.status

Definition

Secure messaging endpoint activation status.

active | suspended | error | off | test.

Comments

This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.

Control 1..1

Binding The codes SHALL be taken from Endpoint Statushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
(required to http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status)

code

Is Modifier true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. Endpoint.connectionType

Definition

Protocol/Profile/Standard the endpoint supports.

A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

Short Service interface typeProtocol/Profile/Standard to be used with this endpoint connection

Comments

For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.

Control 01..1

Binding Unless not suitable, these codes SHALL be taken from Australian Service Interfaceshttp://hl7.org/fhir/ValueSet/endpoint-connection-type
(extensible to http://hl7.org.au/fhir/pd/ValueSet/service-interfaces)

Coding

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

68. Endpoint.name

Definition

A friendly name that this endpoint can be referred to with.

Short Friendly name for the endpointA name that this endpoint can be identified by

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. Endpoint.managingOrganization

Definition

Details of the organisation that is managing the supply of this directory entry.

The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

Short Directory entry managing organisationOrganization that manages this endpoint (might not be the organization that exposes the endpoint)

Comments

This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.

Control 10..01

Type Reference(NHSD Organisation, Organization)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

78. Endpoint.contact

Definition

Details to contact operator of the endpoint responsible for it's support and maintenance.

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

Short Endpoint operator contactContact details for source (e.g. troubleshooting)

Control 0..*

ContactPoint

Is Modifier false

Must Support true

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

80. Endpoint.period

Definition

The interval during which the endpoint is expected to be operational.

Short Interval the endpoint is expected to be operational

Control 0..01

Period

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

82. Endpoint.payloadType

Definition

Reference to identify the type of payload content (service category).

The payload type describes the acceptable content that can be communicated on the endpoint.

Short Payload typeThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

Comments

The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.

Control 01..*

Binding Unless not suitable, these codes SHALL be taken from For example codes, see Australian Endpoint Payload Typeshttp://hl7.org/fhir/ValueSet/endpoint-payload-type
(extensible to http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type)

CodeableConcept

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. Endpoint.payloadMimeType

Definition

The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

Short Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)

Comments

Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.

Control 0..*

The codes SHALL be taken from Mime Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
(required to http://hl7.org/fhir/ValueSet/mimetypes|4.0.0)

The mime type of an attachment. Any valid mime type is allowed.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

86. Endpoint.address

Definition

Actual endpoint URL for communications

The uri that describes the actual end-point to connect to.

Short URL address of the endpointThe technical base address for connecting to this endpoint

Comments

For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)

This address will be to the service base, without any parameters, or sub-services or resources tacked on.

E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"

and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".

Control 01..1

url

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

88. Endpoint.header

Definition

Additional headers / information to send as part of the notification.

Short Usage depends on the channel type

Comments

Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.

Control 0..*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Endpoint
Definition	Enpoint defined for use in secure message addressing.
Short	Australian Secure Message Directory Endpoint Record
2. Endpoint.id
Short	Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle
Control	1..?
4. Endpoint.meta
Short	Metadata on Endpoint
Control	1..?
6. Endpoint.meta.id
Control	0..0
8. Endpoint.meta.extension
Control	0..0
10. Endpoint.meta.versionId
Control	0..0
12. Endpoint.meta.lastUpdated
Short	The timestamp when the resource was last updated
Control	1..?
14. Endpoint.meta.source
Control	0..0
16. Endpoint.meta.profile
Control	0..0
18. Endpoint.meta.security
Control	0..0
20. Endpoint.meta.tag
Control	0..0
22. Endpoint.implicitRules
Control	0..0
24. Endpoint.language
Control	0..0
26. Endpoint.text
Control	0..0
28. Endpoint.contained
Control	0..0
30. Endpoint.extension
32. Endpoint.extension:receivingFacility
Slice Name	receivingFacility
Control	0..1
Type	Extension(Receiving Facility) (Complex Extension)
34. Endpoint.extension:receivingApplication
Slice Name	receivingApplication
Control	0..1
Type	Extension(Receiving Application) (Complex Extension)
36. Endpoint.extension:dataEnciphermentCertificate
Slice Name	dataEnciphermentCertificate
Definition	Mechanism hold the value of an X509 certificate as a string (base64 encoded PEM certificate)
Short	PEM X509 Certificate
Control	0..0
38. Endpoint.extension:encryption-certificate-pem-x509
Slice Name	encryption-certificate-pem-x509
Control	0..*
Type	Extension(Encryption Certificate PEM X509) (Extension Type: string)
40. Endpoint.modifierExtension
Control	0..0
42. Endpoint.identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Slicing	This element introduces a set of slices on `Endpoint.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
44. Endpoint.identifier:smdtarget
Slice Name	smdtarget
Definition	Secure messaging interface target identity included in addressing metadata. Thiis is the complete URL identifier that can be directly used in secure messaging. This identifier should be matched when selecting the encrypting certificate data used for payload encryption also referenced from this endpoint.
Short	Secure Messaging Target Identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	1..1
Must Support	true
46. Endpoint.identifier:smdtarget.id
Control	0..0
48. Endpoint.identifier:smdtarget.extension
Control	0..0
50. Endpoint.identifier:smdtarget.use
Control	0..0
52. Endpoint.identifier:smdtarget.type
Control	0..0
54. Endpoint.identifier:smdtarget.system
Definition	Target identifier suitable for Secure Message Delivery interface metatadat content; also allows lookup for responses.
Short	Secure Messaging Delivery Target Identifier
Control	1..?
Fixed Value	`http://ns.electronichealth.net.au/smd/target`
56. Endpoint.identifier:smdtarget.value
Short	Secure messaging target identifier value
Control	1..?
58. Endpoint.identifier:smdtarget.period
Control	0..0
60. Endpoint.identifier:smdtarget.assigner
Definition	Organization that issued the smdTarget identifier (may be just text).
Short	Organization that issued the smdTarget identifier (may be just text)
Control	0..1
62. Endpoint.identifier:rid
Slice Name	rid
Definition	NHSD Endpoint Resource Identifier
Note	This is a business identifier, not a resource identifier (see discussion)
Control	0..1
Type	Identifier(nhsd-resource-identifier)
Is Modifier	false
Must Support	true
64. Endpoint.status
Definition	Secure messaging endpoint activation status.
Short	active \| suspended \| off
Binding	The codes SHALL be taken from Endpoint Status (required to `http://fhir.nhsd.com.au/ValueSet/valueset-nhsd-endpoint-status`)
Must Support	true
66. Endpoint.connectionType
Definition	Protocol/Profile/Standard the endpoint supports.
Short	Service interface type
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Australian Service Interfaces (extensible to `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces`)
Must Support	false
68. Endpoint.name
Short	Friendly name for the endpoint
Must Support	true
70. Endpoint.managingOrganization
Definition	Details of the organisation that is managing the supply of this directory entry.
Short	Directory entry managing organisation
Control	0..0
Type	Reference(NHSD Organisation)
Must Support	false
78. Endpoint.contact
Definition	Details to contact operator of the endpoint responsible for it's support and maintenance.
Short	Endpoint operator contact
Must Support	true
80. Endpoint.period
Control	0..0
82. Endpoint.payloadType
Definition	Reference to identify the type of payload content (service category).
Short	Payload type
Control	0..*
Binding	Unless not suitable, these codes SHALL be taken from Australian Endpoint Payload Types (extensible to `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type`)
Must Support	false
84. Endpoint.payloadMimeType
Definition	The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
Short	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Comments	Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.
Control	0..*
Binding	The codes SHALL be taken from Mime Types (required to `http://hl7.org/fhir/ValueSet/mimetypes\|4.0.0`) The mime type of an attachment. Any valid mime type is allowed.
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
86. Endpoint.address
Definition	Actual endpoint URL for communications
Short	URL address of the endpoint
Control	0..1
Must Support	false
88. Endpoint.header
Definition	Additional headers / information to send as part of the notification.
Short	Usage depends on the channel type
Comments	Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
Control	0..*
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. Endpoint

Definition

Enpoint defined for use in secure message addressing.

Short Australian Secure Message Directory Endpoint Record

Control 0..*

Is Modifier false

Summary false

Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-4: 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-3: 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-6: A resource should have narrative for robust management (text.div.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())

2. Endpoint.id

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short Logical FHIR id for unique identification of the Endpoint resource within the FHIR bundle

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control 1..1

Is Modifier false

Summary true

4. Endpoint.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata on Endpoint

Control 1..1