Sequoia Project Healthcare Directory Implementation Guide
0.0.4 - CI Build
US
Sequoia Project Healthcare Directory Implementation Guide
0.0.4 - CI Build
US
Sequoia Project Healthcare Directory Implementation Guide - Local Development build (v0.0.4). See the Directory of published versions
| Official URL: https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxEndpoint | Version: 0.0.4 | |||
| Active as of 2020-12-11 | Computable Name: EHxEndpoint | |||
Copyright/Legal: This document is copyright 2017-18 by The Sequoia Project. All rights reserved world wide. |
||||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SequoiaEndpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |
  Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction |
| Version | S | 1..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version |
 name | S | 1..1 | string | A name that this endpoint can be identified by |
  managingOrganization | S | 1..1 | Reference(https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxOrganization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction |
| Version | S | 1..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version |
| PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) |
| Roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required) |
| Downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime |
| endpoint-servicekey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-servicekey | |
| endpoint-bindingkey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-bindingkey | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| 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(https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxOrganization) | 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | required | EndpointConnectionType |
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodes |
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction | ||||
| Version | S | 1..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version | ||||
| PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) | ||||
| Roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required) | ||||
| Downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime | ||||
| endpoint-servicekey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-servicekey | |||||
| endpoint-bindingkey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-bindingkey | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
| 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(https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxOrganization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
| 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 | ||||
| header | 0..* | string | Usage depends on the channel type | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Endpoint.language | preferred | CommonLanguages
| ||||
| Endpoint.status | required | EndpointStatus | ||||
| Endpoint.connectionType | required | EndpointConnectionType | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodes | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from SequoiaEndpoint
Differential View
This structure is derived from SequoiaEndpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction |
| Version | S | 1..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version |
| name | S | 1..1 | string | A name that this endpoint can be identified by |
| managingOrganization | S | 1..1 | Reference(https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxOrganization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction |
| Version | S | 1..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version |
| PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) |
| Roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required) |
| Downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime |
| endpoint-servicekey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-servicekey | |
| endpoint-bindingkey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-bindingkey | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| 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(https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxOrganization) | 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | required | EndpointConnectionType |
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodes |
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction | ||||
| Version | S | 1..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version | ||||
| PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) | ||||
| Roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required) | ||||
| Downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime | ||||
| endpoint-servicekey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-servicekey | |||||
| endpoint-bindingkey | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/endpoint-bindingkey | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
| 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(https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxOrganization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |||||
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
| 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 | ||||
| header | 0..* | string | Usage depends on the channel type | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Endpoint.language | preferred | CommonLanguages
| ||||
| Endpoint.status | required | EndpointStatus | ||||
| Endpoint.connectionType | required | EndpointConnectionType | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodes | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from SequoiaEndpoint
Other representations of profile: CSV, Excel, Schematron