eHealthExchange Healthcare Directory Implementation Guide
0.0.1 - CI Build

eHealthExchange Healthcare Directory Implementation Guide - Local Development build (v0.0.1). See the Directory of published versions

Resource Profile: eHx Endpoint

Defining URL:https://sequoiaproject.org/fhir/ehx/Endpoint/eHxEndpoint
Version:0.0.1
Name:eHxEndpoint
Title:eHx Endpoint
Status:Active as of 2020-12-11
Publisher:eHealth Exchange
Copyright:

This document is copyright 2017-2021 by The Sequoia Project. All rights reserved world wide.

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://sequoiaproject.org/fhir/ehx/Endpoint/eHxEndpoint

Formal Views of Profile Content

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

This structure is derived from SequoiaEndpoint

Summary

Mandatory: 1 element

Structures

This structure refers to these other structures:

This structure is derived from SequoiaEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... extension:Actor 1..1ActorExtension
... managingOrganization 1..1Reference(eHx Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe 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
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Transaction S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
... Actor S1..1CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Actor
Binding: Endpoint Actor Codes (required)
... Version S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... Roles S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
... Downtime S0..*Period, TimingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
... endpoint-servicekey 0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-servicekey
... endpoint-keyversion 0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-keyversion
... endpoint-bindingkey 0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-bindingkey
... 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 SΣ0..1CodeableConceptDescription of identifier
Binding: Endpoint Identifier Codes (required)
.... 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(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.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(eHx 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 SΣ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... 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 SΣ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..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... Transaction 0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
... Actor 1..1CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Actor
Binding: Endpoint Actor Codes (required)
... Version 0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
... PurposesOfUse 0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... Roles 0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
... Downtime 0..*Period, TimingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Endpoint Identifier Codes (required)
... connectionType Σ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (required)
... name Σ0..1stringA name that this endpoint can be identified by
... managingOrganization Σ1..1Reference(eHx Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType Σ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... 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.


... address Σ1..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

This structure is derived from SequoiaEndpoint

Summary

Mandatory: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from SequoiaEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... extension:Actor 1..1ActorExtension
... managingOrganization 1..1Reference(eHx Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe 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
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Transaction S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
... Actor S1..1CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Actor
Binding: Endpoint Actor Codes (required)
... Version S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... Roles S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
... Downtime S0..*Period, TimingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
... endpoint-servicekey 0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-servicekey
... endpoint-keyversion 0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-keyversion
... endpoint-bindingkey 0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-bindingkey
... 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 SΣ0..1CodeableConceptDescription of identifier
Binding: Endpoint Identifier Codes (required)
.... 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(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.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(eHx 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 SΣ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (example)
... 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 SΣ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: Schematron

Terminology Bindings

PathConformanceValueSet
Endpoint.languagepreferredCommonLanguages
Max Binding: AllLanguages
Endpoint.identifier.userequiredIdentifierUse
Endpoint.identifier.typerequiredEndpointIdentifierCodes
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTyperequiredEndpointConnectionType
Endpoint.payloadTypeexampleEndpointPayloadType
Endpoint.payloadMimeTyperequiredMime Types

Constraints

IdPathDetailsRequirements
dom-2EndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3EndpointIf 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-4EndpointIf 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-5EndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6EndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1Endpoint.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:TransactionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:TransactionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:ActorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:ActorMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:VersionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:VersionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:UseCasesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:UseCasesMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:PurposesOfUseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:PurposesOfUseMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:RolesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:RolesMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:DowntimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:DowntimeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:endpoint-servicekeyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:endpoint-servicekeyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:endpoint-keyversionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:endpoint-keyversionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.extension:endpoint-bindingkeyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extension:endpoint-bindingkeyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.connectionTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.payloadTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.payloadMimeTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.headerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())