Mobile Care Services Discovery (mCSD)
3.9.0 - Trial-Implementation International flag

This page is part of the IHE ITI Mobile Care Services Discovery (v3.9.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: mCSD Endpoint for Document Sharing

Official URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Endpoint.DocShare Version: 3.9.0
Active as of 2024-12-02 Computable Name: MCSDEndpointDocShare

A profile on the mCSD Endpoint for Document Sharing environments.

Given that in FHIR R4 the .connnectionType is 1..1, each type of endpoint will be indicated with an independent Endpoint resource. Thus a XCA Responding Gateway will need two Endpoint instances to express Query vs Retrieve.

Open-Issues:

  1. That payloadType and payloadMimeType are either empty to indicate that the endpoint is not constrained; or fully populated.
  2. That payloadType and PayloadMimeType for XCA/XDS/MHD Query and XCA/XDS/MHD Retrieve would be the same thus replicating the capability at both endpoints.
  3. It did not seem right that Query be indicated with a mimeType of ebRegistry as that is not helpful to the use-case.
  4. should the homeCommunityId be mandated here, should those behind it be here, should this be empty?
  5. would a Proxy service that is supporting OrgAff be a good example of NOT putting a homeCommunityId in the endpoint.identifier?

Usage:

Formal Views of Profile Content

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

This structure is derived from MCSDEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension Content/Rules for all slices
.... specificType S 0..* CodeableConcept Endpoint Specific Type
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/ihe-endpointspecifictype
Binding: mCSD Endpoint Types ValueSet (preferred)
... identifier 0..* Identifier should be the homeCommunityId(s)
... connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: mCSD Endpoint Core Document Sharing Types ValueSet (required)
... name 0..0
... payloadType S 1..* CodeableConcept FormatCode(s)
... payloadMimeType S 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
... address 1..1 url The technical base address for connecting to this endpoint
... header 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTyperequiredMCSDEndpointTypesCoreDocShareVS
https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension Content/Rules for all slices
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
.... specificType S 0..* CodeableConcept Endpoint Specific Type
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/ihe-endpointspecifictype
Binding: mCSD Endpoint Types ValueSet (preferred)
... identifier Σ 0..* Identifier should be the homeCommunityId(s)
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: mCSD Endpoint Core Document Sharing Types ValueSet (required)
... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... period SΣ 0..1 Period Overall deployment lifetime for this endpoint.
... payloadType SΣ 1..* CodeableConcept FormatCode(s)
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredMCSDEndpointTypesCoreDocShareVS
https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
.... specificType S 0..* CodeableConcept Endpoint Specific Type
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/ihe-endpointspecifictype
Binding: mCSD Endpoint Types ValueSet (preferred)
... identifier Σ 0..* Identifier should be the homeCommunityId(s)
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: mCSD Endpoint Core Document Sharing Types ValueSet (required)
... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period SΣ 0..1 Period Overall deployment lifetime for this endpoint.
... payloadType SΣ 1..* CodeableConcept FormatCode(s)
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredMCSDEndpointTypesCoreDocShareVS
https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from MCSDEndpoint

Summary

Must-Support: 3 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from MCSDEndpoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension Content/Rules for all slices
.... specificType S 0..* CodeableConcept Endpoint Specific Type
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/ihe-endpointspecifictype
Binding: mCSD Endpoint Types ValueSet (preferred)
... identifier 0..* Identifier should be the homeCommunityId(s)
... connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: mCSD Endpoint Core Document Sharing Types ValueSet (required)
... name 0..0
... payloadType S 1..* CodeableConcept FormatCode(s)
... payloadMimeType S 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
... address 1..1 url The technical base address for connecting to this endpoint
... header 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Endpoint.connectionTyperequiredMCSDEndpointTypesCoreDocShareVS
https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... Slices for extension Content/Rules for all slices
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
.... specificType S 0..* CodeableConcept Endpoint Specific Type
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/ihe-endpointspecifictype
Binding: mCSD Endpoint Types ValueSet (preferred)
... identifier Σ 0..* Identifier should be the homeCommunityId(s)
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: mCSD Endpoint Core Document Sharing Types ValueSet (required)
... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... period SΣ 0..1 Period Overall deployment lifetime for this endpoint.
... payloadType SΣ 1..* CodeableConcept FormatCode(s)
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredMCSDEndpointTypesCoreDocShareVS
https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..* MCSDEndpoint The technical details of an endpoint that can be used for electronic services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... purposeOfUse 0..* CodeableConcept Purpose of Use Extension
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse
Binding: PurposeOfUse (preferred)
.... specificType S 0..* CodeableConcept Endpoint Specific Type
URL: https://profiles.ihe.net/ITI/mCSD/StructureDefinition/ihe-endpointspecifictype
Binding: mCSD Endpoint Types ValueSet (preferred)
... identifier Σ 0..* Identifier should be the homeCommunityId(s)
... status ?!SΣ 1..1 code represents the current status of this endpoint.
Binding: EndpointStatus (required): The status of the endpoint.

... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: mCSD Endpoint Core Document Sharing Types ValueSet (required)
... managingOrganization Σ 1..1 Reference(mCSD Organization) Organization that manages this endpoint.
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period SΣ 0..1 Period Overall deployment lifetime for this endpoint.
... payloadType SΣ 1..* CodeableConcept FormatCode(s)
Binding: EndpointPayloadType (example)
... payloadMimeType SΣ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Endpoint.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Endpoint.statusrequiredEndpointStatus
http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
from the FHIR Standard
Endpoint.connectionTyperequiredMCSDEndpointTypesCoreDocShareVS
https://profiles.ihe.net/ITI/mCSD/ValueSet/MCSDEndpointTypesCoreDocShareVS
from this IG
Endpoint.payloadTypeexampleEndpointPayloadType
http://hl7.org/fhir/ValueSet/endpoint-payload-type
from the FHIR Standard
Endpoint.payloadMimeTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

This structure is derived from MCSDEndpoint

Summary

Must-Support: 3 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron