Mobile Care Services Discovery (mCSD)
4.0.0-comment - ballot International flag

This page is part of the IHE ITI Mobile Care Services Discovery (v4.0.0-comment: Publication Ballot 8) 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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

IHE ITI Mobile Care Services Discovery (mCSD) - Data Source

CapabilityStatement for Data Source Actor in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

IHE ITI Mobile Care Services Discovery (mCSD) - Directory

CapabilityStatement for Directory Actor in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

IHE ITI Mobile Care Services Discovery (mCSD) - Directory Feed Option

CapabilityStatement for Directory Actor with the Feed Option in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

IHE ITI Mobile Care Services Discovery (mCSD) - Directory Location Distance Option

CapabilityStatement for Directory Actor with the Location Distance option in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

IHE ITI Mobile Care Services Discovery (mCSD) - Directory with Update Option

CapabilityStatement for Directory Actor with the Update Option in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

IHE ITI Mobile Care Services Discovery (mCSD) - Query Client

CapabilityStatement for Query Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

IHE ITI Mobile Care Services Discovery (mCSD) - Query Client Location Distance Option

CapabilityStatement for Query Client Actor with the Location Distance Option in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

IHE ITI Mobile Care Services Discovery (mCSD) - Update Client

CapabilityStatement for Update Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Search on the IHE defined extension for Endpoint specificType

This SearchParameter enables finding Endpoints by the specificType code. This resource is created as informative content.

Search on the IHE defined extension for Purpose of Use

This SearchParameter enables finding Endpoints or Organizatoins by the purpose of use code. This resource is created as informative content.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Audit Event for Care Services Feed Transaction by the Directory and Care Services Selective Feed for Batch/Transaction

Defines constraints on the AuditEvent Resource to record when a Care Services Feed Transaction happens to do batch/transaction updates to Care Services resources, as recorded by the Directory or Data Source.

Audit Event for Care Services Feed Transaction by the Directory and Care Services Selective Feed for Create

Defines constraints on the AuditEvent Resource to record when a Care Services Feed Transaction happens to create a Care Services resource, as recorded by the Directory or Data Source.

Audit Event for Care Services Feed Transaction by the Directory and Care Services Selective Feed for Delete

Defines constraints on the AuditEvent Resource to record when a Care Services Feed Transaction happens to delete a Care Services resource, as recorded by the Directory or Data Source.

Audit Event for Care Services Feed Transaction by the Directory and Care Services Selective Feed for Update

Defines constraints on the AuditEvent Resource to record when a Care Services Feed Transaction happens to update a Care Services resource, as recorded by the Directory or Data Source.

Audit Event for Find Matching Care Services Transaction by the Query Client and Directory for Query

Defines constraints on the AuditEvent Resource to record when a Find Matching Care Services Transaction happens to query a Care Services Resource, as recorded by the Directory or Query Client.

Audit Event for Find Matching Care Services Transaction by the Query Client and Directory for Read

Defines constraints on the AuditEvent Resource to record when a Find Matching Care Services Transaction happens to read a Care Services resource, as recorded by the Query Client or Directory.

Audit Event for Request Care Services Updates Transaction by the Update Client and Directory

Defines constraints on the AuditEvent Resource to record when a Request Care Services Updates Transaction happens for a Care Services Resource updates, as recorded by the Directory or Update Client.

mCSD Endpoint

A profile on the mCSD Endpoint.

An Organization may be reachable through electronic Endpoint(s). An Endpoint may be a FHIR server, an IHE web services actor, or some other mechanism. If an Organization does not have an Endpoint, it may still be reachable via an Endpoint at its parent Organization or an affiliated Organization.

Given that in FHIR R4 the .connnectionType is 1..1, each type of endpoint will be indicated with an independent Endpoint resource.

mCSD Endpoint for Document Sharing

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?
mCSD HealthcareService

A profile on the HealthcareService resource for mCSD.

Each healthcare service has a unique identifier. Examples include surgical services, antenatal care services, or primary care services. The combination of a Healthcare Service offered at a Location may have specific attributes including contact person, hours of operation, etc.

mCSD Location

A profile on the Location resource for mCSD.

Locations are physical places where care can be delivered such as facilities, buildings, wards, rooms, or vehicles. Locations also include jurisdictions such as a village districts or regions. A Location has a unique identifier and may have geographic attributes (address, geocode), attributes regarding its hours of operation, etc. Each Location may be related to one Organization. A location may have a hierarchical relationship with other locations.

mCSD Location for Facilities

A profile on mCSD Location for mCSD Facilities.

Facilities are physical care delivery sites such as hospitals, clinics, health outposts, physician offices, labs, pharmacies, etc. A Facility has a unique identifier, geographic attributes (address, geocode), contact attributes, attributes regarding its hours of operation, etc. Each Facility is defined by a pairing of Location and Organization.

In addition to the base requirements of mCSD Location, one type must be set to https://profiles.ihe.net/ITI/mCSD/CodeSystem/IHE.mCSD.Organization.Location.Types#facility.

mCSD Location for Jurisdictions

A profile on the mCSD Location for mCSD Jurisdictions.

Jurisdictions are political administrative units or other territories over which authority is exercised. A Jurisdiction has a unique identifier, geographic attributes, etc. Jurisdictions include political administrative units such as village districts or regions. Each Jurisdiction is defined by a pairing of Location and Organization.

In addition to the base requirements of mCSD Location, one type must be set to https://profiles.ihe.net/ITI/mCSD/CodeSystem/IHE.mCSD.Organization.Location.Types#jurisdiction.

mCSD Location with Distance

A profile on the mCSD Location resource for distance searches.

This profile is for when you want to allow distance based searches for an mCSD Location resource.

mCSD Organization

A profile on the Organization resource for mCSD.

Organizations are “umbrella” entities; these may be consideredthe administrative bodies under whose auspices care services are provided such as Healthcare Information Exchanges (HIEs), Integrated Delivery Networks (IDNs), Non-Government Organizations (NGOs), Faith-Based Organizations (FBOs) or even a one-physician family practice. An organization has a unique identifier and may have additional administrative attributes such as contact person, mailing address, etc. Departments of an institution, or other administrative units, may be represented as child Organizations of a parent Organization.

mCSD Organization Affiliation

A profile on the OrganizationAffiliation resource for mCSD.

An Organization may have relationships with other organizations that are not hierarchical. These relationships may indicate an electronic routing path to other organizations that cannot be reached directly. OrganizationAffiliation can be used to specify relationships such as supply chains or administrative reporting structures.

mCSD Organization Affiliation DocumentSharing

A profile on the OrganizationAffiliation resource for mCSD in Document Sharing. Karen’s Cross, when expanded to either/or a service that translates protocols, or a proxy that mediates network communication.

Not used for direct connected mesh networks of depth 2 as that is handled fine with Organization->Endpoint.

Affiliation is used to show Document Sharing network linkage to a set of communities that are not directly addressible.
The participating organization would not have Organization->Endpoint advertised in the network directory. There will be many OrganizationAffiliations, one for each pathway provided on the network by the serving organization (.organization) to another organization (.participatingOrganization).

mCSD Organization for Facilities

A profile on mCSD Organization for mCSD Facilities.

Facilities are physical care delivery sites such as hospitals, clinics, health outposts, physician offices, labs, pharmacies, etc. A Facility has a unique identifier, geographic attributes (address, geocode), contact attributes, attributes regarding its hours of operation, etc. Each Facility is defined by a pairing of Location and Organization.

In addition to the base requirements of mCSD Organization, one type must be set to https://profiles.ihe.net/ITI/mCSD/CodeSystem/IHE.mCSD.Organization.Location.Types#facility.

mCSD Organization for Jurisdictions

A profile on the mCSD Organization for mCSD Jurisdictions.

Jurisdictions are political administrative units or other territories over which authority is exercised. A Jurisdiction has a unique identifier, geographic attributes, etc. Jurisdictions include political administrative units such as village districts or regions. Each Jurisdiction is defined by a pairing of Location and Organization.

In addition to the base requirements of mCSD Organization, one type must be set to https://profiles.ihe.net/ITI/mCSD/CodeSystem/IHE.mCSD.Organization.Location.Types#jurisdiction.

mCSD Practitioner

A profile on the Practitioner resource for mCSD.

A Practitioner is a health worker such as defined by WHO; a Practitioner might be a physician, nurse, pharmacist, community health worker, district health manager, etc. Practitioners have contact and demographic attributes. Each Practitioner may be related to one or more Organizations, one or more Locations and one or more Healthcare Services through a Practitioner Role. Specific attributes may be associated with the Practitioner relationship with these other entities.

mCSD PractitionerRole

A profile on the PractitionerRole resource for mCSD.

A PractitionerRole links a Practitioner with a particular health care role to perform Healthcare Services at a particular Location for an Organization

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Endpoint Specific Type

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

Purpose of Use Extension

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

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

mCSD Endpoint Core Document Sharing Types ValueSet

ValueSet of the Core Document Sharing Endpoint types allowed

mCSD Endpoint Types ValueSet

ValueSet of the Endpoint types allowed

mCSD Organization Affiliation Types ValueSet

ValueSet of Organization Affiliation types allowed

mCSD Type codes for Endpoint.identifier

mCSD Type codes for specific business identifiers for Endpoint resources.

mCSD Type codes for Organization.identifier

mCSD Type codes for specific business identifiers for Organization resources.

mCSD Types for Organizations and Locations

mCSD Types for specialized Organization and Location resources.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

mCSD Endpoint Types

mCSD Endpoint types beyond those in the FHIR core.

The codes defined here are endpoint types defined in IHE profiles at the time of publication. Other codes might be defined in new IHE profiles written later, where they could define their own code and own codeSystem.

Code pattern: {Profile}-{Actor}-{Transaction}[-{option}]

  • Where Profile is the acronym
  • Where Actor name compressed to be short yet clear (camel case)
  • Where Transaction name is compressed to be short yet clear (camel case)
  • Where the code definition spells out these using the formal names and transaction number
  • Where an option is important it can be prepended

Note that this codeSystem contains only endpoints needed for Some IHE profiles, and only for the synchronous communication pattern. When Async is supported additional entries will be needed on these actors, and the peer actor will also need to be described. Async is not in scope at this time.

mCSD Example Hierarchy Code System

An example vocabulary of hierarchies.

mCSD Organization Affiliation Types

mCSD OrganizationAffiliation types beyond those in the FHIR core.

mCSD Type codes for Endpoint.identifier

mCSD Type codes for specific business identifiers for Endpoint resources.

mCSD Type codes for Organization.identifier

mCSD Type codes for specific business identifiers for Organization resources.

mCSD Type codes for Organizations and Locations

mCSD Type codes for specialized Organization and Location resources.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Audit example for ITI-130 for Data Source for batch/transaction updates.

Audit example for a Data Source submitting a batch/transaction on Care Services resources for ITI-130.

Audit example for ITI-130 for Data Source for create.

Audit example for a Data Source submitting a create on a Care Services resource for ITI-130.

Audit example for ITI-130 for Data Source for delete.

Audit example for a Data Source submitting a delete on a Care Services resource for ITI-130.

Audit example for ITI-130 for Data Source for update.

Audit example for a Data Source submitting an update on a Care Services resource for ITI-130.

Audit example for ITI-90 for Query Client for query.

Audit example for a Query Client requesting a query on a Care Services Resource for ITI-90.

Audit example for ITI-90 for Query Client for read.

Audit example for a Query Client requesting a read on a Care Services resource for ITI-90.

Audit example for ITI-91 for Update Client.

Audit example for a Update Client requesting updates on a Care Services Resource for ITI-91.

Device Example for mCSD

Device Example for mCSD.

Example Bundle of mCSD Resources

Example Bundle of Core mCSD Resources.

Example Organization A

Example Organization A that wants to communicate with Organization B

  • Note this Organization has no endpoint, but it is a client in this scenario
Example Organization B

Example Organization B that is not on the network directly

  • Note that this organization has no endpoint as it is not directly participating in the network
Example Organization C

Example Organization C supports communication with Organization B

  • Note that this organization hosts an XDS Query endpoint on the network.
  • More endponts would be here, but the use-case is simplified to just XDS Query
Example OrganizationAffiliation C

Example OrganizationAffiliation C that indicates that C will provide communication to B.

  • Note that the endpoint is listed here in addition to in ex-OrgC to be more efficient
Example Partner Organization

Example Organization for a Partner Organization

Example mCSD Facility Admin Organization Affiliation

Organization Affiliation resource for an example administrative relationship for a facility.

Example mCSD Facility Location

Location resource for an example mCSD Facility

Example mCSD Facility Organization

Organization resource for an example mCSD Facility

Example mCSD HealthcareService

HealthcareService resource example for mCSD.

Example mCSD Jurisdiction Location

Location resource for an example mCSD Jurisdiction

Example mCSD Jurisdiction Organization

Organization resource for an example mCSD Jurisdiction

Example mCSD Location

Location resource for an example of an mCSD Location (Ward)

Example mCSD Location with Distance Option

Location resource for an example of an mCSD Location with Distance Option

Example mCSD Practitioner

Practitioner resource example for mCSD.

Example mCSD PractitionerRole

PractitionerRole resource example for mCSD.

Example of an Endpoint that is not constrained by mCSD XCA constraints.

This is an example of a DICOM WADO-RS endpoint.

Example of an OrganizationAffiliation in mCSD.

This is a simple OrganizationAffiliation for an HIE. This is NOT representative of a Document Sharing affiliation.

Example of an mCSD XCA Query Endpoint

This is an example of an XCA Retrieve endpoint for OrgA

  • supports XPHR and IPS
  • supports mime-type for FHIR, CDA, and PDF
Example of an mCSD XCA Retrieve Endpoint

This is an example of an XCA Retrieve endpoint

  • supports XPHR and IPS
  • supports mime-type for FHIR, CDA, and PDF