{
"description": "This Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and and the latest proposed ONC [U.S. Core Data for Interoperability (USCDI)]. 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-server.json",
"package_name": "hl7.fhir.us.core",
"format": [ "xml", "json" ],
"date": "2019-05-28T00:00:00-04:00",
"publisher": "HL7 International - US Realm Steering Committee",
"patchFormat": [ "application/json-patch+json" ],
"fhirVersion": "4.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "UsCoreServerCapabilityStatement",
"type": null,
"experimental": "false",
"resourceType": "CapabilityStatement",
"title": " Server CapabilityStatement",
"package_version": "3.0.0",
"status": "active",
"id": "3d050037-f90f-487f-88f6-77ebbbd9d143",
"kind": "requirements",
"implementationGuide": [ "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core.r4-4.0.0" ],
"url": "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server",
"version": "3.0.0",
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/usrealm/index.cfm",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "AllergyIntolerance",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance" ]
}, {
"type": "CarePlan",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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"
} ]
}, {
"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": "SHALL"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
} ]
} ],
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-status"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan" ]
}, {
"type": "CareTeam",
"profile": "http://hl7.org/fhir/StructureDefinition/CareTeam",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam" ]
}, {
"type": "Condition",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category"
}, {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient"
}, {
"name": "onset-date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date"
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ]
}, {
"type": "Device",
"profile": "http://hl7.org/fhir/StructureDefinition/Device",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient"
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-type"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-device" ]
}, {
"type": "DiagnosticReport",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "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": "SHALL"
}, {
"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": "date"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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"
} ]
} ],
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient"
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category"
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab" ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient"
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category"
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date"
}, {
"name": "period",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period"
} ],
"operation": [ {
"name": "docref",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref",
"documentation": "A server **SHALL** be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. **MAY** provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server **SHALL** provide references to last or current encounter. **SHOULD** document what resources, if any, are returned as included resources\n\n`GET [base]/DocumentReference/$docref?patient=[id]`"
} ],
"referencePolicy": [ "resolves" ],
"type": "DocumentReference",
"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"
} ]
} ],
"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",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "SHALL"
}, {
"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": "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": "SHALL"
}, {
"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"
} ]
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ],
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}, {
"type": "Encounter",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "type"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "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": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-class"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date"
}, {
"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"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status"
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-type"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ]
}, {
"type": "Goal",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-lifecycle-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient"
}, {
"name": "target-date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ]
}, {
"type": "Immunization",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "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": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization" ]
}, {
"type": "Location",
"profile": "http://hl7.org/fhir/StructureDefinition/Location",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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": "SHALL"
} ],
"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": "SHALL"
} ],
"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"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location" ]
}, {
"type": "Medication",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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"
} ]
} ],
"documentation": "The MedicationStatement and MedicationRequest resources can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationStatement or a MedicationRequest, then the READ and SEARCH Criteria **SHALL** be supported.",
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication" ]
}, {
"searchParam": [ {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient"
}, {
"name": "authoredon",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon"
} ],
"referencePolicy": [ "resolves" ],
"type": "MedicationRequest",
"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"
} ]
} ],
"documentation": "The MedicationStatement 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 /MedicationStatement?patient=[id]`\n\n `GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication`",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "authoredon"
} ]
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest" ],
"searchInclude": [ "MedicationRequest:medication" ],
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}, {
"searchParam": [ {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationstatement-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationstatement-patient"
}, {
"name": "effective",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationstatement-effective"
} ],
"referencePolicy": [ "resolves" ],
"type": "MedicationStatement",
"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"
} ]
} ],
"documentation": "The MedicationStatement 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 /MedicationStatement?patient=[id]`\n\n `GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication`",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "effective"
} ]
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationstatement" ],
"searchInclude": [ "MedicationStatement:medication" ],
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
}, {
"type": "Observation",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "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": "SHALL"
}, {
"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": "SHALL"
}, {
"url": "required",
"valueString": "patient"
}, {
"url": "required",
"valueString": "category"
} ]
} ],
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status"
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category"
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age" ]
}, {
"type": "Organization",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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": "SHALL"
} ],
"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": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-address"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization" ]
}, {
"type": "Patient",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "SHALL"
}, {
"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"
} ]
}, {
"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"
} ]
} ],
"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": "SHALL"
} ],
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate"
}, {
"name": "family",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family"
}, {
"name": "gender",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender"
}, {
"name": "given",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"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": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier"
}, {
"name": "name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ]
}, {
"type": "Practitioner",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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": "SHALL"
} ],
"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": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner" ]
}, {
"type": "PractitionerRole",
"profile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"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": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty"
}, {
"name": "practitioner",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner"
} ],
"searchInclude": [ "PractitionerRole:endpoint", "PractitionerRole:practitioner" ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole" ]
}, {
"type": "Procedure",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}, {
"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": "SHALL"
}, {
"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": "code"
}, {
"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": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date"
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code"
} ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure" ]
} ],
"security": {
"description": "1. See the [General Security Considerations](security.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
},
"documentation": "The US Core Server **SHALL**:\n\n1. Support the US Core Patient resource profile.\n1. Support at least one additional resource profile from the list of US Core Profiles.\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope\n - (Status 404): unknown resource\n - (Status 410): deleted resource.\n1. Support json source formats for all US Core interactions.\n1. Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.\n\nThe US Core Server **SHOULD**:\n\n1. Support xml source formats for all US Core interactions.\n1. Identify the US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n1. Support xml resource formats for all Argonaut questionnaire interactions."
} ]
}