DFT Ballot - This specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions
CA:FeX CapabilityStatement - Data Responder - Option C (Single Resource Option)
REST Capabilities Server
Mode | Server |
---|---|
Documentation | The Data Responder supports responding to single-resource queries from Data Consumers in the CA:FeX Single Resource Option model. |
Security
Description |
|
---|
Resource Interactions
Resource Type | Supported Profiles | SearchType | Read | Vread |
---|---|---|---|---|
Patient | SHALL | SHALL | MAY | |
Practitioner | SHALL | SHALL | MAY | |
PractitionerRole | SHALL | SHALL | MAY | |
AllergyIntolerance | SHALL | SHALL | MAY | |
Condition | SHALL | SHALL | MAY | |
DiagnosticReport | SHALL | SHALL | MAY | |
Immunization | SHALL | SHALL | MAY | |
Medication | MAY | SHALL | MAY | |
MedicationRequest | SHALL | SHALL | MAY | |
MedicationStatement | SHALL | SHALL | MAY | |
Observation | SHALL | SHALL | MAY | |
Procedure | SHALL | SHALL | MAY | |
Provenance | MAY | SHALL | MAY |
Search Parameters per resource type
Patient
Name | Type | Documentation | Level |
---|---|---|---|
_id | token | SHALL | |
birthdate | date | A client SHALL provide a value precise to the day. | MAY |
name | string | A server SHALL support the :exact modifier on string parameters. | SHOULD |
family | string | A server SHALL support the :exact modifier on string parameters. | SHOULD |
given | string | A server SHALL support the :exact modifier on string parameters. | SHOULD |
gender | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHALL |
Supported Reverse Includes:
- Provenance:target
Practitioner
Name | Type | Documentation | Level |
---|---|---|---|
_id | token | SHOULD | |
name | string | A server SHALL support the :exact modifier on string parameters. | SHALL |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHALL |
PractitionerRole
Name | Type | Documentation | Level |
---|---|---|---|
specialty | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHALL |
practitioner | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
Supported Includes:
- PractitionerRole:endpoint
- PractitionerRole:practitioner
AllergyIntolerance
Name | Type | Documentation | Level |
---|---|---|---|
clinical-status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Reverse Includes:
- Provenance:target
Condition
Name | Type | Documentation | Level |
---|---|---|---|
category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
clinical-status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
patient | reference | The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
onset-date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Reverse Includes:
- Provenance:target
DiagnosticReport
Name | Type | Documentation | Level |
---|---|---|---|
status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Reverse Includes:
- Provenance:target
Immunization
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Reverse Includes:
- Provenance:target
Medication
No search parameters are stated for this resource type
MedicationRequest
Name | Type | Documentation | Level |
---|---|---|---|
status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
intent | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
authoredon | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Includes:
- MedicationRequest:medication
Supported Reverse Includes:
- Provenance:target
MedicationStatement
Name | Type | Documentation | Level |
---|---|---|---|
patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Includes:
- MedicationStatement:medication
Supported Reverse Includes:
- Provenance:target
Observation
Name | Type | Documentation | Level |
---|---|---|---|
status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Reverse Includes:
- Provenance:target
Procedure
Name | Type | Documentation | Level |
---|---|---|---|
status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHOULD |
Supported Reverse Includes:
- Provenance:target
Provenance
No search parameters are stated for this resource type
CapabilityStatement |
id : CaFeX-DataResponder-Option-C |
url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/cafex-DataResponder-OptionC |
version : 2.2.0 |
name : cafex_DataResponder_Option_C |
title : CA:FeX CapabilityStatement - Data Responder - Option C (Single Resource Option) |
status : draft |
experimental : False |
date : 2025-04-03 |
publisher : Canada Health Infoway |
contact |
name : National Standards Release Centre |
telecom |
system : url |
value : http://www.infoway-inforoute.ca |
telecom |
system : email |
value : standards@infoway-inforoute.ca |
description : Describes the capabilities of a Data Responder supporting Option C (Single Resource Option) for the CA:FeX specification. This actor provides single-resource queries (e.g., Immunization, Medication, AllergyIntolerance, Condition) to Data Consumers. |
jurisdiction |
coding |
system : urn:iso:std:iso:3166 |
code : CA |
copyright : Copyright © 2021–2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy). |
kind : requirements |
fhirVersion : 4.0.1 |
format : json |
format : xml |
rest |
mode : server |
documentation : The Data Responder supports responding to single-resource queries from Data Consumers in the CA:FeX Single Resource Option model. |
security |
description : 1. See the security section of the CA:FeX guide for security requirements and recommendations. 2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` "Unauthorized", `HTTP 403` "Forbidden", or `HTTP 404` "Not Found" |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : birthdate |
extension |
url : required |
value : family |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : birthdate |
extension |
url : required |
value : name |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : family |
extension |
url : required |
value : gender |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : gender |
extension |
url : required |
value : name |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : Patient |
documentation : Supports lookups and retrieval of the Patient resource in the single resource exchange option. |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : _id |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id |
type : token |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : birthdate |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate |
type : date |
documentation : A client **SHALL** provide a value precise to the *day*. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : name |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-name |
type : string |
documentation : A server **SHALL** support the :exact modifier on string parameters. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : family |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-family |
type : string |
documentation : A server **SHALL** support the :exact modifier on string parameters. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : given |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-given |
type : string |
documentation : A server **SHALL** support the :exact modifier on string parameters. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : gender |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
type : Practitioner |
documentation : Supports lookups and retrieval of the Practitioner resource in the single resource exchange option. |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : _id |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-id |
type : token |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : name |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-practitioner-name |
type : string |
documentation : A server **SHALL** support the :exact modifier on string parameters. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : identifier |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
type : PractitionerRole |
documentation : Supports PractitionerRole for identifying roles, specialties, and links to endpoints. |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchInclude : PractitionerRole:endpoint |
searchInclude : PractitionerRole:practitioner |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : specialty |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : practitioner |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : clinical-status |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : AllergyIntolerance |
documentation : Supports lookups and retrieval of the AllergyIntolerance resource in the single resource exchange option. |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : clinical-status |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : code |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : category |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : onset-date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : clinical-status |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : Condition |
documentation : Supports lookups and retrieval of the Condition resource in the single resource exchange option |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : category |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : clinical-status |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : onset-date |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date |
type : date |
documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : code |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
url : required |
value : patient |
extension |
url : required |
value : category |
extension |
url : required |
value : date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : status |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
url : required |
value : patient |
extension |
url : required |
value : code |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : code |
extension |
url : required |
value : date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
url : required |
value : patient |
extension |
url : required |
value : category |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : DiagnosticReport |
documentation : Supports lookups and retrieval of the DiagnosticReport resource in the single resource exchange option |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : status |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : category |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : code |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : date |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date |
type : date |
documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : status |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : Immunization |
documentation : Supports lookups and retrieval of the Immunization resource in the single resource exchange option |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : status |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : date |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date |
type : date |
documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
type : Medication |
documentation : Supports retrieval of referenced Medication resources for CA:FeX Option C. |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : intent |
extension |
url : required |
value : status |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : intent |
extension |
url : required |
value : authoredon |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : intent |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : MedicationRequest |
documentation : Supports lookups and retrieval of the MedicationRequest resource in the single resource exchange option |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchInclude : MedicationRequest:medication |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : status |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : intent |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : authoredon |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon |
type : date |
documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
type : MedicationStatement |
documentation : Supports lookups and retrieval of the MedicationStatement resource in the single resource exchange option |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchInclude : MedicationStatement:medication |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
url : required |
value : patient |
extension |
url : required |
value : category |
extension |
url : required |
value : date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
url : required |
value : patient |
extension |
url : required |
value : code |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : code |
extension |
url : required |
value : date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
url : required |
value : patient |
extension |
url : required |
value : category |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
url : required |
value : patient |
extension |
url : required |
value : category |
extension |
url : required |
value : status |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : Observation |
documentation : Supports lookups and retrieval of the Observation resource in the single resource exchange option |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : status |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : category |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : code |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : date |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date |
type : date |
documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
extension |
url : required |
value : patient |
extension |
url : required |
value : code |
extension |
url : required |
value : date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
extension |
url : required |
value : patient |
extension |
url : required |
value : status |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
extension |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
extension |
url : required |
value : patient |
extension |
url : required |
value : date |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
type : Procedure |
documentation : Supports lookups and retrieval of the Procedure resource in the single resource exchange option |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |
searchRevInclude : Provenance:target |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : status |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
name : patient |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
type : reference |
documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : date |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date |
type : date |
documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
name : code |
definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
searchParam |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
name : identifier |
definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
type : token |
documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
resource |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHOULD |
type : Provenance |
documentation : Supports Provenance read and optional search for CA:FeX Option C. |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : search-type |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : SHALL |
code : read |
interaction |
extension |
url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
value : MAY |
code : vread |
referencePolicy : resolves |