mCSD Endpoint - Definitions - Mobile Care Services Discovery (mCSD) v3.8.1-current

Mobile Care Services Discovery (mCSD), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 3.8.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.mCSD/ and changes regularly. See the Directory of published versions

Resource Profile: MCSDEndpoint - Detailed Descriptions

Active as of 2024-05-06

Definitions for the IHE.mCSD.Endpoint resource profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. Endpoint
2. Endpoint.implicitRules
Control	0..0
4. Endpoint.extension
Slicing	This element introduces a set of slices on `Endpoint.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
6. Endpoint.extension:purposeOfUse
Slice Name	purposeOfUse
Control	0..*
Type	Extension(Purpose of Use Extension) (Extension Type: CodeableConcept)
8. Endpoint.modifierExtension
Control	0..0
10. Endpoint.status
Short	represents the current status of this endpoint.
Comments	Should be updated when maintenance or other status changes happen.
Must Support	true
12. Endpoint.managingOrganization
Definition	The organization that manages this endpoint, even if technically another organization is hosting this in the cloud.
Short	Organization that manages this endpoint.
Comments	This element is used when there is a technical problem with the endpoint operation, and would be used to contact for technical support. This managing organization relationship is potentially independent of if the organization is the custodian/owner of the data available thru this endpoint.
Control	1..?
Type	Reference(mCSD Organization)
14. Endpoint.contact
Definition	Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.
16. Endpoint.period
Short	Overall deployment lifetime for this endpoint.
Comments	usually indicating when the endpoint was deployed, and may indicate when this endpoint will be decommissioned.
Must Support	true

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

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())
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..01
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	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`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
6. Endpoint.extension:purposeOfUse
Slice Name	purposeOfUse
Definition	Set a purpose of use for an mCSD Endpoint or mCSD Organization.
Short	Purpose of Use Extension
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(Purpose of Use Extension) (Extension Type: CodeableConcept)
Is Modifier	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.modifierExtension
Definition	An Extension 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	ExtensionExtensions 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..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())
10. Endpoint.status
Definition	active \| suspended \| error \| off \| test.
Short	represents the current status of this endpoint.active \| suspended \| error \| off \| entered-in-error \| test
Comments	Should be updated when maintenance or other status changes happen. 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 EndpointStatushttp://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
Must Support	true
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. 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	Unless not suitable, these codes SHALL be taken from EndpointConnectionTypehttp://hl7.org/fhir/ValueSet/endpoint-connection-type (extensible to `http://hl7.org/fhir/ValueSet/endpoint-connection-type`)
Type	Coding
Is Modifier	false
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Endpoint.managingOrganization
Definition	The organization that manages this endpoint, even if technically another organization is hosting this in the cloud. 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.Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Comments	This element is used when there is a technical problem with the endpoint operation, and would be used to contact for technical support. This managing organization relationship is potentially independent of if the organization is the custodian/owner of the data available thru this endpoint. 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(mCSD Organization, Organization)
Is Modifier	false
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Endpoint.contact
Definition	Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting. 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()))
18. Endpoint.period
Definition	The interval during which the endpoint is expected to be operational.
Short	Overall deployment lifetime for this endpoint.Interval the endpoint is expected to be operational
Comments	usually indicating when the endpoint was deployed, and may indicate when this endpoint will be decommissioned.
Control	0..1
Type	Period
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()))
20. 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	For example codes, see EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type (example to `http://hl7.org/fhir/ValueSet/endpoint-payload-type`)
Type	CodeableConcept
Is Modifier	false
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. 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
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 found here

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

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