CapabilityStatement-us-core-server

Sourcehl7.fhir.us.core#current:US Core Implementation Guide (v4.0.1)
resourceTypeCapabilityStatement
idus-core-server
canonicalhttp://hl7.org/fhir/us/core/CapabilityStatement/us-core-server
version7.0.0-ballot
statusactive
publisherHL7 International - Cross-Group Projects
nameUsCoreServerCapabilityStatement
titleUS Core Server CapabilityStatement
date2023-04-24T12:52:12.190622-08:00
experimentalfalse
descriptionThis Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and the ONC [U.S. Core Data for Interoperability (USCDI) Version 3 July 2022](https://www.healthit.gov/isa/sites/isa/files/2022-07/USCDI-Version-3-July-2022-Final.pdf). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.
copyrightUsed by permission of HL7 International, all rights reserved Creative Commons License
jurisdictionsus
kindrequirements
fhirVersion4.0.1
instantiateshttp://hl7.org/fhir/us/core/CapabilityStatement/us-core-server
formatsjson xml application/json-patch+json
implementationGuideshttp://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch
Usages

UsCoreServerCapabilityStatement

This Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and the ONC U.S. Core Data for Interoperability (USCDI) Version 3 July 2022 . 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.

Mode SERVER
Description

The US Core Server SHALL :

  1. Support the US Core Patient resource profile AND at least one additional resource profile from the list of US Core Profiles AND and all Must Support US Core Profiles and resources it references.
    • The Table below summarizes the Must Support references to other US Core Profiles and FHIR resources for each US Core Profile:
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Follow the requirements documented in the General Requirements and Must Support pages
  4. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scopes
    • (Status 404): unknown resource
  5. Support JSON source formats for all US Core interactions.

The US Core Server SHOULD :

  1. Follow the guidance documented in the General Guidance page
  2. Support XML source formats for all US Core interactions.
  3. Identify the US Core profiles supported as part of the FHIR meta.profile attribute for each instance.
Transaction y
System History y
System Search y
Resource Type Profile Read V-Read Search Update Patch Create Delete Updates History
AllergyIntolerance Supported profiles:
   US Core AllergyIntolerance Profile
y y y y y y y y y
CarePlan Supported profiles:
   US Core CarePlan Profile
y y y y y y y y y
CareTeam Supported profiles:
   US Core CareTeam Profile
y y y y y y y y y
Condition Supported profiles:
   US Core Condition Encounter Diagnosis Profile
   US Core Condition Problems and Health Concerns Profile
y y y y y y y y y
Coverage Supported profiles:
   US Core Coverage Profile
y y y y y y y y y
Device Supported profiles:
   US Core Implantable Device Profile
y y y y y y y y y
DiagnosticReport Supported profiles:
   US Core DiagnosticReport Profile for Report and Note Exchange
   US Core DiagnosticReport Profile for Laboratory Results Reporting
y y y y y y y y y
DocumentReference Supported profiles:
   US Core DocumentReference Profile
y y y y y y y y y
Encounter Supported profiles:
   US Core Encounter Profile
y y y y y y y y y
Endpoint   y y y y y y y y y
Goal Supported profiles:
   US Core Goal Profile
y y y y y y y y y
HealthcareService   y y y y y y y y y
Immunization Supported profiles:
   US Core Immunization Profile
y y y y y y y y y
Location Supported profiles:
   US Core Location Profile
y y y y y y y y y
Media   y y y y y y y y y
Medication Supported profiles:
   US Core Medication Profile
y y y y y y y y y
MedicationDispense Supported profiles:
   US Core MedicationDispense Profile
y y y y y y y y y
MedicationRequest Supported profiles:
   US Core MedicationRequest Profile
y y y y y y y y y
Observation Supported profiles:
   US Core Laboratory Result Observation Profile
   US Core Observation Pregnancy Status Profile
   US Core Observation Pregnancy Intent Profile
   US Core Observation Occupation Profile
   US Core Respiratory Rate Profile
   US Core Simple Observation Profile
   US Core Heart Rate Profile
   US Core Body Temperature Profile
   US Core Pediatric Weight for Height Observation Profile
   US Core Pulse Oximetry Profile
   US Core Smoking Status Observation Profile
   US Core Observation Sexual Orientation Profile
   US Core Head Circumference Profile
   US Core Body Height Profile
   US Core BMI Profile
   US Core Observation Screening Assessment Profile
   US Core Blood Pressure Profile
   US Core Observation Clinical Result Profile
   US Core Pediatric BMI for Age Observation Profile
   US Core Pediatric Head Occipital Frontal Circumference Percentile Profile
   US Core Body Weight Profile
   US Core Vital Signs Profile
y y y y y y y y y
Organization Supported profiles:
   US Core Organization Profile
y y y y y y y y y
Patient Supported profiles:
   US Core Patient Profile
y y y y y y y y y
Practitioner Supported profiles:
   US Core Practitioner Profile
y y y y y y y y y
PractitionerRole Supported profiles:
   US Core PractitionerRole Profile
y y y y y y y y y
Procedure Supported profiles:
   US Core Procedure Profile
y y y y y y y y y
Provenance Supported profiles:
   US Core Provenance Profile
y y y y y y y y y
Questionnaire Supported profiles:
   SDCBaseQuestionnaire
y y y y y y y y y
QuestionnaireResponse Supported profiles:
   US Core QuestionnaireResponse Profile
y y y y y y y y y
RelatedPerson Supported profiles:
   US Core RelatedPerson Profile
y y y y y y y y y
ServiceRequest Supported profiles:
   US Core ServiceRequest Profile
y y y y y y y y y
Specimen Supported profiles:
   US Core Specimen Profile
y y y y y y y y y
ValueSet  

Produced 08 Sep 2023