Sequoia Project Healthcare Directory Implementation Guide
1.0.5 - Release 1
Sequoia Project Healthcare Directory Implementation Guide
1.0.5 - Release 1
| Official URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaEndpoint | Version: 1.0.5 | |||
| Active as of 2024-03-29 | Computable Name: SequoiaEndpoint | |||
This profile on the FHIR Endpoint resource represents information about the endpoints provided by organizations participating in Sequoia project sponsored exchanges. The endpoints described can use any Sequoia supported protocol, such as IHE XCA, and need not be FHIR endpoints.
This profile on the FHIR Endpoint resource represents information about the endpoints provided by organizations participating in Sequoia project sponsored exchanges. The endpoints described can use any Sequoia supported protocol, such as IHE XCA, and need not be FHIR endpoints.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | 0..* | Endpoint | This is an abstract profile. 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 Binding: Transactions (required) |
| Version | S | 0..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 (preferred) |
| 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 |
  Slices for identifier | S | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this |
  identifier:HCID | S | 0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
   type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
 system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
 identifier:AAID | S | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
 connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: 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 (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) |
| address | S | 1..1 | url | The technical base address for connecting to this endpoint |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Endpoint.connectionType | required | EndpointConnectionTypehttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionTypefrom this IG | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodeshttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodesfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | This is an abstract profile. 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 |
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) |
| Version | S | 0..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 (preferred) |
| 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 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this |
| identifier:HCID | SΣ | 0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| identifier:AAID | SΣ | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| 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Σ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 1..1 | Reference(Sequoia 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | |
| Endpoint.connectionType | required | EndpointConnectionTypehttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionTypefrom this IG | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodeshttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodesfrom this IG | |
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| 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..* | Endpoint | This is an abstract profile. 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) | ||||
| Version | S | 0..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 (preferred) | ||||
| 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 | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this | ||||
| 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Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 1..1 | Reference(Sequoia Organization) | 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 | URI | |||
| Endpoint.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | ||||
| Endpoint.connectionType | required | EndpointConnectionTypehttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionTypefrom this IG | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodeshttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodesfrom this IG | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| 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() |
This structure is derived from Endpoint
Summary
Mandatory: 2 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | This is an abstract profile. 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 Binding: Transactions (required) |
| Version | S | 0..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 (preferred) |
| 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 |
| Slices for identifier | S | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this |
| identifier:HCID | S | 0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| identifier:AAID | S | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: 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 (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) |
| address | S | 1..1 | url | The technical base address for connecting to this endpoint |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Endpoint.connectionType | required | EndpointConnectionTypehttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionTypefrom this IG | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodeshttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodesfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | This is an abstract profile. 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 |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) |
| Version | S | 0..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 (preferred) |
| 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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this |
| identifier:HCID | SΣ | 0..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| identifier:AAID | SΣ | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
| type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| 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Σ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 1..1 | Reference(Sequoia 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | |
| Endpoint.connectionType | required | EndpointConnectionTypehttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionTypefrom this IG | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodeshttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodesfrom this IG | |
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| 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..* | Endpoint | This is an abstract profile. 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| Transaction | S | 1..1 | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) | ||||
| Version | S | 0..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 (preferred) | ||||
| 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 | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this | ||||
| 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Σ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 1..1 | Reference(Sequoia Organization) | 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 | URI | |||
| Endpoint.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | ||||
| Endpoint.connectionType | required | EndpointConnectionTypehttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionTypefrom this IG | ||||
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodeshttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodesfrom this IG | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| 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() |
This structure is derived from Endpoint
Summary
Mandatory: 2 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron