Carequality Healthcare Directory ImplementationGuide
1.12.0 - Release 1

Carequality Healthcare Directory ImplementationGuide - Local Development build (v1.12.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Carequality Endpoint

Official URL: https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityEndpoint | Version: 1.12.0
Active as of 2026-03-12 | Computable Name: CarequalityEndpoint

The Carequality Endpoint profile represents information about the endpoints provided by organizations participating in the Carequality Interoperability Framework. The endpoints described can use any supported protocol defined in the respective Carequality Implementation Guide, such as IHE XCA, and need not be FHIR endpoints.

Usages:

- Refer to this Profile: Carequality Organization
- Examples for this Profile: Patient Discovery

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:transaction | S | 1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:timeout | S | 0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
extension:version | S | 0..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required)
extension:downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
extension:fhirigconformance | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
extension:lastupdate | S | 0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
extension:endpointtype | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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(Carequality 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.12.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.12.0 | This IG
Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.12.0 | This IG
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint |  | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services
Slices for extension |  |  |  | Content/Rules for all slices
extension:purposesofuse |  | 0..* | PurposesOfUse | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
managingOrganization |  | 1..1 | Reference(Carequality Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Endpoint.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.12.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:transaction | S | 1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:timeout | S | 0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
extension:version | S | 0..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required)
extension:downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
extension:fhirigconformance | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
extension:lastupdate | S | 0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
extension:endpointtype | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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(Carequality 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

#### Terminology Bindings

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.12.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.12.0 | This IG
Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.12.0 | This IG
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

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

Summary

Structures

This structure refers to these other structures:

- Carequality Organization (https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityOrganization)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:transaction | S | 1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:timeout | S | 0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
extension:version | S | 0..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required)
extension:downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
extension:fhirigconformance | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
extension:lastupdate | S | 0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
extension:endpointtype | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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(Carequality 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Endpoint.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.12.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.12.0 | This IG
Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.12.0 | This IG
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint |  | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services
Slices for extension |  |  |  | Content/Rules for all slices
extension:purposesofuse |  | 0..* | PurposesOfUse | Extension
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
managingOrganization |  | 1..1 | Reference(Carequality Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Endpoint.extension:purposesofuse.​value[x] | Base | required | Purpose Of Use | 📦1.12.0 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Endpoint | C | 0..* | SequoiaEndpoint | The technical details of an endpoint that can be used for electronic services Constraints: se-1
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:transaction | S | 1..1 | CodeableConcept | When used on an endpoint, this identifies responding transactions URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required)
extension:timeout | S | 0..1 | Duration | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
extension:version | S | 0..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
extension:purposesofuse | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required)
extension:roles | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required)
extension:downtime | S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
extension:fhirigconformance | S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
extension:lastupdate | S | 0..1 | Reference(AuditEvent) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
extension:endpointtype | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType Binding: Endpoint Type (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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(Carequality 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

#### Terminology Bindings

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.12.0 | This IG
Endpoint.status | Base | required | EndpointStatus | 📍4.0.1 | FHIR Std.
Endpoint.connectionType | Base | required | Endpoint Connection Type | 📦1.12.0 | This IG
Endpoint.payloadType | Base | extensible | Endpoint Payload Type Codes | 📦1.12.0 | This IG
Endpoint.payloadMimeType | Base | required | MimeType | 📍4.0.1 | FHIR Std.

#### Constraints

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

Summary

Structures

This structure refers to these other structures:

- Carequality Organization (https://sequoiaproject.org/fhir/cq/StructureDefinition/CarequalityOrganization)

Other representations of profile: CSV, Excel, Schematron