0.0.1 - CI Build
0.0.1 - CI Build
SequoiaProjectHealthcareDirectoryImplementationGuideSTU3 - Local Development build (v0.0.1). See the Directory of published versions
The official URL for this profile is:
https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/SequoiaEndpoint
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Endpoint
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | I | 0..* | Endpoint | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 EndpointMain | SI | 0..1 | (Complex) | Endpoint Main URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/EndpointMain |
| Downtime | SI | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Downtime |
| endpoint-servicekey | I | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/endpoint-servicekey |
| endpoint-keyversion | I | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/endpoint-keyversion |
| endpoint-bindingkey | I | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/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) |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: http://hl7.org/fhir/endpoint-connection-type (required) |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
 managingOrganization | SΣ | 1..1 | Reference(Sequoia Organization) | Organization that manages this endpoint (may 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 (example) |
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: mimetypes (required) |
| address | SΣ | 1..1 | uri | The technical base address for connecting to this endpoint |
 header | 0..* | string | Usage depends on the channel type | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | I | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services |
| EndpointMain | I | 0..1 | (Complex) | Endpoint Main URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/EndpointMain |
| Downtime | I | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Downtime |
| identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| connectionType | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: http://hl7.org/fhir/endpoint-connection-type (required) |
| name | Σ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | Σ | 1..1 | Reference(Sequoia Organization) | Organization that manages this endpoint (may not be the organization that exposes the endpoint) |
| payloadType | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type (example) |
| payloadMimeType | Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: mimetypes (required) |
| address | Σ | 1..1 | uri | The technical base address for connecting to this endpoint |
| Documentation for this format | ||||
This structure is derived from Endpoint
Summary
Mandatory: 1 element
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Endpoint
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | I | 0..* | Endpoint | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| EndpointMain | SI | 0..1 | (Complex) | Endpoint Main URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/EndpointMain |
| Downtime | SI | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Downtime |
| endpoint-servicekey | I | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/endpoint-servicekey |
| endpoint-keyversion | I | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/endpoint-keyversion |
| endpoint-bindingkey | I | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/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) |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: http://hl7.org/fhir/endpoint-connection-type (required) |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 1..1 | Reference(Sequoia Organization) | Organization that manages this endpoint (may 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 (example) |
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: mimetypes (required) |
| address | SΣ | 1..1 | uri | The technical base address for connecting to this endpoint |
| header | 0..* | string | Usage depends on the channel type | |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Endpoint.language | extensible | Common Languages Max Binding: All Languages |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | required | http://hl7.org/fhir/endpoint-connection-type |
| Endpoint.payloadType | example | Endpoint Payload Type |
| Endpoint.payloadMimeType | required | http://hl7.org/fhir/ValueSet/mimetypes |
| Id | Path | Details | Requirements |
| dom-2 | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Endpoint | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | 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-3 | Endpoint | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | Endpoint.extension:EndpointMain | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Endpoint.extension:EndpointMain | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Endpoint.extension:Downtime | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Endpoint.extension:Downtime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Endpoint.extension:endpoint-servicekey | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Endpoint.extension:endpoint-servicekey | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Endpoint.extension:endpoint-keyversion | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Endpoint.extension:endpoint-keyversion | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Endpoint.extension:endpoint-bindingkey | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Endpoint.extension:endpoint-bindingkey | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
