{ "description": "This section describes the basic rules for the International Patient Access server actor that is responsible for providing responses to queries submitted by International Patient Access requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by International Patient Access servers are defined in this CapabilityStatement. International Patient Access 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-ipa-server.json", "package_name": "hl7.fhir.uv.ipa", "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-11-23T00:00:00.000-06:00", "publisher": "HL7 International - Patient Care Workgroup", "patchFormat": [ "application/json-patch+json" ], "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "001", "system": "http://unstats.un.org/unsd/methods/m49/m49.htm" } ] } ], "name": "InternationalPatientAccessAPI", "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License", "type": null, "experimental": "false", "resourceType": "CapabilityStatement", "title": "International Patient Access Server CapabilityStatement", "package_version": "0.1.0", "status": "draft", "id": "8ff349e0-b4b6-425f-8707-23d2b8706c90", "kind": "requirements", "implementationGuide": [ "http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch" ], "url": "http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server", "version": "0.1.0", "contact": [ { "telecom": [ { "value": "https://www.hl7.org/Special/committees/patientcare", "system": "url" } ] } ], "rest": [ { "mode": "server", "resource": [ { "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/SearchParameter/AllergyIntolerance-clinical-status", "documentation": "active | inactive | resolved" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-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." } ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "AllergyIntolerance", "interaction": [ { "code": "read", "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" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "clinical-status" } ] } ], "conditionalCreate": false, "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/Condition-category", "documentation": "The category of the condition" }, { "name": "clinical-status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status", "documentation": "The clinical status of the condition" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-code", "documentation": "Code for the condition" }, { "name": "onset-date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/Condition-onset-date", "documentation": "Date of onset for the condition" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-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." } ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "Condition", "interaction": [ { "code": "read", "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" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "clinical-status" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "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": "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" } ] } ], "conditionalCreate": false, "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "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": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category", "documentation": "Categorization of document" }, { "name": "contenttype", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category", "documentation": "Mime type of the content, may include charset" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "documentation": "When this document reference was created" }, { "name": "period", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period", "documentation": "Time of service that is being documented" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status", "documentation": "current | superseded | entered-in-error" }, { "name": "type", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-type", "documentation": "Kind of document (LOINC if possible)" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both." } ], "conditionalUpdate": false, "operation": [ { "name": "docref", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/uv/ipa/OperationDefinition/docref", "documentation": "A server **SHOULD** be capable of responding to a $docref operation and capable of returning at least a reference to a CDA 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": "read", "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" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "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": "type" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "contenttype" } ] }, { "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": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" }, { "url": "required", "valueString": "period" } ] } ], "conditionalCreate": false, "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "documentation": "Vaccination (non)-Administration Date" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/Immunization-status", "documentation": "Immunization event status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both." } ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "Immunization", "interaction": [ { "code": "read", "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" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ] } ], "conditionalCreate": false, "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "Medication", "interaction": [ { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "documentation": "The MedicationStatement and MedicationRequest resources can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationStatement or a MedicationRequest, then the READ and SEARCH Criteria **SHALL** be supported.", "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "conditionalCreate": false, "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-category", "documentation": "Returns prescriptions with different categories" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-code", "documentation": "Return prescriptions of this medication code" }, { "name": "authoredon", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon", "documentation": "Returns prescriptions written on this date" }, { "name": "intent", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent", "documentation": "Return prescriptions with this encounter identifier" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/medications-status", "documentation": "Status of the prescription" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both." } ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "MedicationRequest", "interaction": [ { "code": "read", "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" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "authoredon" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "status" } ] } ], "conditionalCreate": false, "searchInclude": [ "MedicationRequest:medication" ], "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/medications-status", "documentation": "Return statements that match the given status" }, { "name": "subject", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-subject", "documentation": "Return statements that match the given status" } ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "MedicationStatement", "interaction": [ { "code": "read", "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" } ] } ], "documentation": "The MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.\r\n\r\n For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\r\n\r\n `GET /MedicationRequest?patient=[id]`\r\n\r\n `GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`", "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "subject" }, { "url": "required", "valueString": "status" } ] } ], "conditionalCreate": false, "searchInclude": [ "MedicationRequest:medication" ], "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/Observation-category", "documentation": "The classification of the type of observation" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-code", "documentation": "The code of the observation type" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "definition": "http://hl7.org/fhir/SearchParameter/Observation-status", "documentation": "The status of the observation" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "documentation": "The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both." } ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "Observation", "interaction": [ { "code": "read", "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" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "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": "code" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "date" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "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" } ] } ], "conditionalCreate": false, "supportedProfile": [ "http://hl7.org/fhir/StructureDefinition/vitalsigns" ], "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation", "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "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": "birthdate", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/individual-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": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/individual-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": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/individual-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": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/individual-given" }, { "name": "identifier", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier", "documentation": "The client **SHALL** provide both the system and code values.\n\nThe server **SHALL NOT** support only code values." }, { "name": "name", "type": "string", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/Patient-name" } ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "Patient", "interaction": [ { "code": "read", "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" } ] } ], "updateCreate": false, "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": "SHOULD" }, { "url": "required", "valueString": "birthdate" }, { "url": "required", "valueString": "name" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "gender" }, { "url": "required", "valueString": "name" } ] } ], "conditionalCreate": false, "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "Practitioner", "interaction": [ { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "conditionalCreate": false, "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner", "conditionalDelete": "not-supported" }, { "searchRevInclude": [ "Provenance:target" ], "conditionalUpdate": false, "referencePolicy": [ "resolves" ], "type": "PractitionerRole", "interaction": [ { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "conditionalCreate": false, "searchInclude": [ "PractitionerRole:endpoint", "PractitionerRole:practitioner" ], "profile": "http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole", "conditionalDelete": "not-supported" } ], "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 IPA Server **SHALL**:\n\n1. Support the IPA Patient resource profile.\n1. Support at least one additional resource profile from the list of IPA Profiles.\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope\n - (Status 404): unknown resource\n - (Status 410): deleted resource.\n1. Support JSON source formats for all IPA interactions.\n1. Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.\n\nThe IPA Server **SHOULD**:\n\n1. Support XML source formats for all IPA interactions.\n1. Identify the IPA profiles supported as part of the FHIR `meta.profile` attribute for each instance." } ], "_implementationGuide": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] } ] }