{ "description": "This Section describes the expected capabilities of the PDex Server actor which is responsible for providing responses to the queries submitted by the PDex Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by PDex Servers are defined. PDex 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-pdex-server.json", "package_name": "hl7.fhir.us.davinci-pdex", "format": [ "json" ], "date": "2024-05-02", "publisher": "HL7 International / Financial Management", "patchFormat": [ "application/json-patch+json" ], "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166", "display": "United States of America" } ] } ], "name": "PdexServerCapabilityStatement", "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License", "type": null, "experimental": "false", "resourceType": "CapabilityStatement", "title": "PDEX Server CapabilityStatement", "package_version": "2.1.0-ballot", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fm" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex" } ] } } ], "status": "active", "id": "d664bb68-954f-46d7-8165-17ff3accad31", "kind": "requirements", "implementationGuide": [ "http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex|2.0.0" ], "url": "http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-server", "version": "2.1.0-ballot", "contact": [ { "name": "HL7 International / Financial Management", "telecom": [ { "value": "http://www.hl7.org/Special/committees/fm", "system": "url" }, { "value": "fm@lists.HL7.org", "system": "email" } ] }, { "name": "Mark Scrimshire (mark.scrimshire@onyxhealth.io)", "telecom": [ { "value": "mailto:mark.scrimshire@onyxhealth.io", "system": "email" } ] }, { "name": "HL7 International - Financial Management", "telecom": [ { "value": "http://www.hl7.org/Special/committees/fm", "system": "url" } ] } ], "rest": [ { "mode": "server", "resource": [ { "type": "AllergyIntolerance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance" ] }, { "type": "CarePlan", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "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": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "date" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-status" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan" ] }, { "type": "CareTeam", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam" ] }, { "type": "Condition", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "onset-date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "clinical-status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category" }, { "name": "clinical-status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient" }, { "name": "onset-date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ] }, { "type": "Consent", "interaction": [ { "code": "read" }, { "code": "create" }, { "code": "search-type" }, { "code": "vread" }, { "code": "history-instance" }, { "code": "history-type" } ], "readHistory": true, "searchParam": [ { "name": "_id", "type": "string" }, { "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" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-consent" ] }, { "type": "Coverage", "interaction": [ { "code": "read" }, { "code": "search-type" }, { "code": "vread" }, { "code": "history-instance" }, { "code": "history-type" } ], "readHistory": true, "searchParam": [ { "name": "_id", "type": "string" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-coverage" ] }, { "type": "Device", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient" }, { "name": "type", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-type" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-device", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device" ] }, { "type": "DiagnosticReport", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] } ], "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient" }, { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab" ] }, { "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" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient" }, { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category" }, { "name": "type", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date" }, { "name": "period", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period" } ], "operation": [ { "name": "docref", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref", "documentation": "A server **SHALL** be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. **MAY** provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server **SHALL** provide references to last or current encounter. **SHOULD** document what resources, if any, are returned as included resources`GET [base]/DocumentReference/$docref?patient=[id]`" } ], "referencePolicy": [ "resolves" ], "type": "DocumentReference", "interaction": [ { "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": "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](http://hl7.org/fhir/us/core/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": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" }, { "url": "required", "valueString": "period" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] } ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ] }, { "type": "Encounter", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "class" }, { "url": "required", "valueString": "patient" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "date" }, { "url": "required", "valueString": "patient" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id" }, { "name": "class", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-class" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date" }, { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status" }, { "name": "type", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-type" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ] }, { "type": "ExplanationOfBenefit", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "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" } ], "documentation": "Searches using service-date, _lastUpdated, or type require a patient search argument.\n\n_include:* SHALL be supported.\n" } ], "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Resource-id" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-pdex/SearchParameter/explanationofbenefit-patient" }, { "name": "_lastUpdated", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated" }, { "name": "type", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-pdex/SearchParameter/explanationofbenefit-type" }, { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-pdex/SearchParameter/explanationofbenefit-identifier" }, { "name": "service-date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-pdex/SearchParameter/explanationofbenefit-service-date" } ], "documentation": "When a Prior Authorization references another resource (e.g., Patient or Practitioner), the reference may be versioned or versionless. Payers SHALL use versioned references whenever they maintain point-in-time data (data that was effective as of the date of service or date of admission on the claim), but MAY use versionless references when they do not maintain versioned data. Clients MAY request referenced resources as part of an EOB search (by supplying the _include parameter) or directly using read or vread. Payers SHALL support both approaches, and SHALL return the same content for referenced resources in either case. “:iterate\" should be used if you request to include Coverage:payor in the EOB response bundle, e.g. GET [base]/ExplanationOfBenefit?[parameter=value]&_include=ExplanationOfBenefit:coverage&_include:iterate=Coverage:payor.", "searchInclude": [ "ExplanationOfBenefit:patient", "ExplanationOfBenefit:provider", "ExplanationOfBenefit:care-team", "ExplanationOfBenefit:coverage", "ExplanationOfBenefit:insurer", "ExplanationOfBenefit:*" ], "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-priorauthorization" ] }, { "type": "Goal", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "lifecycle-status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "target-date" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "lifecycle-status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-lifecycle-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient" }, { "name": "target-date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ] }, { "type": "Group", "operation": [ { "name": "bulk-member-match", "definition": "http://hl7.org/fhir/us/davinci-pdex/OperationDefinition/bulk-member-match", "documentation": "Client will submit multi-member-match-request bundle. Server will respond with a multi-member-match-response and instantiate a Group resource conforming to the PDexMemberMatchGroup that contains a set of matched members that the Server identified." }, { "name": "davinci-data-export", "definition": "http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export", "documentation": "Each DaVinci use case as part of its implementation guide can define the exportType parameter and the behavior expected." } ], "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Allows discovery of existing groups. SHOULD be limited to groups a requestor is permitted to access." }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "documentation": "Allows retrieval of a specific Group Resource." }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a Group Resource." }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to a Group Resource over time." }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "documentation": "Retrieve the change history fora Group Resource." } ], "searchParam": [ { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Group-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": "characteristic", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Group-characteristic", "documentation": "A common characteristic of all members of a group." }, { "name": "Group-characteristic-value-reference", "type": "composite", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/davinci-atr/SearchParameter/Group-characteristic-value-reference", "documentation": "multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true. multipleOr: The parameter may only have one value (no comma separators)." } ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group", "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-group", "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-member-match-group" ] }, { "type": "Immunization", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization" ] }, { "type": "Location", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "name", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-name" }, { "name": "address", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address" }, { "name": "address-city", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-city" }, { "name": "address-state", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-state" }, { "name": "address-postalcode", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-postalcode" } ], "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location" ] }, { "type": "Medication", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "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": "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" ] }, { "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" }, { "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" }, { "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" }, { "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" }, { "name": "authoredon", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon" } ], "referencePolicy": [ "resolves" ], "type": "MedicationRequest", "interaction": [ { "code": "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": "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. For example, A server **SHALL** be capable of returning all medications for a patient using one of or both: `GET /MedicationRequest?patient=[id]` `GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "encounter" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "authoredon" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "status" } ] } ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest" ], "searchInclude": [ "MedicationRequest:medication" ] }, { "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/davinci-pdex/SearchParameter/pdex-medicationdispense-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/davinci-pdex/SearchParameter/pdex-medicationdispense-patient" } ], "referencePolicy": [ "resolves" ], "type": "MedicationDispense", "interaction": [ { "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": "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 MedicationDispense 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. For example, A server **SHALL** be capable of returning all medications for a patient using one of or both: `GET /MedicationDispense?patient=[id]` `GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication`", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "status" } ] } ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-medicationdispense" ], "searchInclude": [ "MedicationDispense:medication" ] }, { "type": "Observation", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status" }, { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age", "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-smokingstatus", "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-observation-lab", "http://hl7.org/fhir/StructureDefinition/vitalsigns" ] }, { "type": "Organization", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "name", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-name" }, { "name": "address", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-address" } ], "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization" ] }, { "type": "Patient", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "birthdate" }, { "url": "required", "valueString": "family" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "family" }, { "url": "required", "valueString": "gender" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "birthdate" }, { "url": "required", "valueString": "name" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "gender" }, { "url": "required", "valueString": "name" } ] } ], "operation": [ { "name": "member-match", "definition": "http://hl7.org/fhir/us/davinci-hrex/OperationDefinition/member-match" } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id" }, { "name": "birthdate", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate" }, { "name": "family", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family" }, { "name": "gender", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender" }, { "name": "given", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given" }, { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier" }, { "name": "name", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ] }, { "type": "Practitioner", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "name", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-name" }, { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier" } ], "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner" ] }, { "type": "PractitionerRole", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "specialty", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty" }, { "name": "practitioner", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner" } ], "searchInclude": [ "PractitionerRole:endpoint", "PractitionerRole:practitioner" ], "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole" ] }, { "type": "Procedure", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" }, { "url": "required", "valueString": "date" } ] } ], "interaction": [ { "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": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "history-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ] } ], "searchParam": [ { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure" ] }, { "type": "Provenance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "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": "patch", "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.", "referencePolicy": [ "resolves" ], "supportedProfile": [ "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance" ] }, { "type": "ValueSet", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "operation": [ { "name": "expand", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand", "documentation": "A client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions." } ] } ], "security": { "description": "1. See the [US Core Security Considerations](http://hl7.org/fhir/us/core/security.html) section for requirements and recommendations. 2. 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 PDex Server **SHALL**: \n1. Support the US Core 3.1.1 Patient resource profile.\n2. Support at least one additional resource profile from the list of US Core and PDex Profiles. \n3. Implement the RESTful behavior according to the FHIR specification.\n4. Support json source formats for all US Core and PDex interactions. \n5. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope \n - (Status 404): unknown resource \n - (Status 410): deleted resource.\n\nThe PDex Server **SHOULD**: \n1. Support xml source formats for all US Core interactions.\n2. Identify the US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance." } ] }