Recognized Coordinating Entity (RCE) Implementation Guide
1.0.3 - Release 1 United States of America flag

Resource Profile: RCE Endpoint

Official URL: https://sequoiaproject.org/fhir/rce/StructureDefinition/RCE-Endpoint Version: 1.0.3
Active as of 2023-12-13 Computable Name: RCEEndpoint

Copyright/Legal: Copyright © 2023 The Sequoia Project. All rights reserved.

This profile on the FHIR Endpoint resource represents information about the endpoints provided by Organizations participating in TEFCA exchange. The endpoints described can use any QTF-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 TEFCA exchange. The endpoints described can use any QTF-supported protocol, such as IHE XCA, and need not be FHIR endpoints.

Usage:

Formal Views of Profile Content

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

This structure is derived from SequoiaEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
.... value[x] 1..1CodeableConceptValue of extension
Binding: RCE Purpose ValueSet (required)
... managingOrganization 1..1Reference(RCE Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Endpoint.extension:PurposesOfUse.value[x]requiredRCE-Purpose-VS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... Transaction S1..1CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
.... url 1..1uri"https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
.... value[x] 1..1CodeableConceptValue of extension
Binding: RCE Purpose ValueSet (required)
... Roles S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
... Downtime S0..*Period, TimingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:HCID SΣ0..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... identifier:AAID SΣ0..*IdentifierOID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AAID
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(RCE Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType SΣ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
... payloadMimeType SΣ0..*codeMimetype 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..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.extension:PurposesOfUse.value[x]requiredRCE-Purpose-VS
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTyperequiredEndpointConnectionType
Endpoint.payloadTypeextensibleEndpointPayloadTypeCodes
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... Transaction S1..1CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
... Version S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
.... value[x] 1..1CodeableConceptValue of extension
Binding: RCE Purpose ValueSet (required)
... Roles S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
... Downtime S0..*Period, TimingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:HCID SΣ0..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:AAID SΣ0..*IdentifierOID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AAID
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(RCE Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
... payloadMimeType SΣ0..*codeMimetype 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..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.extension:PurposesOfUse.value[x]requiredRCE-Purpose-VS
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTyperequiredEndpointConnectionType
Endpoint.payloadTypeextensibleEndpointPayloadTypeCodes
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SequoiaEndpoint

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from SequoiaEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
.... value[x] 1..1CodeableConceptValue of extension
Binding: RCE Purpose ValueSet (required)
... managingOrganization 1..1Reference(RCE Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Endpoint.extension:PurposesOfUse.value[x]requiredRCE-Purpose-VS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... Transaction S1..1CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
.... url 1..1uri"https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
.... value[x] 1..1CodeableConceptValue of extension
Binding: RCE Purpose ValueSet (required)
... Roles S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
... Downtime S0..*Period, TimingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:HCID SΣ0..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... identifier:AAID SΣ0..*IdentifierOID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AAID
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(RCE Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... payloadType SΣ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
... payloadMimeType SΣ0..*codeMimetype 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..1urlThe technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.extension:PurposesOfUse.value[x]requiredRCE-Purpose-VS
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTyperequiredEndpointConnectionType
Endpoint.payloadTypeextensibleEndpointPayloadTypeCodes
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*SequoiaEndpointThe technical details of an endpoint that can be used for electronic services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... Transaction S1..1CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction
Binding: Transactions (required)
... Version S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (preferred)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse"
.... value[x] 1..1CodeableConceptValue of extension
Binding: RCE Purpose ValueSet (required)
... Roles S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles
Binding: NHIN User Role (required)
... Downtime S0..*Period, TimingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierIdentifies this endpoint across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:HCID SΣ0..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:AAID SΣ0..*IdentifierOID (such as an Assiging Authority ID) or UUID

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: AAID
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType SΣ1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: Endpoint Connection Type (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(RCE Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..*ContactPointContact details for source (e.g. troubleshooting)
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: Endpoint Payload Type Codes (extensible)
... payloadMimeType SΣ0..*codeMimetype 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..1urlThe technical base address for connecting to this endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Endpoint.extension:PurposesOfUse.value[x]requiredRCE-Purpose-VS
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTyperequiredEndpointConnectionType
Endpoint.payloadTypeextensibleEndpointPayloadTypeCodes
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorEndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEndpointIf 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-4errorEndpointIf 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-5errorEndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SequoiaEndpoint

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron