Mobile Care Services Discovery (mCSD)
3.8.1-current - ci-build International flag

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: MCSDEndpointDocShare - Detailed Descriptions

Active as of 2024-05-06

Definitions for the IHE.mCSD.Endpoint.DocShare resource profile.

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

0. Endpoint
2. Endpoint.extension:specificType
Slice NamespecificType
Control0..*
TypeExtension(Endpoint Specific Type) (Extension Type: CodeableConcept)
Must Supporttrue
4. Endpoint.identifier
Definition

For simple single depth XCA communites.

Shortshould be the homeCommunityId(s)
NoteThis is a business identifier, not a resource identifier (see discussion)
6. Endpoint.connectionType
BindingThe codes SHALL be taken from mCSD Endpoint Core Document Sharing Types ValueSet
(required to https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS)
8. Endpoint.name
ShortNothing useful to put in the name
Control0..0
10. Endpoint.payloadType
Definition

The list of FormatCode(s) available at this endpoint.

ShortFormatCode(s)
Comments

Empty list of FormatCode(s) indicates indeterminate set of FormatCodes supported. For XCA Responding Gateways that do not host data themselves, but rather proxy for other communities, leave this element empty.

Must Supporttrue
12. Endpoint.payloadMimeType
Must Supporttrue
14. Endpoint.address
Comments

XCA SOAP endpoint

16. Endpoint.header
ShortXCA defines protocol
Control0..0

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.

ShortThe technical details of an endpoint that can be used for electronic services
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-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.

ShortA 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.

Control0..01
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Endpoint.extension:purposeOfUse
Slice NamepurposeOfUse
Definition

Set a purpose of use for an mCSD Endpoint or mCSD Organization.

ShortPurpose of Use Extension
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Purpose of Use Extension) (Extension Type: CodeableConcept)
Is Modifierfalse
Invariantsele-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())
6. Endpoint.extension:specificType
Slice NamespecificType
Definition

The specific endpoint type. Given that the FHIR R4 Endpoint.connectionType is limited to a one value from a valueSet given by FHIR core and that valueSet includes XCA thus by Extensible rules one is forced to pick that value, we choose to add an additional codeableConcept for a more detailed code(s).

ShortEndpoint Specific Type
Control0..*
TypeExtension(Endpoint Specific Type) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
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).

ShortExtensionExtensions 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.

Control0..0*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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 Namesextensions, user content
Invariantsele-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.identifier
Definition

For simple single depth XCA communites.


Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

Shortshould be the homeCommunityId(s)Identifies this endpoint across multiple systems
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Endpoint.status
Definition

active | suspended | error | off | test.

Shortrepresents 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.

Control1..1
BindingThe 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.

Typecode
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. 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).

ShortProtocol/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.

Control1..1
BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from mCSD Endpoint Core Document Sharing Types ValueSethttp://hl7.org/fhir/ValueSet/endpoint-connection-type
(required to https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS)
TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Endpoint.name
Definition

A friendly name that this endpoint can be referred to with.

ShortNothing useful to put in the nameA name that this endpoint can be identified by
Control0..01
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. 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).

ShortOrganization 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.

Control10..1
TypeReference(mCSD Organization, Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Endpoint.period
Definition

The interval during which the endpoint is expected to be operational.

ShortOverall 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.

Control0..1
TypePeriod
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Endpoint.payloadType
Definition

The list of FormatCode(s) available at this endpoint.


The payload type describes the acceptable content that can be communicated on the endpoint.

ShortFormatCode(s)The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Comments

Empty list of FormatCode(s) indicates indeterminate set of FormatCodes supported. For XCA Responding Gateways that do not host data themselves, but rather proxy for other communities, leave this element empty.


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.

Control1..*
BindingFor example codes, see EndpointPayloadTypehttp://hl7.org/fhir/ValueSet/endpoint-payload-type
(example to http://hl7.org/fhir/ValueSet/endpoint-payload-type)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. 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).

ShortMimetype 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.

Control0..*
BindingThe codes SHALL be taken from Mime Typeshttp://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.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Endpoint.address
Definition

The uri that describes the actual end-point to connect to.

ShortThe technical base address for connecting to this endpoint
Comments

XCA SOAP endpoint


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/...".

Control1..1
Typeurl
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Endpoint.header
Definition

Additional headers / information to send as part of the notification.

ShortXCA defines protocolUsage 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.

Control0..0*
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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.

ShortThe technical details of an endpoint that can be used for electronic services
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-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.

ShortLogical 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.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-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.

ShortA 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.

Control0..0
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-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.

ShortLanguage 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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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.

ShortText 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.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-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.

ShortContained, 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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Endpoint.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis 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
  • 16. Endpoint.extension:purposeOfUse
    Slice NamepurposeOfUse
    Definition

    Set a purpose of use for an mCSD Endpoint or mCSD Organization.

    ShortPurpose of Use Extension
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Purpose of Use Extension) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Invariantsele-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:specificType
    Slice NamespecificType
    Definition

    The specific endpoint type. Given that the FHIR R4 Endpoint.connectionType is limited to a one value from a valueSet given by FHIR core and that valueSet includes XCA thus by Extensible rules one is forced to pick that value, we choose to add an additional codeableConcept for a more detailed code(s).

    ShortEndpoint Specific Type
    Control0..*
    TypeExtension(Endpoint Specific Type) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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.modifierExtension
    Definition

    An Extension

    ShortExtension
    Control0..0
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Invariantsele-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.identifier
    Definition

    For simple single depth XCA communites.

    Shortshould be the homeCommunityId(s)
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Endpoint.status
    Definition

    active | suspended | error | off | test.

    Shortrepresents the current status of this endpoint.
    Comments

    Should be updated when maintenance or other status changes happen.

    Control1..1
    BindingThe codes SHALL be taken from EndpointStatus
    (required to http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1)

    The status of the endpoint.

    Typecode
    Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. 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).

    ShortProtocol/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.

    Control1..1
    BindingThe codes SHALL be taken from mCSD Endpoint Core Document Sharing Types ValueSet
    (required to https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS)
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Endpoint.name
    Definition

    A friendly name that this endpoint can be referred to with.

    ShortNothing useful to put in the name
    Control0..0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Endpoint.managingOrganization
    Definition

    The organization that manages this endpoint, even if technically another organization is hosting this in the cloud.

    ShortOrganization 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.

    Control1..1
    TypeReference(mCSD Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Endpoint.contact
    Definition

    Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.

    ShortContact details for source (e.g. troubleshooting)
    Control0..*
    TypeContactPoint
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Endpoint.period
    Definition

    The interval during which the endpoint is expected to be operational.

    ShortOverall deployment lifetime for this endpoint.
    Comments

    usually indicating when the endpoint was deployed, and may indicate when this endpoint will be decommissioned.

    Control0..1
    TypePeriod
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Endpoint.payloadType
    Definition

    The list of FormatCode(s) available at this endpoint.

    ShortFormatCode(s)
    Comments

    Empty list of FormatCode(s) indicates indeterminate set of FormatCodes supported. For XCA Responding Gateways that do not host data themselves, but rather proxy for other communities, leave this element empty.

    Control1..*
    BindingFor example codes, see EndpointPayloadType
    (example to http://hl7.org/fhir/ValueSet/endpoint-payload-type)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. 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).

    ShortMimetype 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.

    Control0..*
    BindingThe 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.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Endpoint.address
    Definition

    The uri that describes the actual end-point to connect to.

    ShortThe technical base address for connecting to this endpoint
    Comments

    XCA SOAP endpoint

    Control1..1
    Typeurl
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Endpoint.header
    Definition

    Additional headers / information to send as part of the notification.

    ShortXCA defines protocol
    Comments

    Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.

    Control0..0
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))