National Healthcare Directory Attestation and Verification
1.0.0-ballot - ballot US

This page is part of the National Healthcare Directory Attestation (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: NatDir Endpoint

Official URL: http://hl7.org/fhir/us/directory-attestation/StructureDefinition/NatlDirAttest-Endpoint Version: 1.0.0-ballot
Active as of 2022-08-09 Computable Name: NatlDirAttestEndPoint

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.

This structure is derived from NatlDirExEndPoint

Summary

This structure is derived from NatlDirExEndPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*NatlDirExEndPointThe technical details of an endpoint that can be used for electronic services

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*NatlDirExEndPointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1stringLogical 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-usecase
... ig-supported S0..*(Complex)IGs Supported
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/igsSupported
... endpoint-type S1..1(Complex)Endpoint Type
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpointType
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/dynamicRegistration
... associated-servers S0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/associatedServers
... secured-endpoint S0..1booleanSecure Endpoint
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureEndpoint
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 SΣ0..1Reference(Organization)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)
Additional BindingsPurpose
Minimum Endpoint Connection Types Value SetMin Binding
... name Σ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
... 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*NatlDirExEndPointThe technical details of an endpoint that can be used for electronic services
... ig-supported 0..*(Complex)IGs Supported
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/igsSupported
... endpoint-type 1..1(Complex)Endpoint Type
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpointType
... associated-servers 0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/associatedServers
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.


Fixed Value: active
... connectionType Σ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Types Value Set (extensible)
Additional BindingsPurpose
Minimum Endpoint Connection Types Value SetMin Binding
... managingOrganization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadMimeType Σ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.



doco Documentation for this format

This structure is derived from NatlDirExEndPoint

Summary

Differential View

This structure is derived from NatlDirExEndPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*NatlDirExEndPointThe technical details of an endpoint that can be used for electronic services

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*NatlDirExEndPointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1stringLogical 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... endpoint-usecase 0..*(Complex)Endpoint Usecase
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-usecase
... ig-supported S0..*(Complex)IGs Supported
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/igsSupported
... endpoint-type S1..1(Complex)Endpoint Type
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpointType
... secure-exchange-artifacts 0..*(Complex)Secure Exchange Artifacts
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureExchangeArtifacts
... trust-framework 0..*(Complex)Trust Framework
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/trustFramework
... dynamic-registration 0..*(Complex)Dynamic Registration
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/dynamicRegistration
... associated-servers S0..*(Complex)Associated Servers
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/associatedServers
... secured-endpoint S0..1booleanSecure Endpoint
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/secureEndpoint
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 SΣ0..1Reference(Organization)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)
Additional BindingsPurpose
Minimum Endpoint Connection Types Value SetMin Binding
... name Σ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
... 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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ1..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Endpoint.meta.securityextensibleAll Security Labels
Endpoint.meta.tagexampleCommonTags
Endpoint.languagepreferredCommonLanguages
Max Binding: AllLanguages
Endpoint.identifier.userequiredIdentifierUse
Endpoint.identifier.typeextensibleIdentifier Type Codes
Endpoint.statusrequiredFixed Value: active
Endpoint.connectionTypeextensibleEndpointConnectionTypeVS
Min Binding: Minimum Endpoint Connection Types Value Set
Endpoint.payloadTypeextensibleEndpointPayloadTypeVS
Endpoint.payloadMimeTyperequiredMime Types