{
"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 ONC [U.S. Core Data for Interoperability (USCDI)](https://www.healthit.gov/isa/sites/isa/files/2020-03/USCDI-Version1-2020-Final-Standard.pdf). 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": [ "json", "xml" ],
"_patchFormat": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"_format": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"date": "2021-06-17T14:23:02.762610-08:00",
"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"
} ]
} ],
"instantiates": [ "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server" ],
"name": "UsCoreServerCapabilityStatement",
"_instantiates": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
"type": null,
"experimental": "false",
"resourceType": "CapabilityStatement",
"title": "US Core Server CapabilityStatement",
"package_version": "4.0.0",
"status": "active",
"id": "99eedeb8-542a-4be5-8fed-9a661f05f144",
"kind": "requirements",
"implementationGuide": [ "http://fhir-registry.smarthealthit.org", "http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata" ],
"url": "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server",
"version": "4.0.0",
"contact": [ {
"name": "HL7 International - US Realm Steering Committee",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/usrealm/index.cfm",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"searchRevInclude": [ "Provenance:target" ],
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
} ],
"referencePolicy": [ "resolves" ],
"type": "AllergyIntolerance",
"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"
} ]
} ],
"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"
} ]
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"searchRevInclude": [ "Provenance:target" ],
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}, {
"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",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
} ],
"referencePolicy": [ "resolves" ],
"type": "CarePlan",
"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": "* 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",
"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": "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": "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"
} ]
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"searchRevInclude": [ "Provenance:target" ],
"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",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
} ],
"referencePolicy": [ "resolves" ],
"type": "CareTeam",
"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"
} ]
} ],
"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"
} ]
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"searchRevInclude": [ "Provenance:target" ],
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}, {
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
} ],
"referencePolicy": [ "resolves" ],
"type": "Condition",
"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"
} ]
} ],
"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": "onset-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": "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": "category"
} ]
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"searchRevInclude": [ "Provenance:target" ],
"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",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}, {
"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",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
} ],
"referencePolicy": [ "resolves" ],
"type": "Device",
"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": "* Implantable medical devices that have UDI information **SHALL** represent the UDI code in `Device.udiCarrier.carrierHRF`.\n - All of the five UDI-PI elements that are present in the UDI code **SHALL** be represented in the corresponding US Core Implantable Device Profile element.\n \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. If UDI is not present and the manufacturer and/or model number information is available, they **SHOULD** be included to support historical reports of implantable medical devices as follows:\n\n \n \n \n \n \n \n | manufacturer | \n Device.manufacturer | \n
\n \n | model | \n Device.model | \n
\n \n
\n\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"
,
"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"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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-diagnosticreport-patient"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
} ]
,
"referencePolicy": [ "resolves" ]
,
"type": "DiagnosticReport"
,
"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"
} ]
} ]
,
"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": "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"
} ]
}
, {
"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": "code"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
, "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
} ]
,
"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": "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": "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": "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"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *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": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
} ]
,
"referencePolicy": [ "resolves" ]
,
"type": "Encounter"
,
"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 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]"
,
"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": "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"
} ]
}
, {
"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"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *day*.\n\nA server **SHALL** support a value a value precise to the *day*."
} ]
,
"referencePolicy": [ "resolves" ]
,
"type": "Goal"
,
"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"
} ]
} ]
,
"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": "lifecycle-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": "target-date"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
} ]
,
"referencePolicy": [ "resolves" ]
,
"type": "Immunization"
,
"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": "* 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."
,
"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"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"type": "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"
} ]
,
"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."
,
"referencePolicy": [ "resolves" ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"type": "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": "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."
,
"referencePolicy": [ "resolves" ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"name": "intent"
,
"type": "token"
,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "MAY"
} ]
,
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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-medicationrequest-patient"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"name": "encounter"
,
"type": "reference"
,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "MAY"
} ]
,
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
} ]
,
"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 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."
,
"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": "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": "SHALL"
}
, {
"url": "required"
,
"valueString": "patient"
}
, {
"url": "required"
,
"valueString": "intent"
} ]
}
, {
"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": "SHALL"
}
, {
"url": "required"
,
"valueString": "patient"
}
, {
"url": "required"
,
"valueString": "intent"
}
, {
"url": "required"
,
"valueString": "status"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest" ]
,
"_searchInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHOULD"
} ]
} ]
,
"searchInclude": [ "MedicationRequest:medication" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
} ]
,
"referencePolicy": [ "resolves" ]
,
"type": "Observation"
,
"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": "* 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."
,
"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": "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": "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": "code"
} ]
} ]
,
"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" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"type": "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" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *day*.\n\nA server **SHALL** support a value a value precise to the *day*."
}
, {
"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"
,
"documentation": "A server **SHALL** support a value precise to the *day*."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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" ]
,
"type": "Patient"
,
"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": "* 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"
,
"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": "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": "family"
} ]
}
, {
"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"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"type": "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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
} ]
,
"referencePolicy": [ "resolves" ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
} ]
,
"referencePolicy": [ "resolves" ]
,
"type": "PractitionerRole"
,
"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 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."
,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole" ]
,
"_searchInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHOULD"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHOULD"
} ]
} ]
,
"searchInclude": [ "PractitionerRole:endpoint"
, "PractitionerRole:practitioner" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"_searchRevInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
,
"searchRevInclude": [ "Provenance:target" ]
,
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
, {
"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"
,
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
, {
"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"
,
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
} ]
,
"referencePolicy": [ "resolves" ]
,
"type": "Procedure"
,
"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": "* A procedure including an implantable device **SHOULD** use `Procedure.focalDevice` with a reference to the [US Core Implantable Device Profile]."
,
"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": "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": "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"
} ]
} ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"type": "Provenance"
,
"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": "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."
,
"referencePolicy": [ "resolves" ]
,
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance" ]
,
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHALL"
} ]
} ]
}
, {
"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](security.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
}
,
"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 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. For all the supported search interactions in this guide
, support the `GET` based search.\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scopes\n - (Status 404): unknown resource\n1. Support json source formats for all US Core interactions.\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."
} ]
,
"_implementationGuide": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHOULD"
} ]
}
, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
,
"valueCode": "SHOULD"
} ]
} ]
}