Mobile Care Services Discovery (mCSD)
3.3.1 - ci-build

Mobile Care Services Discovery (mCSD) - Local Development build (v3.3.1). See the Directory of published versions

2:3.90 Find Matching Care Services [ITI-90]

2:3.90.1 Scope

The Find Matching Care Services transaction returns a list of matching care services resources based on the query sent. A Care Services Selective Consumer initiates a Find Matching Care Services transaction against a Care Services Selective Supplier.

2:3.90.2 Actor Roles

Actor Role
Care Services Selective Consumer Requests a list of resources from the Care Services Selective Supplier based on query parameters
Care Services Selective Supplier Accepts the query request and returns a list of matching resources.

2:3.90.3 Referenced Standards

2:3.90.4 Messages

Care Services Selective ConsumerCare Services Selective Supplier1. Find Matching Care Services Request [ITI-90]2. Find Matching Care Services Response [ITI-90]


Figure 2:3.90.4-1: Interaction Diagram

2:3.90.4.1 Find Matching Care Services Request Message

The Find Matching Care Services message is a FHIR search operation on the Organization, Location, Practitioner, PractitionerRole, and/or HealthcareService Resources.

2:3.90.4.1.1 Trigger Events

A Care Services Selective Consumer triggers a Find Matching Care Services Request to a Care Services Selective Supplier according to the business rules for the query. These business rules are outside the scope of this transaction.

2:3.90.4.1.2 Message Semantics

A Care Services Selective Consumer initiates a search request using HTTP GET as defined at http://hl7.org/fhir/R4/http.html#search on the Organization, Location, Practitioner, PractitionerRole, or HealthcareService Resources. The query parameters are identified below. A Care Services Selective Consumer may query any combination or subset of the parameters.

A Care Services Selective Supplier shall support combinations of search parameters as defined at http://hl7.org/fhir/R4/search.html#combining, “Composite Search Parameters.”

A Care Services Selective Supplier shall support responding to a request for both the JSON and the XML messaging formats as defined in FHIR. A Care Services Selective Consumer shall accept either the JSON or the XML messaging formats as defined in FHIR. See ITI TF-2: Z.6 for more details.

A Care Services Selective Supplier shall implement the parameters described below. A Care Services Selective Supplier may choose to support additional query parameters beyond the subset listed below. Any additional query parameters supported shall be supported according to the core FHIR specification.

See ITI TF-2: Appendix W for informative implementation material for this transaction.

2:3.90.4.1.2.1 Common Parameters

The Care Services Selective Supplier shall support the :contains and :exact modifiers in all of the string query parameters below.

The Care Services Selective Supplier shall support the following search parameters as defined at http://hl7.org/fhir/R4/search.html#all.

_id
_lastUpdated

The Care Services Selective Supplier shall also support the following prefixes for the _lastUpdated parameter: gt, lt, ge, le, sa, and eb.

2:3.90.4.1.2.2 Organization Resource Message Semantics

The Care Services Selective Supplier shall support the following search parameters on the Organization Resource as defined at http://hl7.org/fhir/R4/organization.html#search. String parameter modifiers are defined at http://hl7.org/fhir/R4/search.html#string. The ihe-mcsd-hierarchy-type search parameter and ihe-mcsd-hierarchy-partof search parameter query the hierarchy extension identified by the following canonical URI http://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.OrganizationHierarchy.

active
identifier
name
partof
partof:above
partof:below
type
partof.identifier
partof.name
_revInclude=Location:organization
ihe-mcsd-hierarchy-type
ihe-mcsd-hierarchy-partof
ihe-mcsd-hierarchy-partof:above
ihe-mcsd-hierarchy-partof:below
2:3.90.4.1.2.3 Location Resource Message Semantics

The Care Services Selective Supplier shall support the following search parameters on the Location Resource as defined at http://hl7.org/fhir/R4/location.html#search. String parameter modifiers are defined at http://hl7.org/fhir/R4/search.html#string.

identifier
name
organization
partof
partof:above
partof:below
status
type
partof.identifier
partof.name
organization.active
organization.identifier
organization.name
_include=Location:organization
2:3.90.4.1.2.4 Practitioner Resource Message Semantics

The Care Services Selective Supplier shall support the following search parameters on the Practitioner Resource as defined at http://hl7.org/fhir/R4/practitioner.html#search. String parameter modifiers are defined at http://hl7.org/fhir/R4/search.html#string.

active
identifier
name
given
family
2:3.90.4.1.2.5 PractitionerRole Resource Message Semantics

The Care Services Selective Supplier shall support the following search parameters on the PractitionerRole Resource as defined at http://hl7.org/fhir/R4/practitionerrole.html#search.

active
location
organization
practitioner
role
service
specialty
practitioner.identifier
practitioner.name
practitioner.given
practitioner.family
_include=PractitionerRole:practitioner
organization.active
organization.identifier
organization.name
location.status
location.identifier
location.name
service.active
service.indentifier
service.location
service.name
service.organization
2:3.90.4.1.2.6 HealthcareService Resource Message Semantics

The Care Services Selective Supplier shall support the following search parameters on the HealthcareService Resource as defined at http://hl7.org/fhir/R4/healthcareservice.html#search. String parameter modifiers are defined at http://hl7.org/fhir/R4/search.html#string.

active
identifier
location
name
organization
service-type
organization.active
organization.identifier
organization.name
location.status
location.identifier
location.name
2:3.90.4.1.2.7 Location Distance Option Message Semantics

The Care Services Selective Supplier supporting the Location Distance Option shall support the following search parameters on the Location Resource as defined at http://hl7.org/fhir/R4/location.html#search.

near
2:3.90.4.1.3 Expected Actions

The Care Services Selective Supplier shall process the query to discover the resources that match the search parameters given, and return a response as per Section 2:3.90.4.2 or an error as per http://hl7.org/fhir/R4/search.html#errors.

2:3.90.4.2 Find Matching Care Services Response Message

2:3.90.4.2.1 Trigger Events

The Care Services Selective Supplier sends the Find Matching Care Services Response to the Care Services Selective Consumer when results to the query are ready.

2:3.90.4.2.2 Message Semantics

The Care Services Selective Supplier shall support the search response message as defined at http://hl7.org/fhir/R4/http.html#search on the following Resources.

All References (reference.reference element) to Resources defined in this transaction shall be populated with an accessible URL (see https://www.hl7.org/fhir/references-definitions.html#Reference.reference), unless the referenced resource is not present on a server accessible to the client.

2:3.90.4.2.2.1 FHIR Organization Resource Constraints

A Care Services Selective Consumer may query on Organization Resources. A Care Services Selective Supplier shall return a Bundle of matching Organization Resources. The Organization Resource shall be further constrained as described in Table 2:3.90.4.2.2.1-1 and in the Organization Profile for mCSD. The Element column in Table 2:3.90.4.2.2.1-1 references the object model defined at http://hl7.org/fhir/R4/organization.html#resource.

Table 2:3.90.4.2.2.1-1: Organization Resource Constraints

Element & Cardinality Data Type
type
[1..*]
A code that describes the type of Organization.
CodeableConcept
name
[1..1]
string
partOf
[0..1]
If the Organization belongs to a single hierarchy, the partOf element shall be used.
Reference (Organization)
extension
[0..*]
If there are additional hierarchies (such as funding source), include them in the extension with the following details:
Set the url to the canonical URI for this extension
url = "http://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.OrganizationHierarchy"
Set the sub-extension values
hierarchy-type = valueCodeableConcept
part-of = valueReference(Organization)

A Care Services Selective Consumer may query on Organization Resources when working with Facilities. A Care Services Selective Supplier shall return a Bundle of matching Organization Resources when working with Facilities. In addition to the constraints in Table 2:3.90.4.2.2.1-1, the FHIR Organization Resource shall be further constrained as described in Table 2:3.90.4.2.2.1-2 and in the Organization for Facilities Profile for mCSD. The Element column in Table 2:3.90.4.2.2.1-2 references the object model defined at http://hl7.org/fhir/R4/organization.html#resource.

Table 2:3.90.4.2.2.1-2: Additional Organization Resource Constraints for Facilities

Element & Cardinality Data Type
type
[2..*]
In addition, there shall be one type with the following value:
system = "urn:ietf:rfc:3986"
code = "urn:ihe:iti:mcsd:2019:facility"

A Care Services Selective Consumer may query on Organization Resources when working with Jurisdictions. A Care Services Selective Supplier shall return a Bundle of matching Organization Resources when working with Jurisdictions. In addition to the constraints in Table 3.90.4.2.2.1-1, the FHIR Organization Resource shall be further constrained as described in Table 3.90.4.2.2.1-3 and in the Organization for Jurisdictions Profile for mCSD. The Element column in Table 3.90.4.2.2.1-3 references the object model defined at http://hl7.org/fhir/R4/organization.html#resource.

Table 2:3.90.4.2.2.1-3: Additional Organization Resource Constraints for Jurisdictions

Element & Cardinality Data Type
type
[2..*]
In addition, there shall be one type with the following value:
system = "urn:ietf:rfc:3986"
code = "urn:ihe:iti:mcsd:2019:jurisdiction"
2:3.90.4.2.2.2 FHIR Location Resource Constraints

A Care Services Selective Consumer may query on Location Resources. A Care Services Selective Supplier shall return a Bundle of matching Location Resources. The Location Resource shall be further constrained as described in Table 2:3.90.4.2.2.2-1 and in the Location Profile for mCSD. The Element column in Table 2:3.90.4.2.2.2-1 references the object model defined at http://hl7.org/fhir/R4/location.html#resource.

Table 2:3.90.4.2.2.2-1: Location Resource Constraints

Element & Cardinality Data Type
type
[1..*]
A code that describes the type of Location.
CodeableConcept
physicalType
[1..1]
A code that describes the physical type of Location.
CodeableConcept
name
[1..1]
string
status
[1..1]
code (active| suspended| inactive)

When the resource is a Facility, the Location Resource shall be paired with an Organization Resource using the managingOrganization element in Location. A Care Services Selective Consumer may query on Location Resources when working with Facilities. A Care Services Selective Supplier shall return a Bundle of matching Location Resources when working with Facilities. In addition to the constraints in Table 2:3.90.4.2.2.2-1, the FHIR Location Resource shall be further constrained as described in Table 2:3.90.4.2.2.2-2 and in the Location for Facilities Profile for mCSD. The Element column in Table 2:3.90.4.2.2.2-2 references the object model defined at http://hl7.org/fhir/R4/location.html#resource.

Table 2:3.90.4.2.2.2-2: Additional Location Resource Constraints for Facilities

Element & Cardinality Data Type
type
[2..*]
In addition, there shall be one type with the following value:
system = "urn:ietf:rfc:3986"
code = "urn:ihe:iti:mcsd:2019:facility"
managingOrganization
[1..1]
The reference to the Organization resource for this facility.
Reference(Organization)

When the resource is a Jurisdiction, the Location Resource shall be paired with an Organization Resource using the managingOrganization element in Location. A Care Services Selective Consumer may query on Location Resources when working with Jurisdictions. A Care Services Selective Supplier shall return a Bundle of matching Location Resources when working with Jurisdictions. In addition to the constraints in Table 3.90.4.2.2.2-1, the FHIR Location Resource shall be further constrained as described in Table 3.90.4.2.2.2-3 and in the Location for Jurisdictions Profile for mCSD. The Element column in Table 3.90.4.2.2.2-3 references the object model defined at http://hl7.org/fhir/R4/location.html#resource.

When a geographic boundary is available for the Jurisdiction Location, the location-boundary-geojson extension defined at http://hl7.org/fhir/extension-location-boundary-geojson.html shall be used to store this information.

Table 2:3.90.4.2.2.2-3: Additional Location Resource Constraints for Jurisdictions

Element & Cardinality Data Type
extension
[0..1]
When a boundary is available, the location-boundary-geojson extension should be used with the given url, contentType, and data:
url = http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
valueAttachment.contentType = "application/geo+json"
valueAttachment.data = base64 encoded GeoJSON boundary data
type
[2..*]
In addition, there shall be one type with the following value:
system = "urn:ietf:rfc:3986"
code = "urn:ihe:iti:mcsd:2019:jurisdiction"
managingOrganization
[1..1]
The reference to the Organization resource for this jurisdiction.
Reference(Organization)

When supporting the Location Distance Option. The Location Resource shall be further constrained as described in Table 2:3.90.4.2.2.2-4 and in the Location with Distance Option Profile for mCSD. The Element column in Table 2:3.90.4.2.2.2-4 references the object model defined at http://hl7.org/fhir/R4/location.html#resource.

Table 2:3.90.4.2.2.2-4: Location Resource Constraints with Location Distance Option

Element & Cardinality Data Type
position
[1..1]
BackboneElement
2:3.90.4.2.2.3 FHIR Practitioner Resource Constraints

A Care Services Selective Consumer may query on Practitioner Resources. A Care Services Selective Supplier shall return a Bundle of matching Practitioner Resources. The Practitioner Resource shall be further constrained as described in Table 2:3.90.4.2.2.3-1 and in the Practitioner Profile for mCSD. The Element column in Table 2:3.90.4.2.2.3-1 references the object model defined at http://hl7.org/fhir/R4/practitioner.html#resource.

Table 2:3.90.4.2.2.3-1: Practitioner Resource Constraints

Element & Cardinality Data Type
name
[1..*]
HumanName
2:3.90.4.2.2.4 FHIR PractitionerRole Resource Constraints

A Care Services Selective Consumer may query on PractitionerRole Resources. A Care Services Selective Supplier shall return a Bundle of matching PractitionerRole Resources. The PractitionerRole Resource shall be further constrained as described in Table 2:3.90.4.2.2.4-1 and in the PractitionerRole Profile for mCSD. The Element column in Table 2:3.90.4.2.2.4-1 references the object model defined at http://hl7.org/fhir/R4/practitionerrole.html#resource.

Table 2:3.90.4.2.2.4-1: PractitionerRole Resource Constraints

Element & Cardinality Data Type
code
[1..*]
CodeableConcept
2:3.90.4.2.2.5 FHIR HealthcareService Resource Constraints

A Care Services Selective Consumer may query on HealthcareService Resources. A Care Services Selective Supplier shall return a Bundle of matching HealthcareService Resources. The HealthcareService Resource shall be further constrained as described in Table 2:3.90.4.2.2.5-1 and in the HealthcareService Profile for mCSD. The Element column in Table 2:3.90.4.2.2.5-1 references the object model defined at http://hl7.org/fhir/R4/healthcareservice.html#resource.

Table 2:3.90.4.2.2.5-1: HealthcareService Resource Constraints

Element & Cardinality Data Type
type
[1..*] | CodeableConcept`
 
name
[1..1]
string
2:3.90.4.2.3 Expected Actions

The Care Services Selective Consumer has received the response and continues with its workflow.

2:3.90.5 Security Considerations

See ITI TF-1: 46.5 for security considerations for the mCSD Profile.

See ITI TF-2: Appendix Z.8 for common mobile security considerations.