eHealthExchange Healthcare Directory Implementation Guide
1.18.0 - Release 1
| Official URL: https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxEndpoint | Version: 1.18.0 | |||
| Active as of 2026-10-27 | Computable Name: EHxEndpoint | |||
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) | |
![]() ![]() ![]() |
0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout | |
![]() ![]() ![]() |
1..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version | |
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required) | |
![]() ![]() ![]() |
0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: Author Role (required) | |
![]() ![]() ![]() |
0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime | |
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance | |
![]() ![]() ![]() |
0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate | |
![]() ![]() ![]() |
0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required) | |
![]() ![]() ![]() |
0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode Binding: IAS Response Mode Value Set (required) | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: | |
![]() ![]() ![]() |
0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: | |
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | |
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (required) | |
![]() ![]() |
1..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
1..1 | Reference(eHx Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() |
1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Codes (extensible) | |
![]() ![]() |
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. | |
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.extension:purposesofuse.value[x] | Base | required | Purpose Of Use | 📦1.18.0 | This IG |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.18.0 | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.18.0 | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | 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 |
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-4 | error | Endpoint | If 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-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| se-1 | error | Endpoint | If 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()
|
This structure is derived from SequoiaEndpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | Version | Optional Extensions Element | |
![]() ![]() ![]() |
0..* | PurposesOfUse | Extension | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required) | |
![]() ![]() |
1..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
1..1 | Reference(eHx Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.extension:purposesofuse.value[x] | Base | required | Purpose Of Use | 📦1.18.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) | |||||
![]() ![]() ![]() |
0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout | |||||
![]() ![]() ![]() |
1..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version | |||||
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: Author Role (required) | |||||
![]() ![]() ![]() |
0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime | |||||
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance | |||||
![]() ![]() ![]() |
0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate | |||||
![]() ![]() ![]() |
0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required) | |||||
![]() ![]() ![]() |
0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode Binding: IAS Response Mode Value Set (required) | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: | |||||
![]() ![]() ![]() |
0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (required) | |||||
![]() ![]() |
1..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
1..1 | Reference(eHx Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
![]() ![]() |
1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Codes (extensible) | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.extension:purposesofuse.value[x] | Base | required | Purpose Of Use | 📦1.18.0 | This IG |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.18.0 | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.18.0 | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | 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 |
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-4 | error | Endpoint | If 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-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| se-1 | error | Endpoint | If 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()
|
This structure is derived from SequoiaEndpoint
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) | |
![]() ![]() ![]() |
0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout | |
![]() ![]() ![]() |
1..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version | |
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required) | |
![]() ![]() ![]() |
0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: Author Role (required) | |
![]() ![]() ![]() |
0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime | |
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance | |
![]() ![]() ![]() |
0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate | |
![]() ![]() ![]() |
0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required) | |
![]() ![]() ![]() |
0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode Binding: IAS Response Mode Value Set (required) | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: | |
![]() ![]() ![]() |
0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: | |
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | |
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (required) | |
![]() ![]() |
1..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
1..1 | Reference(eHx Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() |
1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Codes (extensible) | |
![]() ![]() |
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. | |
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.extension:purposesofuse.value[x] | Base | required | Purpose Of Use | 📦1.18.0 | This IG |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.18.0 | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.18.0 | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | 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 |
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-4 | error | Endpoint | If 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-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| se-1 | error | Endpoint | If 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()
|
Differential View
This structure is derived from SequoiaEndpoint
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |
![]() ![]() |
2..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | Version | Optional Extensions Element | |
![]() ![]() ![]() |
0..* | PurposesOfUse | Extension | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required) | |
![]() ![]() |
1..1 | string | A name that this endpoint can be identified by | |
![]() ![]() |
1..1 | Reference(eHx Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.extension:purposesofuse.value[x] | Base | required | Purpose Of Use | 📦1.18.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) | |||||
![]() ![]() ![]() |
0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout | |||||
![]() ![]() ![]() |
1..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version | |||||
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: Author Role (required) | |||||
![]() ![]() ![]() |
0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime | |||||
![]() ![]() ![]() |
0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance | |||||
![]() ![]() ![]() |
0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate | |||||
![]() ![]() ![]() |
0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required) | |||||
![]() ![]() ![]() |
0..* | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode Binding: IAS Response Mode Value Set (required) | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: | |||||
![]() ![]() ![]() |
0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: | |||||
![]() ![]() |
1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | |||||
![]() ![]() |
1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (required) | |||||
![]() ![]() |
1..1 | string | A name that this endpoint can be identified by | |||||
![]() ![]() |
1..1 | Reference(eHx Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |||||
![]() ![]() |
0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
![]() ![]() |
0..1 | Period | Interval the endpoint is expected to be operational | |||||
![]() ![]() |
1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Codes (extensible) | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
1..1 | url | The technical base address for connecting to this endpoint | |||||
![]() ![]() |
0..* | string | Usage depends on the channel type | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Endpoint.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Endpoint.extension:purposesofuse.value[x] | Base | required | Purpose Of Use | 📦1.18.0 | This IG |
| Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std. |
| Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.18.0 | This IG |
| Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.18.0 | This IG |
| Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Endpoint | 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 |
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-4 | error | Endpoint | If 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-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| se-1 | error | Endpoint | If 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()
|
This structure is derived from SequoiaEndpoint
Other representations of profile: CSV, Excel, Schematron