National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: NDH Base Endpoint Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint Version: 1.0.0-ballot
Active as of 2023-07-30 Computable Name: NdhEndpoint

Copyright/Legal: HL7 International

The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging.

Scope and Usage

The endpoint resource provides technical specifications for connecting to a specific location to transmit and retrieve information securely and accurately, according to the requirements of the endpoint owner. Unlike the CapabilityStatement, which describes the current system, the endpoint resource pertains to another system, potentially external to the current one. The endpoint could refer to locally hosted, regional, or national services.

Endpoint resources can be used to identify the location of endpoint details for various purposes, including referral requests to Organizations, OrganizationAffiliation, Locations, Practitioners, PractitionerRole or HealthcareServices. These resources can provide information on where to direct the referral request for efficient and effective care coordination.

Endpoint resources can also be useful for other purposes, such as facilitating preauthorization between insurance plans, network, and providers. They can be used to exchange information between care team members, allowing for seamless collaboration and communication among different healthcare providers involved in a patient’s care. By utilizing endpoint resources, relevant information can be shared securely and efficiently, helping to improve the quality of care and patient outcomes.

Boundaries and Relationships

CapabilityStatement vs Endpoint

The CapabilityStatement and the endpoint resource serve distinct purposes. While the CapabilityStatement describes the complete capability of a server, including the metadata of a specific server, the endpoint resource outlines the technical specifications for establishing connections and the intended purposes of such connections. The endpoint resource may only represent a small fraction of the server’s capabilities, and it may not even function as a FHIR endpoint.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
... ihe-specific-connection-type 0..*CodeableConceptIHE Specific Connection Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
Binding: Endpoint HIE Specific Connection Types Value Set (preferred)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... testing-certification 0..*(Complex)Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
... identifier S0..*IdentifierIdentifies this endpoint across multiple systems
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... status S1..1codeactive | suspended | error | off | entered-in-error | test
Fixed Value: active
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name S0..1stringA name that this endpoint can be identified by
... managingOrganization S0..1Reference(NDH Base Organization Profile)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... payloadType 1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType S0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Endpoint FHIR Mimetype Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
... ihe-specific-connection-type 0..*CodeableConceptIHE Specific Connection Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
Binding: Endpoint HIE Specific Connection Types Value Set (preferred)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... testing-certification 0..*(Complex)Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType Σ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType SΣ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Endpoint FHIR Mimetype Value Set (required)
... address Σ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Endpoint.identifier.userequiredIdentifierUse
Endpoint.statusrequiredFixed Value: active
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
... endpoint-nonfhir-usecase 0..*(Complex)Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
... ihe-specific-connection-type 0..*CodeableConceptIHE Specific Connection Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
Binding: Endpoint HIE Specific Connection Types Value Set (preferred)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... testing-certification 0..*(Complex)Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType Σ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType SΣ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Endpoint FHIR Mimetype Value Set (required)
... address Σ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Endpoint.meta.securityextensibleAll Security Labels
Endpoint.meta.tagexampleCommonTags
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.identifier.userequiredIdentifierUse
Endpoint.identifier.typeextensibleIdentifier Type Codes
Endpoint.statusrequiredFixed Value: active
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Endpoint.contact.systemrequiredContactPointSystem
Endpoint.contact.userequiredContactPointUse
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS

This structure is derived from Endpoint

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 6 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
... ihe-specific-connection-type 0..*CodeableConceptIHE Specific Connection Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
Binding: Endpoint HIE Specific Connection Types Value Set (preferred)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... testing-certification 0..*(Complex)Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
... identifier S0..*IdentifierIdentifies this endpoint across multiple systems
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... status S1..1codeactive | suspended | error | off | entered-in-error | test
Fixed Value: active
... connectionType S1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name S0..1stringA name that this endpoint can be identified by
... managingOrganization S0..1Reference(NDH Base Organization Profile)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... payloadType 1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType S0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Endpoint FHIR Mimetype Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
... ihe-specific-connection-type 0..*CodeableConceptIHE Specific Connection Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
Binding: Endpoint HIE Specific Connection Types Value Set (preferred)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... testing-certification 0..*(Complex)Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType Σ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType SΣ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Endpoint FHIR Mimetype Value Set (required)
... address Σ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Endpoint.identifier.userequiredIdentifierUse
Endpoint.statusrequiredFixed Value: active
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*EndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
... endpoint-nonfhir-usecase 0..*(Complex)Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
... fhir-ig 0..*(Complex)IGs supported
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
... access-control-mechanism 0..1CodeableConceptAccess Control Mechanism
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
... connection-type-version 0..*CodeableConceptConnection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: Endpoint Connection Type Version Value Set (extensible)
... endpoint-rank 0..1positiveIntPreferred order for connecting to the endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
... ihe-specific-connection-type 0..*CodeableConceptIHE Specific Connection Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
Binding: Endpoint HIE Specific Connection Types Value Set (preferred)
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status 0..1CodeableConceptVerification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... testing-certification 0..*(Complex)Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(NDH Base Organization Profile)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType Σ1..1CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
... payloadMimeType SΣ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Endpoint FHIR Mimetype Value Set (required)
... address Σ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Endpoint.meta.securityextensibleAll Security Labels
Endpoint.meta.tagexampleCommonTags
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.identifier.userequiredIdentifierUse
Endpoint.identifier.typeextensibleIdentifier Type Codes
Endpoint.statusrequiredFixed Value: active
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Endpoint.contact.systemrequiredContactPointSystem
Endpoint.contact.userequiredContactPointUse
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS

This structure is derived from Endpoint

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 6 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

SearchParameter Name Type Example
endpoint-access-control-mechanism token GET [base]/Endpoint?endpoint-access-control-mechanism=mutual-tls
endpoint-connection-type-version token GET [base]/Endpoint?endpoint-connection-type-version=4.0.1
endpoint-dynamic-registration-trust-profile token GET [base]/Endpoint?endpoint-dynamic-registration-trust-profile=udap
endpoint-ihe-connection-type token GET [base]/Endpoint?endpoint-ihe-connection-type=XCPD-InitGateway-PatientDiscovery-AsyncResponse
endpoint-nonfhir-usecase-type token GET [base]/Endpoint?endpoint-nonfhir-usecase-type=patient-access
endpoint-trust-framework-type token GET [base]/Endpoin?endpoint-trust-framework-type=DirectTrust
endpoint-usecase-type token GET [base]/Endpoint?endpoint-usecase-type=HOPERAT
endpoint-verification-status token GET [base]/Endpoint?endpoint-verification-status=complete

Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

SearchParameter Name Type Example
connection-type token GET [base]/Endpoint?connection-type=hl7-fhir-rest
identifier token GET [base]/Endpoint?identifier={system}|{value}
organization reference GET [base]/Endpoint?organization.name=Hartford General Hospital
status token GET [base]/Endpoint?status=active

_include Search Parameter

_include Example
Endpoint:organization GET [base]/CareTeam?_include=Endpoint:organization

_revinclude Search parameter

_revinclude
CareTeam:careteam-endpoint
HealthcareService:endpoint
InsurancePlan:endpoint
Location:endpoint
Organization:endpoint
OrganizationAffiliation:endpoint
Practitioner:practitioner-endpoint
PractitionerRole:endpoint
VerifcationResult:verificationresult-target