National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

## Resource Profile: NdhEndpoint - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 4

Definitions for the ndh-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 | 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 | The 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())
2. 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()))
4. 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
6. Endpoint.extension:implementation-guide
Slice Name | implementation-guide
Definition | Implementation Guide Supported, when the connectionType and EndpointIheSpecificConnectionType can't be used.
Short | Implementation guide supported
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Implementation Guide Supported) (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()`)
8. Endpoint.extension:secure-exchange-artifacts
Slice Name | secure-exchange-artifacts
Definition | This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the certificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process in digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. The expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. This extension should be used when the standard for exchange requires the discovery of the public key.
Short | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself, and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Secure Exchange Artifacts) (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()`)
10. Endpoint.extension:trust-framework
Slice Name | trust-framework
Definition | A trust framework typically requires the use of signed artifacts and public certificates to ensure security, integrity, and trust in digital communications and transactions. For trust frameworks that use private PKI there is no need to use this extension unless the goals is to provide access to endpoints via the endpoint reference on any of the relevant resources (e.g., careteam, healthcareService).
Short | A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Trust Framework) (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:dynamic-registration
Slice Name | dynamic-registration
Definition | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
Short | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Dynamic Registration) (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:associated-servers
Slice Name | associated-servers
Definition | This extension is designed to store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, the server's type and URL will be included. For example, if your system features two types of endpoints: a standard endpoint and a proxy endpoint associated with the server. For example, the proxy endpoint can be configured to interface with AEGIS software, allowing the software to record transactions and ensure compliance with pertinent standards or regulations. Implementing such a configuration in a production environment would offer the flexibility to switch between standard and proxy modes (associated server) as necessary. Consequently, it is essential to have both standard and proxy endpoints readily available for seamless transitions as required.
Short | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, its type and URL will be included
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Associated Servers) (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()`)
16. Endpoint.extension:access-control-mechanism
Slice Name | access-control-mechanism
Definition | Endpoint access control mechanisms protect and manage access to healthcare endpoints, ensuring secure data exchange between systems. They standardize methods to secure endpoints, ensuring interoperability and security. In certain use cases requiring system scalability and flexibility, different profiles may be utilized based on the chosen access control mechanism. For example, the Unified Data Access Profile (UDAP) uses JWT access tokens.
Short | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange between systems adheres to specific security protocols when needed.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint Access Control Mechanism) (Extension Type: CodeableConcept)
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())
18. Endpoint.extension:endpoint-rank
Slice Name | endpoint-rank
Definition | Order established by a Role, Organization… for Endpoints capable of transferring the same content
Short | Preferred order for connecting to the endpoint
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint Rank) (Extension Type: positiveInt)
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())
20. Endpoint.extension:ihe-specific-connection-type
Slice Name | ihe-specific-connection-type
Definition | Endpoint IHE Specific Connection Type. This is to be used when the connectionType cannot be used. Such as when the endpoint support is more specific than a code in the connectionType ValueSet.
Short | IHE Specific Connection Type
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint IHE Specific Connection Type) (Extension Type: CodeableConcept)
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())
22. Endpoint.extension:verification-status
Slice Name | verification-status
Definition | Indicates a resource instance verification status
Short | Verification Status
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(NDH Verification Status) (Extension Type: CodeableConcept)
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())
24. Endpoint.extension:testing-certification
Slice Name | testing-certification
Definition | An extension for endpoint testing certification
Short | Endpoint Testing Certification
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint Testing Certification) (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()`)
26. Endpoint.extension:environmentType
Slice Name | environmentType
Definition | Endpoint Environment Type
Short | The type of environment exposed at this endpoint
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint EnvironmentType) (Extension Type: CodeableConcept)
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())
28. 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())
30. 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..*
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()))
32. Endpoint.identifier.extension:identifier-status
Slice Name | identifier-status
Definition | Describes the status of an identifier
Short | NDH Identifier Status
Control | 0..1
Type | Extension(NDH Identifier Status) (Extension Type: code)
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())
34. Endpoint.identifier.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..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | 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()))
36. Endpoint.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | 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(NDH Organization Profile, Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Endpoint.status
Definition | active | suspended | error | off | test.
Short | active | 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
Fixed Value | `active`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Endpoint.connectionType
Definition | 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 | Protocol/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 Endpoint Connection Types Value Set http://hl7.org/fhir/ValueSet/endpoint-connection-type|4.0.1 (extensible to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS` )
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()))
42. Endpoint.name
Definition | A friendly name that this endpoint can be referred to with.
Short | A 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()))
44. Endpoint.managingOrganization
Definition | 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 | Organization 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 | 0..1
Type | Reference(NDH Organization Profile, 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()))
46. Endpoint.payloadType
Definition | The payload type describes the acceptable content that can be communicated on the endpoint.
Short | The 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..1*
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Endpoint Payload Type Value Set http://hl7.org/fhir/ValueSet/endpoint-payload-type|4.0.1 (extensible to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. 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 Endpoint FHIR Mimetype Value Set http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 (required to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS` )
Type | code
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.address
Definition | The uri that describes the actual end-point to connect to.
Short | The 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
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
2. Endpoint.meta
4. Endpoint.meta.lastUpdated
Control | 1..?
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:implementation-guide
Slice Name | implementation-guide
Short | Implementation guide supported
Control | 0..*
Type | Extension(NDH Implementation Guide Supported) (Complex Extension)
10. Endpoint.extension:secure-exchange-artifacts
Slice Name | secure-exchange-artifacts
Short | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself, and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key.
Control | 0..*
Type | Extension(NDH Secure Exchange Artifacts) (Complex Extension)
12. Endpoint.extension:trust-framework
Slice Name | trust-framework
Short | A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
Control | 0..*
Type | Extension(NDH Trust Framework) (Complex Extension)
14. Endpoint.extension:dynamic-registration
Slice Name | dynamic-registration
Short | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
Control | 0..*
Type | Extension(NDH Dynamic Registration) (Complex Extension)
16. Endpoint.extension:associated-servers
Slice Name | associated-servers
Short | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, its type and URL will be included
Control | 0..*
Type | Extension(NDH Associated Servers) (Complex Extension)
18. Endpoint.extension:access-control-mechanism
Slice Name | access-control-mechanism
Short | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange between systems adheres to specific security protocols when needed.
Control | 0..1
Type | Extension(NDH Endpoint Access Control Mechanism) (Extension Type: CodeableConcept)
20. Endpoint.extension:endpoint-rank
Slice Name | endpoint-rank
Short | Preferred order for connecting to the endpoint
Control | 0..1
Type | Extension(NDH Endpoint Rank) (Extension Type: positiveInt)
22. Endpoint.extension:ihe-specific-connection-type
Slice Name | ihe-specific-connection-type
Short | IHE Specific Connection Type
Control | 0..*
Type | Extension(NDH Endpoint IHE Specific Connection Type) (Extension Type: CodeableConcept)
24. Endpoint.extension:verification-status
Slice Name | verification-status
Short | Verification Status
Control | 0..1
Type | Extension(NDH Verification Status) (Extension Type: CodeableConcept)
26. Endpoint.extension:testing-certification
Slice Name | testing-certification
Short | Endpoint Testing Certification
Control | 0..*
Type | Extension(NDH Endpoint Testing Certification) (Complex Extension)
28. Endpoint.extension:environmentType
Slice Name | environmentType
Short | The type of environment exposed at this endpoint
Control | 0..*
Type | Extension(NDH Endpoint EnvironmentType) (Extension Type: CodeableConcept)
30. Endpoint.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Must Support | true
32. Endpoint.identifier.extension:identifier-status
Slice Name | identifier-status
Control | 0..1
Type | Extension(NDH Identifier Status) (Extension Type: code)
34. Endpoint.identifier.assigner
Type | Reference(NDH Organization Profile)
36. Endpoint.status
Must Support | true
Fixed Value | `active`
38. Endpoint.connectionType
Binding | Unless not suitable, these codes SHALL be taken from Endpoint Connection Types Value Set (extensible to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS` )
Must Support | true
40. Endpoint.name
Must Support | true
42. Endpoint.managingOrganization
Type | Reference(NDH Organization Profile)
Must Support | true
44. Endpoint.contact
46. Endpoint.contact.extension:contactpoint-availabletime
Slice Name | contactpoint-availabletime
Control | 0..*
Type | Extension(NDH Contactpoint Availabletime) (Complex Extension)
48. Endpoint.contact.extension:via-intermediary
Slice Name | via-intermediary
Short | Via Intermediary
Control | 0..1
Type | Extension(NDH Via Intermediary) (Extension Type: Reference(NDH PractitionerRole, NDH OrganizationAffiliation Profile, NDH Location Profile, NDH Organization Profile))
50. Endpoint.contact.system
52. Endpoint.contact.value
54. Endpoint.payloadType
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Endpoint Payload Type Value Set (extensible to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS` )
56. Endpoint.payloadMimeType
Binding | The codes SHALL be taken from Endpoint FHIR Mimetype Value Set (required to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS` )
Must Support | true

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

0. Endpoint
Definition | 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 | The 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()`)
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 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())`)
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 | 1..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
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:implementation-guide
Slice Name | implementation-guide
Definition | Implementation Guide Supported, when the connectionType and EndpointIheSpecificConnectionType can't be used.
Short | Implementation guide supported
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Implementation Guide Supported) (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:secure-exchange-artifacts
Slice Name | secure-exchange-artifacts
Definition | This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the certificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process in digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. The expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. This extension should be used when the standard for exchange requires the discovery of the public key.
Short | Secure Exchange Artifacts store information about the type of public certificate, the certificate itself, and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Secure Exchange Artifacts) (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:trust-framework
Slice Name | trust-framework
Definition | A trust framework typically requires the use of signed artifacts and public certificates to ensure security, integrity, and trust in digital communications and transactions. For trust frameworks that use private PKI there is no need to use this extension unless the goals is to provide access to endpoints via the endpoint reference on any of the relevant resources (e.g., careteam, healthcareService).
Short | A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, and maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and technical specifications that ensure secure, interoperable, and reliable data exchange.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Trust Framework) (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()`)
38. Endpoint.extension:dynamic-registration
Slice Name | dynamic-registration
Definition | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
Short | Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Dynamic Registration) (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()`)
40. Endpoint.extension:associated-servers
Slice Name | associated-servers
Definition | This extension is designed to store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, the server's type and URL will be included. For example, if your system features two types of endpoints: a standard endpoint and a proxy endpoint associated with the server. For example, the proxy endpoint can be configured to interface with AEGIS software, allowing the software to record transactions and ensure compliance with pertinent standards or regulations. Implementing such a configuration in a production environment would offer the flexibility to switch between standard and proxy modes (associated server) as necessary. Consequently, it is essential to have both standard and proxy endpoints readily available for seamless transitions as required.
Short | Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, its type and URL will be included
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Associated Servers) (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()`)
42. Endpoint.extension:access-control-mechanism
Slice Name | access-control-mechanism
Definition | Endpoint access control mechanisms protect and manage access to healthcare endpoints, ensuring secure data exchange between systems. They standardize methods to secure endpoints, ensuring interoperability and security. In certain use cases requiring system scalability and flexibility, different profiles may be utilized based on the chosen access control mechanism. For example, the Unified Data Access Profile (UDAP) uses JWT access tokens.
Short | Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange between systems adheres to specific security protocols when needed.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint Access Control Mechanism) (Extension Type: CodeableConcept)
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()`)
44. Endpoint.extension:endpoint-rank
Slice Name | endpoint-rank
Definition | Order established by a Role, Organization… for Endpoints capable of transferring the same content
Short | Preferred order for connecting to the endpoint
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint Rank) (Extension Type: positiveInt)
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()`)
46. Endpoint.extension:ihe-specific-connection-type
Slice Name | ihe-specific-connection-type
Definition | Endpoint IHE Specific Connection Type. This is to be used when the connectionType cannot be used. Such as when the endpoint support is more specific than a code in the connectionType ValueSet.
Short | IHE Specific Connection Type
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint IHE Specific Connection Type) (Extension Type: CodeableConcept)
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()`)
48. Endpoint.extension:verification-status
Slice Name | verification-status
Definition | Indicates a resource instance verification status
Short | Verification Status
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(NDH Verification Status) (Extension Type: CodeableConcept)
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()`)
50. Endpoint.extension:testing-certification
Slice Name | testing-certification
Definition | An extension for endpoint testing certification
Short | Endpoint Testing Certification
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint Testing Certification) (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()`)
52. Endpoint.extension:environmentType
Slice Name | environmentType
Definition | Endpoint Environment Type
Short | The type of environment exposed at this endpoint
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(NDH Endpoint EnvironmentType) (Extension Type: CodeableConcept)
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()`)
54. 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()`)
56. 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..*
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())`)
58. Endpoint.identifier.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
60. Endpoint.identifier.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.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
62. Endpoint.identifier.extension:identifier-status
Slice Name | identifier-status
Definition | Describes the status of an identifier
Short | NDH Identifier Status
Control | 0..1
Type | Extension(NDH Identifier Status) (Extension Type: code)
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()`)
64. Endpoint.identifier.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..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` ) Identifies the purpose for this identifier, if known .
Type | 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())`)
66. Endpoint.identifier.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..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|4.0.1` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | 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())`)
68. Endpoint.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 0..1
Type | 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.
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())`)
70. Endpoint.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The 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 | 0..1
Type | string
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())`)
72. Endpoint.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
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())`)
74. Endpoint.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | 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(NDH Organization Profile)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Endpoint.status
Definition | active | suspended | error | off | test.
Short | active | 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 (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
Fixed Value | `active`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Endpoint.connectionType
Definition | 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 | Protocol/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 Endpoint Connection Types Value Set (extensible to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS` )
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())`)
80. Endpoint.name
Definition | A friendly name that this endpoint can be referred to with.
Short | A 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())`)
82. Endpoint.managingOrganization
Definition | 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 | Organization 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 | 0..1
Type | Reference(NDH Organization Profile)
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())`)
84. Endpoint.contact
Definition | Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Short | Contact details for source (e.g. troubleshooting)
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. Endpoint.contact.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
88. Endpoint.contact.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.contact.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
90. Endpoint.contact.extension:contactpoint-availabletime
Slice Name | contactpoint-availabletime
Definition | An extension representing the days and times a contact point is available
Short | NDH Contactpoint Availabletime
Control | 0..*
Type | Extension(NDH Contactpoint Availabletime) (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()`)
92. Endpoint.contact.extension:via-intermediary
Slice Name | via-intermediary
Definition | A reference to an alternative point of contact (NdhPractitionerRole, NdhOrganization, NdhOrganizationAffiliation, or NdhLocation) for this organization
Short | Via Intermediary
Control | 0..1
Type | Extension(NDH Via Intermediary) (Extension Type: Reference(NDH PractitionerRole, NDH OrganizationAffiliation Profile, NDH Location Profile, NDH Organization Profile))
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()`)
94. Endpoint.contact.system
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact.
Short | phone | fax | email | pager | url | sms | other
Control | 0..1 This element is affected by the following invariants: cpt-2
Binding | The codes SHALL be taken from ContactPointSystem (required to `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` ) Telecommunications form for contact point.
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())`)
96. Endpoint.contact.value
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Short | The actual contact point details
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to support legacy numbers that are not in a tightly controlled format.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. Endpoint.contact.use
Definition | Identifies the purpose for the contact point.
Short | home | work | temp | old | mobile - purpose of this contact point
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Control | 0..1
Binding | The codes SHALL be taken from ContactPointUse (required to `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` ) Use of contact point.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Endpoint.contact.rank
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Short | Specify preferred order of use (1 = highest)
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Control | 0..1
Type | positiveInt
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())`)
102. Endpoint.contact.period
Definition | Time period when the contact point was/is in use.
Short | Time period when the contact point was/is in use
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())`)
104. 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())`)
106. Endpoint.payloadType
Definition | The payload type describes the acceptable content that can be communicated on the endpoint.
Short | The 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..1
Binding | Unless not suitable, these codes SHALL be taken from Endpoint Payload Type Value Set (extensible to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. 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 Endpoint FHIR Mimetype Value Set (required to `http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS` )
Type | code
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())`)
110. Endpoint.address
Definition | The uri that describes the actual end-point to connect to.
Short | The 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
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. 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())`)