Sequoia Project Healthcare Directory Implementation Guide
1.18.0 - Release 1

Resource Profile: Sequoia Endpoint ( Abstract )

Official URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaEndpoint Version: 1.18.0
Active as of 2026-10-27 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.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint C 0..* Endpoint This is an abstract profile.
The technical details of an endpoint that can be used for electronic services
Constraints: se-1
Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Endpoint.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:transaction This element must be supported. 1..1 CodeableConcept When used on an endpoint, this identifies responding transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Endpoint.Slices for extension.extension:timeout This element must be supported. 0..1 Duration Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
Endpoint.Slices for extension.extension:version This element must be supported. 0..1 string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
Endpoint.Slices for extension.extension:purposesofuse This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
Endpoint.Slices for extension.extension:roles This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: Author Role (required)
Endpoint.Slices for extension.extension:downtime This element must be supported. 0..* Period, Timing Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
Endpoint.Slices for extension.extension:fhirigconformance This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
Endpoint.Slices for extension.extension:lastupdate This element must be supported. 0..1 Reference(AuditEvent) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
Endpoint.Slices for extension.extension:endpointtype This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType
Binding: Endpoint Type (required)
Endpoint.Slices for extension.extension:iasresponsemode This element must be supported. 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode
Binding: IAS Response Mode Value Set (required)
Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Endpoint.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. 0..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType This element must be supported. This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string A name that this endpoint can be identified by
Endpoint.managingOrganization This element must be supported. This element is included in summaries. 1..1 Reference(Sequoia Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.payloadType This element must be supported. This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
Endpoint.payloadMimeType This element must be supported. This element is included in summaries. 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.
Endpoint.address This element must be supported. This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base required Endpoint Connection Type 📦1.18.0 This IG
Endpoint.payloadType Base extensible Endpoint Payload Type Codes 📦1.18.0 This IG
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

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 Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint C 0..* Endpoint This is an abstract profile.
The technical details of an endpoint that can be used for electronic services
Constraints: se-1
Endpoint.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:transaction This element must be supported. 1..1 CodeableConcept When used on an endpoint, this identifies responding transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Endpoint.Slices for extension.extension:timeout This element must be supported. 0..1 Duration Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
Endpoint.Slices for extension.extension:version This element must be supported. 0..1 string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
Endpoint.Slices for extension.extension:purposesofuse This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
Endpoint.Slices for extension.extension:roles This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: Author Role (required)
Endpoint.Slices for extension.extension:downtime This element must be supported. 0..* Period, Timing Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
Endpoint.Slices for extension.extension:fhirigconformance This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
Endpoint.Slices for extension.extension:lastupdate This element must be supported. 0..1 Reference(AuditEvent) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
Endpoint.Slices for extension.extension:endpointtype This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType
Binding: Endpoint Type (required)
Endpoint.Slices for extension.extension:iasresponsemode This element must be supported. 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode
Binding: IAS Response Mode Value Set (required)
Endpoint.Slices for identifier This element must be supported. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:HCID This element must be supported. 0..1 Identifier OID (such as a Home Community ID) or UUID
Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.Slices for identifier.identifier:AAID This element must be supported. 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.connectionType This element must be supported. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
Endpoint.managingOrganization This element must be supported. 1..1 Reference(Sequoia Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.payloadType This element must be supported. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
Endpoint.payloadMimeType This element must be supported. 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Endpoint.address This element must be supported. 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Endpoint.connectionType Base required Endpoint Connection Type 📦1.18.0 This IG
Endpoint.payloadType Base extensible Endpoint Payload Type Codes 📦1.18.0 This IG

Constraints

Id Grade Path(s) Description Expression
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()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint C 0..* Endpoint This is an abstract profile.
The technical details of an endpoint that can be used for electronic services
Constraints: se-1
Endpoint.id This element is included in summaries. 0..1 id Logical id of this artifact
Endpoint.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Endpoint.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Endpoint.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
Endpoint.contained 0..* Resource Contained, inline Resources
Endpoint.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:transaction This element must be supported. 1..1 CodeableConcept When used on an endpoint, this identifies responding transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Endpoint.Slices for extension.extension:timeout This element must be supported. 0..1 Duration Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
Endpoint.Slices for extension.extension:version This element must be supported. 0..1 string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
Endpoint.Slices for extension.extension:purposesofuse This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
Endpoint.Slices for extension.extension:roles This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: Author Role (required)
Endpoint.Slices for extension.extension:downtime This element must be supported. 0..* Period, Timing Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
Endpoint.Slices for extension.extension:fhirigconformance This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
Endpoint.Slices for extension.extension:lastupdate This element must be supported. 0..1 Reference(AuditEvent) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
Endpoint.Slices for extension.extension:endpointtype This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType
Binding: Endpoint Type (required)
Endpoint.Slices for extension.extension:iasresponsemode This element must be supported. 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode
Binding: IAS Response Mode Value Set (required)
Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Endpoint.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. 0..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType This element must be supported. This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string A name that this endpoint can be identified by
Endpoint.managingOrganization This element must be supported. This element is included in summaries. 1..1 Reference(Sequoia Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
Endpoint.period This element is included in summaries. 0..1 Period Interval the endpoint is expected to be operational
Endpoint.payloadType This element must be supported. This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
Endpoint.payloadMimeType This element must be supported. This element is included in summaries. 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.
Endpoint.address This element must be supported. This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint
Endpoint.header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base required Endpoint Connection Type 📦1.18.0 This IG
Endpoint.payloadType Base extensible Endpoint Payload Type Codes 📦1.18.0 This IG
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint C 0..* Endpoint This is an abstract profile.
The technical details of an endpoint that can be used for electronic services
Constraints: se-1
Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Endpoint.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:transaction This element must be supported. 1..1 CodeableConcept When used on an endpoint, this identifies responding transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Endpoint.Slices for extension.extension:timeout This element must be supported. 0..1 Duration Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
Endpoint.Slices for extension.extension:version This element must be supported. 0..1 string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
Endpoint.Slices for extension.extension:purposesofuse This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
Endpoint.Slices for extension.extension:roles This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: Author Role (required)
Endpoint.Slices for extension.extension:downtime This element must be supported. 0..* Period, Timing Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
Endpoint.Slices for extension.extension:fhirigconformance This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
Endpoint.Slices for extension.extension:lastupdate This element must be supported. 0..1 Reference(AuditEvent) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
Endpoint.Slices for extension.extension:endpointtype This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType
Binding: Endpoint Type (required)
Endpoint.Slices for extension.extension:iasresponsemode This element must be supported. 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode
Binding: IAS Response Mode Value Set (required)
Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Endpoint.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. 0..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType This element must be supported. This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string A name that this endpoint can be identified by
Endpoint.managingOrganization This element must be supported. This element is included in summaries. 1..1 Reference(Sequoia Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.payloadType This element must be supported. This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
Endpoint.payloadMimeType This element must be supported. This element is included in summaries. 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.
Endpoint.address This element must be supported. This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base required Endpoint Connection Type 📦1.18.0 This IG
Endpoint.payloadType Base extensible Endpoint Payload Type Codes 📦1.18.0 This IG
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

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 Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint C 0..* Endpoint This is an abstract profile.
The technical details of an endpoint that can be used for electronic services
Constraints: se-1
Endpoint.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:transaction This element must be supported. 1..1 CodeableConcept When used on an endpoint, this identifies responding transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Endpoint.Slices for extension.extension:timeout This element must be supported. 0..1 Duration Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
Endpoint.Slices for extension.extension:version This element must be supported. 0..1 string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
Endpoint.Slices for extension.extension:purposesofuse This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
Endpoint.Slices for extension.extension:roles This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: Author Role (required)
Endpoint.Slices for extension.extension:downtime This element must be supported. 0..* Period, Timing Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
Endpoint.Slices for extension.extension:fhirigconformance This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
Endpoint.Slices for extension.extension:lastupdate This element must be supported. 0..1 Reference(AuditEvent) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
Endpoint.Slices for extension.extension:endpointtype This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType
Binding: Endpoint Type (required)
Endpoint.Slices for extension.extension:iasresponsemode This element must be supported. 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode
Binding: IAS Response Mode Value Set (required)
Endpoint.Slices for identifier This element must be supported. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:HCID This element must be supported. 0..1 Identifier OID (such as a Home Community ID) or UUID
Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.Slices for identifier.identifier:AAID This element must be supported. 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.connectionType This element must be supported. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
Endpoint.name This element must be supported. 0..1 string A name that this endpoint can be identified by
Endpoint.managingOrganization This element must be supported. 1..1 Reference(Sequoia Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.payloadType This element must be supported. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
Endpoint.payloadMimeType This element must be supported. 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Endpoint.address This element must be supported. 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Endpoint.connectionType Base required Endpoint Connection Type 📦1.18.0 This IG
Endpoint.payloadType Base extensible Endpoint Payload Type Codes 📦1.18.0 This IG

Constraints

Id Grade Path(s) Description Expression
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Endpoint C 0..* Endpoint This is an abstract profile.
The technical details of an endpoint that can be used for electronic services
Constraints: se-1
Endpoint.id This element is included in summaries. 0..1 id Logical id of this artifact
Endpoint.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Endpoint.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Endpoint.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Endpoint.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
Endpoint.contained 0..* Resource Contained, inline Resources
Endpoint.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for extension.extension:transaction This element must be supported. 1..1 CodeableConcept When used on an endpoint, this identifies responding transactions
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
Endpoint.Slices for extension.extension:timeout This element must be supported. 0..1 Duration Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Timeout
Endpoint.Slices for extension.extension:version This element must be supported. 0..1 string Optional Extensions Element
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
Endpoint.Slices for extension.extension:purposesofuse This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
Endpoint.Slices for extension.extension:roles This element must be supported. 0..* CodeableConcept Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: Author Role (required)
Endpoint.Slices for extension.extension:downtime This element must be supported. 0..* Period, Timing Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
Endpoint.Slices for extension.extension:fhirigconformance This element must be supported. 0..* (Complex) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance
Endpoint.Slices for extension.extension:lastupdate This element must be supported. 0..1 Reference(AuditEvent) Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/LastUpdate
Endpoint.Slices for extension.extension:endpointtype This element must be supported. 0..1 Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/EndpointType
Binding: Endpoint Type (required)
Endpoint.Slices for extension.extension:iasresponsemode This element must be supported. 0..* Coding Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/IASResponseMode
Binding: IAS Response Mode Value Set (required)
Endpoint.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Endpoint.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Endpoint.Slices for identifier.identifier:HCID This element must be supported. This element is included in summaries. 0..1 Identifier OID (such as a Home Community ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "HCID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.Slices for identifier.identifier:AAID This element must be supported. This element is included in summaries. 0..* Identifier OID (such as an Assiging Authority ID) or UUID

Required Pattern: 
{
  "type" : {
    "coding" : [
      {
        "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes",
        "code" : "AAID"
      }
    ]
  },
  "system" : "urn:ietf:rfc:3986"
}
Endpoint.status This element is a modifier element. This element is included in summaries. 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
Endpoint.connectionType This element must be supported. This element is included in summaries. 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
Endpoint.name This element must be supported. This element is included in summaries. 0..1 string A name that this endpoint can be identified by
Endpoint.managingOrganization This element must be supported. This element is included in summaries. 1..1 Reference(Sequoia Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Endpoint.contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
Endpoint.period This element is included in summaries. 0..1 Period Interval the endpoint is expected to be operational
Endpoint.payloadType This element must be supported. This element is included in summaries. 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
Endpoint.payloadMimeType This element must be supported. This element is included in summaries. 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.
Endpoint.address This element must be supported. This element is included in summaries. 1..1 url The technical base address for connecting to this endpoint
Endpoint.header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base required Endpoint Connection Type 📦1.18.0 This IG
Endpoint.payloadType Base extensible Endpoint Payload Type Codes 📦1.18.0 This IG
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

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()

 

Other representations of profile: CSV, Excel, Schematron