{ "description": "This profile defines the expected capabilities of the US Core Client conforming to the US Core IG.", "_filename": "CapabilityStatement-client.json", "package_name": "hl7.fhir.us.core", "format": [ "xml", "json" ], "date": "2017-03-20T00:00:00+11:00", "publisher": "HL7 US Realm Steering Committee", "fhirVersion": "3.0.0", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166", "display": "United States Minor Outlying Islands (the)" } ] } ], "name": "US Core Client", "acceptUnknown": "extensions", "type": null, "experimental": null, "resourceType": "CapabilityStatement", "title": null, "package_version": "1.1.0", "status": "draft", "id": "2f59aa81-4421-420e-b214-36d8030f46b8", "kind": "requirements", "url": "http://hl7.org/fhir/us/core/CapabilityStatement/client", "version": "1.1.0", "contact": [ { "telecom": [ { "value": "http://www.hl7.org/SpecialCommittees/usrealm/index.cfm", "system": "other" } ] } ], "rest": [ { "mode": "client", "resource": [ { "type": "Patient", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core patient resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core patients by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core patient instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core patient instance" } ] }, { "type": "AllergyIntolerance", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core AllergyIntolerance resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core AllergyIntolerance by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core AllergyIntolerance instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core AllergyIntolerance instance" } ] }, { "type": "CarePlan", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core careplan resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core careplan by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core careplan instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core careplan instance" } ] }, { "type": "CareTeam", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core careteam resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core careteam by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core careteam instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core careteam instance" } ] }, { "type": "Condition", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core condition resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core condition by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core condition instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core condition instance" } ] }, { "type": "Device", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core device resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core device by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core device instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core device instance" } ] }, { "type": "DocumentReference", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core DocumentReference resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core DocumentReference by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core DocumentReference instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core DocumentReference instance" } ] }, { "type": "Encounter", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core Encounter resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core Encounter by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core Encounter instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core Encounter instance" } ] }, { "type": "Goal", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core goal resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core goal by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core goal instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core goal instance" } ] }, { "type": "Immunization", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core immunization resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core immunization by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core immunization instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core immunization instance" } ] }, { "type": "DiagnosticReport", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core diagnosticreport resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core diagnosticreport by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core diagnosticreport instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core diagnosticreport instance" } ] }, { "type": "Observation", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core resultobs resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core resultobs by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core resultobs instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core resultobs instance" } ] }, { "type": "Location", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core location resources using different search criteria." }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core location instance" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core Medication instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core Medication instance" } ] }, { "type": "Medication", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows discovery of existing US Core Medication resources using different search criteria." }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows retrieval of a specific US Core Medication by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core Medication instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core Medication instance" } ] }, { "type": "MedicationStatement", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core medicationstatement resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core medicationstatement by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core medicationstatement instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core medicationstatement instance" } ] }, { "type": "MedicationRequest", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core medicationorder resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core medicationorder by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core medicationorder instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core medicationorder instance" } ] }, { "type": "Organization", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core organization resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core organization by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core organization instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core organization instance" } ] }, { "type": "Practitioner", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core practitioner resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core practitioner by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core practitioner instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Afllows retrieval of a historical version of a US Core practitioner instance" } ] }, { "type": "PractitionerRole", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core PractitionerRole resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core PractitionerRole by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core PractitionerRole instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Afllows retrieval of a historical version of a US Core PractitionerRole instance" } ] }, { "type": "Procedure", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows discovery of existing US Core procedure resources using different search criteria" }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a specific US Core procedure by id" }, { "code": "history-instance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows review of changes to US Core procedure instance over time" }, { "code": "vread", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "documentation": "Allows retrieval of a historical version of a US Core procedure instance" } ] } ] } ] }