Conformance requirements for the US Core Server Contents Conformance requirements for the US Core Server Behavior Resource Details 1. Patient 2. AllergyIntolerance 3. CarePlan 4. CareTeam 5. Condition 6. Device 7. DiagnosticReport 8. Goal 9. Immunization 10. Location 11. Medication 12. MedicationStatement 13. MedicationRequest 14. Observation 15. Organization 16. Practitioner 17. Procedure FHIR Version: 3.0.0 Supported formats: xml, json Published: 2017-03-08 Published by: Health Level Seven International US Realm Steering Committee The Section describes the expected capabilities of the US-Core Client which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined in the Conformance requirements for the US-Core Server section. US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements. Behavior Description: The US Core Client SHOULD: Support fetching and querying of one or more US Core profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement. security: The US Core Client SHALL: implement the security requirements documented in the US-Core IG. Resource Details 1. Patient Supported Profiles: US Core Patient Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching a patient using: GET [base]/Patient/[id]. A client SHOULD be capable of connecting to a server and fetching a patient by identifier using GET [base]/Patient?identifier=[system]|[code] A client SHOULD be capable of connecting to a server and fetching a patient by supporting at a minimum the following search parameters when at least 2 are present. To limit overly broad search results, a client search with gender should include family and given name search parameters.: name gender birthdate for example: GET [base]/Patient?family=[name]&?given=[name]&gender=[gender] 2. AllergyIntolerance Supported Profiles: US Core AllergyIntolerance Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching all patient's allergies using: Get [base]/AllergyIntolerance?patient=[id] 3. CarePlan Supported Profiles: US Core CarePlan Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching all of a patient's Assessment and Plan of Treatment information using: Get [base]/CarePlan?patient=[id]&category=assess-plan A client SHOULD be capable of connecting to a server and fetching a patient's Assessment and Plan of Treatment information over a specified time period using: Get [base]/CarePlan?patient=[id]&category=assess-plan&date=[date] A client SHOULD be capable of connecting to a server and fetching all of a patient's active Assessment and Plan of Treatment information using Get [base]/CarePlan?patient=[id]&category=assess-plan&status=active A client SHOULD be capable of connecting to a server and fetching a patient's active Assessment and Plan of Treatment information over a specified time period using Get [base]/CarePlan?patient=[id]&category=assess-plan&status=active&date=[date] 4. CareTeam Supported Profiles: US Core CareTeam Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching a patient's current care team members using: Get [base]/CareTeam?patient=[id]&status=active 5. Condition Supported Profiles: US Core Condition Profile Search Criteria: A client SHOULD be capable of fetching all problems and health concerns for a patient, including current as well as historical problems and health concerns using: Get [base]/Condition?patient=[id] A client SHOULD be capable of connecting to a server and fetching all of a patient's active problems and health concerns using: Get [base]/Condition?patient=[id]&clinicalstatus=active,recurrance,remission A client SHOULD be capable of connecting to a server and fetching all of a patient's problems or all of patient's health concerns using: Get [base]/Condition?patient=[id]&category=[problem|health-concern] 6. Device Supported Profiles: US Core Device Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching all Unique device identifier(s)(UDI) for a patient's implanted device(s): Get [base]/Device?patient=[id] 7. DiagnosticReport Supported Profiles: US Core DiagnosticReport Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory diagnostic reports queried by category using: Get [base]/DiagnosticReport?patient=[id]&category=LAB A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory diagnostic reports queried by category code and date range using: GET [base]/DiagnosticReport?patient=[id]&category=LAB&date=[date]{&date=[date]} A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory diagnostic reports queried by category and code using: GET [base]/DiagnosticReport?patient=[id]&category=LAB&code=[LOINC] A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory diagnostic reports queried by category and one or more codes and date range using: GET [base]/DiagnosticReport?patient=[id]&category=LAB&code=[LOINC1{,LOINC2,LOINC3,…}]&date=[date]{&date=[date]} 8. Goal Supported Profiles: US Core Goal Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching all of a patient's goals using: Get [base]/Goal?patient=[id] A client SHOULD be capable of connecting to a server and fetching all of all of a patient's goals over a specified time period using: GET [base]/Goal?patient=[id]&date=[date]{&date=[date]} 9. Immunization Supported Profiles: US Core Immunization Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching all immunizations for a patient using: Get [base]/Immunization?patient=[id] 10. Location Supported Profiles: US Core Location Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching a location by name using: Get [base]/Location?name=[string] A client SHOULD be capable of connecting to a server and fetching a location by address using: GET [base]/Location?address=[string] 11. Medication Supported Profiles: US Core Medication Profile 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 SHOULD be supported. 12. MedicationStatement Supported Profiles: US Core MedicationStatement Profile Search Criteria: The MedicationStatement resources can represent a medication using either a code or refer to the Medication resource. When referencing a Medication resource, the resource may be contained or an external resource. IF, an external reference to Medication is used, the server SHALL support the _include parameter for searching this element. The client application SHALL support all methods. A client SHOULD be capable of connecting to a server and fetching all medications for a patient using both: GET /MedicationStatement?patient=[id] and GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication 13. MedicationRequest Supported Profiles: US Core MedicationRequest Profile Search Criteria: The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing a Medication resource, the resource may be contained or an external resource. If, an external reference to Medication is used, the server SHALL support the _include parameter for searching this element. The client application SHALL support all methods. A client SHOULD be capable of connecting to a server and fetching all medications for a patient using both: GET /MedicationRequest?patient=[id] and GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication 14. Observation Supported Profiles: 1. US Core Result Observation Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory results queried by category using: GET [base]/Observation?patient=[id]&category=laboratory A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory results queried by category code and date range using: GET [base]/Observation?patient=[id]&category=laboratory&date=[date]{&date=[date]} A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory results queried by category and code using: GET [base]/Observation?patient=[id]&category=laboratory&code=[LOINC] A client SHOULD be capable of connecting to a server and fetching all of a patient's laboratory results queried by category and one or more codes and date range using: GET [base]/Observation?patient=[id]&category=laboratory&code=[LOINC1{,LOINC2,LOINC3,...}]&date=[date]{&date=[date]} Vital Signs Profile Search Criteria A client SHOULD be capable of connecting to a server and fetching all of a patient's vital signs that it supports using: GET [base]/Observation?patient=[id]&category=vital-signs A client SHOULD be capable of connecting to a server and fetching all of a patient's vital signs queried by date range using: GET [base]/Observation?patient=[id]&category=vital-signs&date=[date]{&date=[date]} A client SHOULD be capable of connecting to a server and fetching any of a patient's vital signs queried by one or more of the codes listed below using: GET [base]/Observation?patient=[id]&code[vital sign LOINC{,LOINC2,LOINC3,…}] A client SHOULD be capable of connecting to a server and fetching any of a patient's vital signs queried by one or more of the codes listed below and date range using: GET [base]/Observation?patient=[id]&code=[LOINC{,LOINC2…}]vital-signs&date=[date]{&date=[date]} US Core Smoking Status Observation Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching a patient's smoking status using: GET [base]/Observation?patient=[id]&code=72166-2 15. Organization Supported Profiles: US Core Organization Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching an organization by identifier using: `GET [base]/Organization?identifier=[system] [code]' A client SHOULD be capable of connecting to a server and fetching an organization by name using: GET [base]/Organization?name=[string] A client SHOULD be capable of connecting to a server and fetching an organization by address using: GET [base]/Organization?address=[string] 16. Practitioner Supported Profiles: US Core Practitioner Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching a practitioner by identifier using: GET [base]/Practitioner?identifier=[system]|[code] A client SHOULD be capable of connecting to a server and fetching a practitioner by name using: GET [base]/Practitioner?family=[string]&given=[string] 17. Procedure Supported Profiles: US Core Procedure Profile Search Criteria: A client SHOULD be capable of connecting to a server and fetching a patient's procedures using: GET/Procedure?patient=[id] A client SHOULD be capable of connecting to a server and fetching all of a patient's procedures over a specified time period using: GET /Procedure?patient=[id]&date=[date]{&date=[date]}
This profile defines the expected capabilities of the US Core Client conforming to the US Core IG.
United States Minor Outlying Islands (the)
US Core Smoking Status Observation Profile
Allows discovery of existing US Core patient resources using different search criteria
Allows retrieval of a specific US Core patients by id
Allows review of changes to US Core patient instance over time
Allows retrieval of a historical version of a US Core patient instance
Allows discovery of existing US Core AllergyIntolerance resources using different search criteria
Allows retrieval of a specific US Core AllergyIntolerance by id
Allows review of changes to US Core AllergyIntolerance instance over time
Allows retrieval of a historical version of a US Core AllergyIntolerance instance
Allows discovery of existing US Core careplan resources using different search criteria
Allows retrieval of a specific US Core careplan by id
Allows review of changes to US Core careplan instance over time
Allows retrieval of a historical version of a US Core careplan instance
Allows discovery of existing US Core careteam resources using different search criteria
Allows retrieval of a specific US Core careteam by id
Allows review of changes to US Core careteam instance over time
Allows retrieval of a historical version of a US Core careteam instance
Allows discovery of existing US Core condition resources using different search criteria
Allows retrieval of a specific US Core condition by id
Allows review of changes to US Core condition instance over time
Allows retrieval of a historical version of a US Core condition instance
Allows discovery of existing US Core device resources using different search criteria
Allows retrieval of a specific US Core device by id
Allows review of changes to US Core device instance over time
Allows retrieval of a historical version of a US Core device instance
Allows discovery of existing US Core goal resources using different search criteria
Allows retrieval of a specific US Core goal by id
Allows review of changes to US Core goal instance over time
Allows retrieval of a historical version of a US Core goal instance
Allows discovery of existing US Core immunization resources using different search criteria
Allows retrieval of a specific US Core immunization by id
Allows review of changes to US Core immunization instance over time
Allows retrieval of a historical version of a US Core immunization instance
Allows discovery of existing US Core diagnosticreport resources using different search criteria
Allows retrieval of a specific US Core diagnosticreport by id
Allows review of changes to US Core diagnosticreport instance over time
Allows retrieval of a historical version of a US Core diagnosticreport instance
Allows discovery of existing US Core resultobs resources using different search criteria
Allows retrieval of a specific US Core resultobs by id
Allows review of changes to US Core resultobs instance over time
Allows retrieval of a historical version of a US Core resultobs instance
Allows discovery of existing US Core location resources using different search criteria.
Allows retrieval of a historical version of a US Core location instance
Allows review of changes to US Core Medication instance over time
Allows retrieval of a historical version of a US Core Medication instance
IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows discovery of existing US Core Medication resources using different search criteria.
IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows retrieval of a specific US Core Medication by id
Allows discovery of existing US Core medicationstatement resources using different search criteria
Allows retrieval of a specific US Core medicationstatement by id
Allows review of changes to US Core medicationstatement instance over time
Allows retrieval of a historical version of a US Core medicationstatement instance
Allows discovery of existing US Core medicationorder resources using different search criteria
Allows retrieval of a specific US Core medicationorder by id
Allows review of changes to US Core medicationorder instance over time
Allows retrieval of a historical version of a US Core medicationorder instance
Allows discovery of existing US Core organization resources using different search criteria
Allows retrieval of a specific US Core organization by id
Allows review of changes to US Core organization instance over time
Allows retrieval of a historical version of a US Core organization instance
Allows discovery of existing US Core practitioner resources using different search criteria
Allows retrieval of a specific US Core practitioner by id
Allows review of changes to US Core practitioner instance over time
Afllows retrieval of a historical version of a US Core practitioner instance
Allows discovery of existing US Core procedure resources using different search criteria
Allows retrieval of a specific US Core procedure by id
Allows review of changes to US Core procedure instance over time
Allows retrieval of a historical version of a US Core procedure instance