eHealthExchange Healthcare Directory Implementation Guide
1.6.0 - Release 1

Resource Profile: eHx Endpoint

Official URL: https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxEndpoint Version: 1.6.0
Active as of 2025-06-11 Computable Name: EHxEndpoint

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint C 0..* SequoiaEndpoint The technical details of an endpoint that can be used for electronic services
Constraints: se-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:transaction S 1..1 CodeableConcept When used on an endpoint, this identifies responding transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
.... extension:version S 1..1 string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
.... extension:purposesofuse S 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
..... extension 0..0
..... url 1..1 uri "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Purpose Of Use (required)
.... extension:roles S 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
.... extension:downtime S 0..* Period, Timing Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
.... extension:fhirigconformance S 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
.... extension:lastupdate S 0..1 Reference(AuditEvent) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
.... extension:endpointtype S 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType
Binding: Endpoint Type (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:HCID SΣ 0..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: HCID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:AAID SΣ 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AAID
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType SΣ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
... name SΣ 1..1 string A name that this endpoint can be identified by
... managingOrganization SΣ 1..1 Reference(eHx Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType SΣ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
... payloadMimeType SΣ 0..* code Mimetype 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..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.extension:purposesofuse.value[x]requiredPurposeOfUse
https://sequoiaproject.org/fhir/sphd/ValueSet/PurposeOfUse
From this IG
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
From the FHIR Standard
Endpoint.connectionTyperequiredEndpointConnectionType
https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionType
From this IG
Endpoint.payloadTypeextensibleEndpointPayloadTypeCodes
https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodes
From this IG
Endpoint.payloadMimeTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
se-1errorEndpointIf the value of the Transaction extension = 'FHIR REST' then the Version extension must be a valid FHIR core specification version
: extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction' and (value as CodeableConcept).coding.first().code='FHIR REST').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version').where((value as string) = '4.0.1'or (value as string) = '5.0.0' or (value as string) = '3.0.2' or (value as string) = '1.0.2' ).exists()

 

Other representations of profile: CSV, Excel, Schematron