{
"description": "This Section describes the expected capabilities of the US Core Client which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined in the [Conformance Requirements for Server](CapabilityStatement-us-core-server.html). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.",
"_filename": "CapabilityStatement-us-core-client.json",
"package_name": "hl7.fhir.us.core",
"format": [ "xml", "json" ],
"date": "2020-11-20",
"publisher": "HL7 International - US Realm Steering Committee",
"patchFormat": [ "application/json-patch+json" ],
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "UsCoreClientCapabilityStatement",
"copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
"type": null,
"experimental": "false",
"resourceType": "CapabilityStatement",
"title": "US Core Client CapabilityStatement",
"package_version": "3.2.0",
"status": "active",
"id": "34013802-ba48-4f7a-aa01-87079362a187",
"kind": "requirements",
"implementationGuide": [ "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.2.1" ],
"url": "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client",
"version": "3.2.0",
"contact": [ {
"name": "HL7 International - US Realm Steering Committee",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/usrealm/index.cfm",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "client",
"resource": [ {
"type": "AllergyIntolerance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "clinical-status"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance" ]
}, {
"type": "CarePlan",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
}, {
"url": "required",
"valueString": "status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
}, {
"url": "required",
"valueString": "date"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
}, {
"url": "required",
"valueString": "status"
}, {
"url": "required",
"valueString": "date"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date",
"documentation": "TheThe *second + time offset*."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-status",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"documentation": "* Additional considerations for systems aligning with [HL7 Consolidated (C-CDA)](http://www.hl7.org/implement/standards/product_brief.cfm?product_id=492) Care Plan requirements:\n - US Core Goal **SHOULD** be present in CarePlan.goal\n - US Core Condition **SHOULD** be present in CarePlan.addresses\n - Assement and Plan **MAY** be included as narrative text",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan" ]
}, {
"type": "CareTeam",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "status"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam" ]
}, {
"type": "Condition",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "code"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "clinical-status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "onset-date"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "onset-date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date",
"documentation": "TheThe *second + time offset*."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ]
}, {
"type": "Device",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "type"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-type",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"documentation": "* Implantable medical devices that have UDI information **SHALL** represent this information in either `carrierAIDC` or `carrierHRF`.\n - UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants.\n - Servers are not required to support both `carrierAIDC` and `carrierHR`.\n* For Implantable medical devices that have UDI information, at least one of the Production Identifiers (UDI-PI) **SHALL** be present.\n* Servers **SHOULD** support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices. \n* In the [Quick Start] section below, searching for all devices is described. Records of implanted devices **MAY** be queried against UDI data including:\n\n - UDI HRF string (`udi-carrier`)\n - UDI Device Identifier (`udi-di`)\n - Manufacturer (`manufacturer`)\n - Model number (`model`)\n\n* Implementers **MAY** also adopt custom SearchParameters for searching by:\n\n - lot numbers\n - serial number\n - expiration date\n - manufacture date\n - distinct identifier",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device" ]
}, {
"type": "DiagnosticReport",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "code"
}, {
"url": "required",
"valueString": "date"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "code"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
}, {
"url": "required",
"valueString": "date"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "This conformance expectation applies **only** to the *US Core DiagnosticReport Profile for Report and Note exchange* profile. The conformance expectation for the *US Core DiagnosticReport Profile for Laboratory Results Reporting* is **MAY**."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date",
"documentation": "TheThe *second + time offset*."
} ],
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note" ]
}, {
"type": "DocumentReference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "type"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "type"
}, {
"url": "required",
"valueString": "period"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
}, {
"url": "required",
"valueString": "date"
} ]
} ],
"operation": [ {
"name": "docref",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref",
"documentation": "A client **SHOULD** be capable of transacting a $docref operation and capable of receiving at least a reference to a generated CCD document, and **MAY** be able to receive other document types, if available. **SHOULD** be capable of receiving documents as included resources in response to the operation.\n\n`GET [base]/DocumentReference/$docref?patient=[id]`"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date",
"documentation": "TheThe *second + time offset*."
}, {
"name": "period",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period",
"documentation": "TheThe *second + time offset*."
} ],
"documentation": "The DocumentReference.type binding SHALL support at a minimum the [5 Common Clinical Notes](ValueSet-us-core-clinical-note-type.html) and may extend to the full US Core DocumentReference Type Value Set",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ]
}, {
"type": "Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "date"
}, {
"url": "required",
"valueString": "patient"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "class"
}, {
"url": "required",
"valueString": "patient"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "type"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id"
}, {
"name": "class",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-class",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date",
"documentation": "TheThe *second + time offset*."
}, {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-type",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"documentation": "* The Encounter resource can represent a reason using either a code with `Encounter.reasonCode`, or a reference with `Encounter.reasonReference` to Condition or other resource.\n * Although both are marked as must support, the server systems are not required to support both a code and a reference, but they **SHALL** support *at least one* of these elements.\n * The client application **SHALL** support both elements.\n * if `Encounter.reasonReference` references an Observation, it **SHOULD** conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)\n* The intent of this profile is to support *where the encounter occurred*. The location address can be represented by either by the Location referenced by `Encounter.location.location` or indirectly through the Organization referenced by `Encounter.serviceProvider`.\n * Although both are marked as must support, the server systems are not required to support both `Encounter.location.location` and `Encounter.serviceProvider`, but they **SHALL** support *at least one* of these elements.\n * The client application **SHALL** support both elements.\n * if using `Encounter.locatison.location` it **SHOULD** conform to US Core Location. However, as a result of implementation feedback, it **MAY** reference the base FHIR Location resource. See this guidance on [Referencing US Core Profiles]",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ]
}, {
"type": "Goal",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "target-date"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "lifecycle-status"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "lifecycle-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-lifecycle-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "target-date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date",
"documentation": "TheThe *second + time offset*."
} ],
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ]
}, {
"type": "Immunization",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "date"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "status"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date",
"documentation": "TheThe *second + time offset*."
} ],
"documentation": "* Based upon the ONC U.S. Core Data for Interoperability (USCDI) v1 requirements, CVX vaccine codes are required and the NDC vaccine codes **SHOULD** be supported as translations to them.",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization" ]
}, {
"type": "Location",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-name"
}, {
"name": "address",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address"
}, {
"name": "address-city",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-city"
}, {
"name": "address-state",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-state"
}, {
"name": "address-postalcode",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-postalcode"
} ],
"documentation": "* The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they **SHOULD** be used as the default profile if referenced by another US Core profile.",
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location" ]
}, {
"type": "Medication",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"documentation": "* The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ **SHALL** be supported.",
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication" ]
}, {
"type": "MedicationRequest",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "intent"
}, {
"url": "required",
"valueString": "encounter"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "intent"
}, {
"url": "required",
"valueString": "authoredon"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "intent"
}, {
"url": "required",
"valueString": "status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "intent"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "intent",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "encounter",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "authoredon",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon",
"documentation": "TheThe *second + time offset*."
} ],
"documentation": "* The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.\n\n For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n\n `GET /MedicationRequest?patient=[id]`\n\n `GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`\n\n* The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in `MedicationRequest.reportedBoolean`, or a reference using `MedicationRequest.reportedReference` to Practitioner or other resource.\n * Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but **SHALL** choose to support at least one of these elements.\n * The client application **SHALL** support both elements.",
"searchInclude": [ "MedicationRequest:medication" ],
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest" ]
}, {
"type": "Observation",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
}, {
"url": "required",
"valueString": "status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "code"
}, {
"url": "required",
"valueString": "date"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "code"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
}, {
"url": "required",
"valueString": "date"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date",
"documentation": "TheThe *second + time offset*."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"documentation": "* Systems **SHOULD** support `Observation.effectivePeriod` to accurately represent laboratory tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).\n* An Observation without a value, **SHALL** include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it.",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age", "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus" ]
}, {
"type": "Organization",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-name"
}, {
"name": "address",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-address"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization" ]
}, {
"type": "Patient",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "family"
}, {
"url": "required",
"valueString": "gender"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "birthdate"
}, {
"url": "required",
"valueString": "name"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "gender"
}, {
"url": "required",
"valueString": "name"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "birthdate"
}, {
"url": "required",
"valueString": "family"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id"
}, {
"name": "birthdate",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
"documentation": "The *day*."
}, {
"name": "family",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
"documentation": "The *day*."
}, {
"name": "gender",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "given",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given"
}, {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name"
} ],
"documentation": "* For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.\n\n1. contact detail (e.g. a telephone number or an email address)\n1. a communication language\n1. a race\n1. an ethnicity\n1. a birth sex*\n1. previous name\n - Previous name is represented by providing an end date in the `Patient.name.period` element for a previous name.\n1. suffix\n - Suffix is represented using the `Patient.name.suffix` element.\n\n",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ]
}, {
"type": "Practitioner",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-name"
}, {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner" ]
}, {
"type": "PractitionerRole",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "specialty",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "practitioner",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"documentation": "* The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they **SHOULD** be used as the default profile if referenced by another US Core profile.",
"searchInclude": [ "PractitionerRole:endpoint", "PractitionerRole:practitioner" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole" ]
}, {
"type": "Procedure",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "status"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "code"
}, {
"url": "required",
"valueString": "date"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "date"
} ]
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"searchParam": [ {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient",
"documentation": "TheTheThe server **SHALL** support both."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date",
"documentation": "TheThe *second + time offset*."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code",
"documentation": "TheTheThe server **SHALL** support both."
} ],
"documentation": "* A procedure including an implantable device **SHOULD** use `Procedure.focalDevice` with a reference to the [US Core Implantable Device Profile].",
"searchRevInclude": [ "Provenance:target" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure" ]
}, {
"type": "Provenance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"code": "vread",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "patch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "delete",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"code": "history-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"documentation": "* If a system receives a provider in `Provenance.agent.who` as free text they must capture who sent them the information as the organization. On request they **SHALL** provide this organization as the source and **MAY** include the free text provider.\n* Systems that need to know the activity has occurred **SHOULD** populate the activity.",
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance" ]
}, {
"type": "ValueSet",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"operation": [ {
"name": "expand",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"documentation": "A client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions."
} ]
} ],
"security": {
"description": "1. See the [General Security Considerations] section for requirements and recommendations."
},
"interaction": [ {
"code": "transaction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "batch",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "search-system",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
}, {
"code": "history-system",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ]
} ],
"documentation": "The US Core Client **SHALL**:\n\n1. Support fetching and querying of one or more US Core profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement.\n"
} ]
}