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

AU Provider Directory Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/au-fhir-pd/ and changes regularly. See the Directory of published versions

## Resource Profile: AUPDSecureMessagingEndpoint - Detailed Descriptions

Page standards status: Draft | Maturity Level: 0

Definitions for the au-pd-sm-endpoint resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. Endpoint
Definition | Endpoint defined for use in secure message addressing. The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
Short | Australian Secure Message Directory Endpoint RecordThe technical details of an endpoint that can be used for electronic services
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-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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) au-pd-ep-01: At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present (`identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`)
2. 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 | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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. 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..1
Type | 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()))
6. 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..1
Type | 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()))
8. 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 | 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..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
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())
Slicing | 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
10. 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(HL7 V2 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()`)
12. 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(HL7 V2 Receiving Application) (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()`)
14. Endpoint.extension:dataEnciphermentCertificate
Slice Name | dataEnciphermentCertificate
Definition | Mechanism to hold the value of a X509 certificate as a string (base64 encoded PEM certificate).
Short | PEM X509 certificate
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Encryption Certificate PEM X509) (Extension Type: string)
Is Modifier | false
Summary | 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())
16. Endpoint.modifierExtension
Definition | 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 | Extensions that cannot be ignored
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..*
Type | Extension
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
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())
18. 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 | 10..*
Type | 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()))
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
20. Endpoint.identifier:smdtarget
Slice Name | smdtarget
Definition | Secure messaging interface target identity included in addressing metadata. This 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 | 0..*
Type | Identifier(PD Secure Messaging Delivery Target 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()))
22. Endpoint.status
Definition | Secure messaging endpoint activation status. active | suspended | error | off | test.
Short | Required statusactive | suspended | error | off | entered-in-error | 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 EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1` ) The status of the endpoint.
Type | 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()))
24. 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 | 1..1
Binding | Unless not suitable, these codes SHALL be taken from Australian Service Interfaces http://hl7.org/fhir/ValueSet/endpoint-connection-type|4.0.1 (extensible to `http://hl7.org.au/fhir/pd/ValueSet/service-interfaces` )
Type | Coding
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()))
26. 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
Type | string
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()))
28. 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..1
Type | Reference(Organization)
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()))
30. Endpoint.managingOrganization.display
Definition | Details to display for the directory entry managing organisation, typically the name. Plain text narrative that identifies the resource in addition to the resource reference.
Short | Directory entry managing organisation display detailsText alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 10..1
Type | string
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()))
32. 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..*
Type | 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()))
34. 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 | 1..*
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Australian Endpoint Payload Types http://hl7.org/fhir/ValueSet/endpoint-payload-type|4.0.1 (extensible to `http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type` )
Type | CodeableConcept
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()))
36. 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 | 1..1
Type | url
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()))

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

0. Endpoint
Definition | Endpoint defined for use in secure message addressing.
Short | Australian Secure Message Directory Endpoint Record
Invariants | au-pd-ep-01: At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present (`identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`)
2. Endpoint.meta
Short | Metadata on Endpoint
4. Endpoint.meta.source
Must Support | true
6. Endpoint.extension
Slicing | 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
8. Endpoint.extension:receivingFacility
Slice Name | receivingFacility
Control | 0..1
Type | Extension(HL7 V2 Receiving Facility) (Complex Extension)
10. Endpoint.extension:receivingApplication
Slice Name | receivingApplication
Control | 0..1
Type | Extension(HL7 V2 Receiving Application) (Complex Extension)
12. Endpoint.extension:dataEnciphermentCertificate
Slice Name | dataEnciphermentCertificate
Type | Extension(Encryption Certificate PEM X509) (Extension Type: string)
14. Endpoint.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
Must Support | true
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
16. Endpoint.identifier:smdtarget
Slice Name | smdtarget
Definition | Secure messaging interface target identity included in addressing metadata. This 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)
Type | Identifier(PD Secure Messaging Delivery Target Identifier)
Must Support | true
18. Endpoint.status
Definition | Secure messaging endpoint activation status.
Short | Required status
Must Support | true
20. Endpoint.connectionType
Definition | Protocol/Profile/Standard the endpoint supports.
Short | Service interface type
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 | true
22. Endpoint.name
Short | Friendly name for the endpoint
Must Support | true
24. Endpoint.managingOrganization
Definition | Details of the organisation that is managing the supply of this directory entry.
Short | Directory entry managing organisation
Control | 1..?
Must Support | true
26. Endpoint.managingOrganization.display
Definition | Details to display for the directory entry managing organisation, typically the name.
Short | Directory entry managing organisation display details
Control | 1..?
28. Endpoint.contact
Definition | Details to contact operator of the endpoint responsible for it's support and maintenance.
Short | Endpoint operator contact
Must Support | true
30. Endpoint.payloadType
Definition | Reference to identify the type of payload content (service category).
Short | Payload type
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 | true
32. Endpoint.address
Definition | Actual endpoint URL for communications
Short | URL address of the endpoint
Must Support | true

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

0. Endpoint
Definition | Endpoint 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-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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) au-pd-ep-01: At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present (`identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()`)
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 id of this artifact
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 | 0..1
Type | id
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 | 0..1
Type | 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..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. Endpoint.meta.extension
Definition | 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 | Additional 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..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
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()`)
Slicing | 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..1
Type | id
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 | When 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 | 0..1
Type | 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..1
Type | 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..*
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..*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels|4.0.1` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | 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..*
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags|4.0.1` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | 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..1
Type | 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..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
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..1
Type | 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..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
30. Endpoint.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | 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()`)
Slicing | 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(HL7 V2 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(HL7 V2 Receiving Application) (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()`)
36. Endpoint.extension:dataEnciphermentCertificate
Slice Name | dataEnciphermentCertificate
Definition | Mechanism to hold the value of a X509 certificate as a string (base64 encoded PEM certificate).
Short | PEM X509 certificate
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Encryption Certificate PEM X509) (Extension Type: string)
Is Modifier | false
Summary | 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()`)
38. Endpoint.modifierExtension
Definition | 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 | Extensions that cannot be ignored
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..*
Type | Extension
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
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()`)
40. 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 | 1..*
Type | 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())`)
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
42. Endpoint.identifier:smdtarget
Slice Name | smdtarget
Definition | Secure messaging interface target identity included in addressing metadata. This 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 | 0..*
Type | Identifier(PD Secure Messaging Delivery Target 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())`)
44. Endpoint.status
Definition | Secure messaging endpoint activation status.
Short | Required status
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 EndpointStatus (required to `http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1` ) The status of the endpoint.
Type | 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())`)
46. Endpoint.connectionType
Definition | Protocol/Profile/Standard the endpoint supports.
Short | Service interface type
Comments | For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.
Control | 1..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` )
Type | Coding
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())`)
48. Endpoint.name
Definition | A friendly name that this endpoint can be referred to with.
Short | Friendly name for the endpoint
Control | 0..1
Type | string
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())`)
50. Endpoint.managingOrganization
Definition | Details of the organisation that is managing the supply of this directory entry.
Short | Directory entry managing organisation
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 | 1..1
Type | Reference(Organization)
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())`)
52. Endpoint.managingOrganization.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..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
54. Endpoint.managingOrganization.extension
Definition | 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 | Additional 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..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
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()`)
Slicing | This element introduces a set of slices on `Endpoint.managingOrganization.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
56. Endpoint.managingOrganization.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
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())`)
58. Endpoint.managingOrganization.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient")
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types|4.0.1` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
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())`)
60. Endpoint.managingOrganization.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
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.managingOrganization.display
Definition | Details to display for the directory entry managing organisation, typically the name.
Short | Directory entry managing organisation display details
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 1..1
Type | string
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())`)
64. Endpoint.contact
Definition | Details to contact operator of the endpoint responsible for it's support and maintenance.
Short | Endpoint operator contact
Control | 0..*
Type | 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())`)
66. 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..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Endpoint.payloadType
Definition | Reference to identify the type of payload content (service category).
Short | Payload type
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 | 1..*
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` )
Type | CodeableConcept
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())`)
70. 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.1` ) 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Endpoint.address
Definition | Actual endpoint URL for communications
Short | URL address of the 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 | 1..1
Type | url
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())`)
74. 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)