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

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 1.0.0 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: National Directory API Endpoint Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint Version: 1.0.0
Standards status: Trial-use Computable Name: NdhNdApiEndpoint

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.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* NdhEndpoint The technical details of an endpoint that can be used for electronic services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta SΣ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:endpoint-usecase S 0..* (Complex) NDH Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:endpoint-nonfhir-usecase 0..* (Complex) Non FHIR Endpoint Usecase
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:fhir-ig S 0..* (Complex) NDH FHIR IG
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:secure-exchange-artifacts S 0..* (Complex) NDH Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:trust-framework S 0..* (Complex) NDH Trust Framework
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:dynamic-registration S 0..* (Complex) NDH Dynamic Registration
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:associated-servers S 0..* (Complex) NDH Associated Servers
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:access-control-mechanism S 0..1 CodeableConcept NDH Endpoint Access Control Mechanism
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
Binding: Endpoint Access Control Mechanism Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:connection-type-version S 0..* CodeableConcept NDH Endpoint Connection Type Version
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version
Binding: FHIRVersion (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:endpoint-rank S 0..1 positiveInt NDH Endpoint Rank
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ihe-specific-connection-type 0..* CodeableConcept IHE Specific Connection Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
Binding: Endpoint IHE Specific Connection Types Value Set (preferred)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:verification-status S 1..1 CodeableConcept NDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:testing-certification 0..* (Complex) Endpoint Testing Certification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:environmentType 0..* CodeableConcept The type of environment exposed at this endpoint
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type
Binding: NDH Endpoint Environment Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Identifies this endpoint across multiple systems
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:identifier-status S 1..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type SΣ 0..1 CodeableConcept Description 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.


ele-1: All FHIR elements must have a @value or children
.... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner SΣ 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


ele-1: All FHIR elements must have a @value or children
Fixed Value: active
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string A name that this endpoint can be identified by
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(National Directory API Organization Profile) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
ele-1: All FHIR elements must have a @value or children
... contact S 0..* ContactPoint Contact details for source (e.g. troubleshooting)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:via-intermediary S 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
.... period SΣ 0..1 Period Time period when the contact point was/is in use
ele-1: All FHIR elements must have a @value or children
... period SΣ 0..1 Period Interval the endpoint is expected to be operational
ele-1: All FHIR elements must have a @value or children
... payloadType SΣ 1..1 CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
... payloadMimeType SΣ 0..* code Mimetype 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)
ele-1: All FHIR elements must have a @value or children
... address SΣ 1..1 url The technical base address for connecting to this endpoint
ele-1: All FHIR elements must have a @value or children
... header S 0..* string Usage depends on the channel type
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Endpoint.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Endpoint.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Endpoint.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
from this IG
Endpoint.contact.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Endpoint.contact.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
from this IG
Endpoint.payloadMimeTyperequiredEndpointFhirMimeTypeVS
http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
from this IG

 

Other representations of profile: CSV, Excel, Schematron