Recognized Coordinating Entity (RCE) Implementation Guide
1.9.0 - Release 1

Recognized Coordinating Entity (RCE) Implementation Guide - Local Development build (v1.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: RCEEndpoint - Detailed Descriptions

Active as of 2025-12-22

Definitions for the RCE-Endpoint resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Endpoint
Definition | The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
Short | The technical details of an endpoint that can be used for electronic services
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) se-1: 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()`)
2. Endpoint.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Endpoint.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 10..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Endpoint.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Endpoint.extension:transaction
Slice Name | transaction
Definition | When used on an endpoint, this identifies responding transactions
Short | When used on an endpoint, this identifies responding transactions
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(Transaction) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Endpoint.extension:version
Slice Name | version
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Version) (Extension Type: string)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Endpoint.extension:purposesofuse
Slice Name | purposesofuse
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Purposes Of Use) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Endpoint.extension:purposesofuse.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..0*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Endpoint.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
14. Endpoint.extension:purposesofuse.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse`
16. Endpoint.extension:purposesofuse.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 10..1
Binding | The codes SHALL be taken from For codes, see RCE Purpose ValueSet (required to `https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS` )
Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Endpoint.extension:roles
Slice Name | roles
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Roles) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Endpoint.extension:downtime
Slice Name | downtime
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Downtime) (Extension Type: Choice of: Period, Timing)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Endpoint.extension:fhirigconformance
Slice Name | fhirigconformance
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(FHIR IG Conformance) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. Endpoint.extension:lastupdate
Slice Name | lastupdate
Definition | An Extension
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Last Update) (Extension Type: Reference(AuditEvent))
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Endpoint.extension:endpointtype
Slice Name | endpointtype
Definition | An Extension
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(EndpointType) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. Endpoint.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. Endpoint.identifier
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Short | Identifies this endpoint across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Endpoint.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
32. Endpoint.identifier:HCID
Slice Name | HCID
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Short | OID (such as a Home Community ID) or UUIDIdentifies this endpoint across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "type" : { "coding" : [{ "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes", "code" : "HCID" }] }, "system" : "urn:ietf:rfc:3986" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Endpoint.identifier:AAID
Slice Name | AAID
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Short | OID (such as an Assiging Authority ID) or UUIDIdentifies this endpoint across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "type" : { "coding" : [{ "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes", "code" : "AAID" }] }, "system" : "urn:ietf:rfc:3986" }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Endpoint.status
Definition | active | suspended | error | off | test.
Short | active | suspended | error | off | entered-in-error | test
Comments | This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1` ) The status of the endpoint.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Endpoint.connectionType
Definition | A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
Short | Protocol/Profile/Standard to be used with this endpoint connection
Comments | For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.
Control | 1..1
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Endpoint Connection Type http://hl7.org/fhir/ValueSet/endpoint-connection-type|4.0.1 (required to `https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionType` )
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Endpoint.name
Definition | A friendly name that this endpoint can be referred to with.
Short | A name that this endpoint can be identified by
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Endpoint.managingOrganization
Definition | The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
Short | Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Comments | This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.
Control | 10..1
Type | Reference(RCE Organization, Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Endpoint.payloadType
Definition | The payload type describes the acceptable content that can be communicated on the endpoint.
Short | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Comments | The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
Control | 1..*
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see Endpoint Payload Type Codes http://hl7.org/fhir/ValueSet/endpoint-payload-type|4.0.1 (extensible to `https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodes` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Endpoint.payloadMimeType
Definition | The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
Short | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Comments | Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.
Control | 0..*
Binding | The codes SHALL be taken from Mime Types http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 (required to `http://hl7.org/fhir/ValueSet/mimetypes|4.0.1` ) The mime type of an attachment. Any valid mime type is allowed.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Endpoint.address
Definition | The uri that describes the actual end-point to connect to.
Short | The technical base address for connecting to this endpoint
Comments | For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".
Control | 1..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Endpoint
2. Endpoint.extension:purposesofuse
Slice Name | purposesofuse
4. Endpoint.extension:purposesofuse.value[x]
Binding | The codes SHALL be taken from RCE Purpose ValueSet (required to `https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS` )
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
6. Endpoint.managingOrganization
Type | Reference(RCE Organization)

Guidance on how to interpret the contents of this table can be foundhere

0. Endpoint
Definition | The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
Short | The technical details of an endpoint that can be used for electronic services
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) se-1: 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()`)
2. Endpoint.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. Endpoint.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Endpoint.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Endpoint.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages|4.0.1` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Endpoint.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Endpoint.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Endpoint.extension
Definition | An Extension
Short | Extension
Control | 1..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Endpoint.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. Endpoint.extension:transaction
Slice Name | transaction
Definition | When used on an endpoint, this identifies responding transactions
Short | When used on an endpoint, this identifies responding transactions
Control | 1..1 This element is affected by the following invariants: ele-1
Type | Extension(Transaction) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Endpoint.extension:version
Slice Name | version
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Version) (Extension Type: string)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. Endpoint.extension:purposesofuse
Slice Name | purposesofuse
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Purposes Of Use) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. Endpoint.extension:purposesofuse.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
24. Endpoint.extension:purposesofuse.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Endpoint.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
26. Endpoint.extension:purposesofuse.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse`
28. Endpoint.extension:purposesofuse.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 1..1
Binding | The codes SHALL be taken from RCE Purpose ValueSet (required to `https://sequoiaproject.org/fhir/sphd/ValueSet/RCEPurposeVS` )
Type | CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Endpoint.extension:roles
Slice Name | roles
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Roles) (Extension Type: CodeableConcept)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
32. Endpoint.extension:downtime
Slice Name | downtime
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Downtime) (Extension Type: Choice of: Period, Timing)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. Endpoint.extension:fhirigconformance
Slice Name | fhirigconformance
Definition | An Extension
Short | Extension
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(FHIR IG Conformance) (Complex Extension)
Is Modifier | false
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
36. Endpoint.extension:lastupdate
Slice Name | lastupdate
Definition | An Extension
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Last Update) (Extension Type: Reference(AuditEvent))
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
38. Endpoint.extension:endpointtype
Slice Name | endpointtype
Definition | An Extension
Short | Extension
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(EndpointType) (Extension Type: Coding)
Is Modifier | false
Must Support | true
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
40. Endpoint.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
42. Endpoint.identifier
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Short | Identifies this endpoint across multiple systems
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Endpoint.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ $this
44. Endpoint.identifier:HCID
Slice Name | HCID
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Short | OID (such as a Home Community ID) or UUID
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "type" : { "coding" : [{ "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes", "code" : "HCID" }] }, "system" : "urn:ietf:rfc:3986" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Endpoint.identifier:AAID
Slice Name | AAID
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Short | OID (such as an Assiging Authority ID) or UUID
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Pattern Value | `{ "type" : { "coding" : [{ "system" : "https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes", "code" : "AAID" }] }, "system" : "urn:ietf:rfc:3986" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Endpoint.status
Definition | active | suspended | error | off | test.
Short | active | suspended | error | off | entered-in-error | test
Comments | This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from EndpointStatus (required to `http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1` ) The status of the endpoint.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Endpoint.connectionType
Definition | A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
Short | Protocol/Profile/Standard to be used with this endpoint connection
Comments | For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.
Control | 1..1
Binding | The codes SHALL be taken from Endpoint Connection Type (required to `https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionType` )
Type | Coding
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Endpoint.name
Definition | A friendly name that this endpoint can be referred to with.
Short | A name that this endpoint can be identified by
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Endpoint.managingOrganization
Definition | The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
Short | Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Comments | This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.
Control | 1..1
Type | Reference(RCE Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Endpoint.contact
Definition | Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
Short | Contact details for source (e.g. troubleshooting)
Control | 0..*
Type | ContactPoint
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Endpoint.period
Definition | The interval during which the endpoint is expected to be operational.
Short | Interval the endpoint is expected to be operational
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Endpoint.payloadType
Definition | The payload type describes the acceptable content that can be communicated on the endpoint.
Short | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Comments | The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
Control | 1..*
Binding | Unless not suitable, these codes SHALL be taken from Endpoint Payload Type Codes (extensible to `https://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodes` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Endpoint.payloadMimeType
Definition | The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
Short | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Comments | Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.
Control | 0..*
Binding | The codes SHALL be taken from Mime Types (required to `http://hl7.org/fhir/ValueSet/mimetypes|4.0.1` ) The mime type of an attachment. Any valid mime type is allowed.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Endpoint.address
Definition | The uri that describes the actual end-point to connect to.
Short | The technical base address for connecting to this endpoint
Comments | For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".
Control | 1..1
Type | url
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Endpoint.header
Definition | Additional headers / information to send as part of the notification.
Short | Usage depends on the channel type
Comments | Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
Control | 0..*
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)