HL7 FHIR® US Core Implementation Guide CI Build

US Core, published by HL7 International - US Realm Steering Committee. This is not an authorized publication; it is the continuous build for version 3.1.1). This version is based on the current content of https://github.com/HL7/US-Core-R4/ and changes regularly. See the Directory of published versions

Downloads: CapabilityStatement: (XML, JSON),OpenAPI-Swagger Definition file

US Core Server CapabilityStatement

  • Implementation Guide Version: 3.1.1
  • FHIR Version: 4.0.1
  • Supported formats: xml, json
  • Published: 2020-07-28
  • Published by: HL7 International - US Realm Steering Committee

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 and the ONC U.S. Core Data for Interoperability (USCDI). 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.

FHIR RESTful Capabilities

The US Core Server SHALL:

  1. Support the US Core Patient resource profile.
  2. Support at least one additional resource profile from the list of US Core Profiles.
  3. Implement the RESTful behavior according to the FHIR specification.
  4. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  5. Support json source formats for all US Core interactions.

The US Core Server SHOULD:

  1. Support xml source formats for all US Core interactions.
  2. Identify the US Core profiles supported as part of the FHIR meta.profile attribute for each instance.
  3. Support xml resource formats for all Argonaut questionnaire interactions.

Security:

  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.

Summary of System Wide Interactions

  • MAY support the transaction interaction.
  • MAY support the batch interaction.
  • MAY support the search-system interaction.
  • MAY support the history-system interaction.
  • RESTful Capabilities by Resource/Profile:

    Summary of Search Criteria

    Resource TypeSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
    AllergyIntoleranceUS Core AllergyIntolerance Profile clinical-status, patient patient+clinical-status Provenance:target
    CarePlanUS Core CarePlan Profile category, date, patient, status patient+category+status+date, patient+category+status, patient+category, patient+category+date Provenance:target
    CareTeamUS Core CareTeam Profile patient, status patient+status Provenance:target
    ConditionUS Core Condition Profile category, clinical-status, patient, onset-date, code patient+onset-date, patient+category, patient+clinical-status, patient+code Provenance:target
    DeviceUS Core Implantable Device Profile patient, type patient+type Provenance:target
    DiagnosticReportUS Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting status, patient, category, code, date patient+category+date, patient+status, patient+code+date, patient+code, patient+category Provenance:target
    DocumentReferenceUS Core DocumentReference Profile _id, status, patient, category, type, date, period patient+type+period, patient+type, patient+category+date, patient+status, patient+category Provenance:target docref
    EncounterUS Core Encounter Profile _id, class, date, identifier, patient, status, type class+patient, patient+status, patient+type, date+patient Provenance:target
    GoalUS Core Goal Profile lifecycle-status, patient, target-date patient+lifecycle-status, patient+target-date Provenance:target
    ImmunizationUS Core Immunization Profile patient, status, date patient+date, patient+status Provenance:target
    LocationUS Core Location Profile name, address, address-city, address-state, address-postalcode
    MedicationUS Core Medication Profile
    MedicationRequestUS Core MedicationRequest Profile status, intent, patient, encounter, authoredon patient+intent, patient+intent+encounter, patient+intent+authoredon, patient+intent+status MedicationRequest:medication Provenance:target
    ObservationUS Core Smoking Status Observation Profile, US Core Pediatric Weight for Height Observation Profile, US Core Laboratory Result Observation Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pulse Oximetry Profile, US Core Pediatric Head Occipital-frontal Circumference Percentile Profile status, category, code, date, patient patient+category+date, patient+category+status, patient+code+date, patient+code, patient+category Provenance:target
    OrganizationUS Core Organization Profile name, address
    PatientUS Core Patient Profile _id, birthdate, family, gender, given, identifier, name birthdate+family, family+gender, birthdate+name, gender+name Provenance:target
    PractitionerUS Core Practitioner Profile name, identifier
    PractitionerRoleUS Core PractitionerRole Profile specialty, practitioner PractitionerRole:endpoint, PractitionerRole:practitioner
    ProcedureUS Core Procedure Profile status, patient, date, code patient+date, patient+status, patient+code+date Provenance:target
    ProvenanceUS Core Provenance Profile
    ValueSet expand

    AllergyIntolerance

    Conformance Expectation: SHALL

    Supported Profiles: US Core AllergyIntolerance Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a AllergyIntolerance resource using:
      GET [base]/AllergyIntolerance/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYclinical-status token GET [base]/AllergyIntolerance?clinical-status=[system]|[code]
    SHALLpatient reference GET [base]/AllergyIntolerance?patient=[patient]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+clinical-status reference+token GET [base]/AllergyIntolerance?patient=[patient]&clinical-status=[system]|[code]

    CarePlan

    Conformance Expectation: SHALL

    Supported Profiles: US Core CarePlan Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a CarePlan resource using:
      GET [base]/CarePlan/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYcategory token GET [base]/CarePlan?category=[system]|[code]
    MAYdate date GET [base]/CarePlan?date=[date]
    MAYpatient reference GET [base]/CarePlan?patient=[patient]
    MAYstatus token GET [base]/CarePlan?status=[status]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+category+status+date reference+token+token+date GET [base]/CarePlan?patient=[patient]&category=[system]|[code]&status=[status]&date=[date]
    SHOULDpatient+category+status reference+token+token GET [base]/CarePlan?patient=[patient]&category=[system]|[code]&status=[status]
    SHALLpatient+category reference+token GET [base]/CarePlan?patient=[patient]&category=[system]|[code]
    SHOULDpatient+category+date reference+token+date GET [base]/CarePlan?patient=[patient]&category=[system]|[code]&date=[date]

    CareTeam

    Conformance Expectation: SHALL

    Supported Profiles: US Core CareTeam Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a CareTeam resource using:
      GET [base]/CareTeam/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYpatient reference GET [base]/CareTeam?patient=[patient]
    MAYstatus token GET [base]/CareTeam?status=[status]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHALLpatient+status reference+token GET [base]/CareTeam?patient=[patient]&status=[status]

    Condition

    Conformance Expectation: SHALL

    Supported Profiles: US Core Condition Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Condition resource using:
      GET [base]/Condition/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYcategory token GET [base]/Condition?category=[system]|[code]
    MAYclinical-status token GET [base]/Condition?clinical-status=[system]|[code]
    SHALLpatient reference GET [base]/Condition?patient=[patient]
    MAYonset-date date GET [base]/Condition?onset-date=[onset-date]
    MAYcode token GET [base]/Condition?code=[system]|[code]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+onset-date reference+date GET [base]/Condition?patient=[patient]&onset-date=[onset-date]
    SHOULDpatient+category reference+token GET [base]/Condition?patient=[patient]&category=[system]|[code]
    SHOULDpatient+clinical-status reference+token GET [base]/Condition?patient=[patient]&clinical-status=[system]|[code]
    SHOULDpatient+code reference+token GET [base]/Condition?patient=[patient]&code=[system]|[code]

    Device

    Conformance Expectation: SHALL

    Supported Profiles: US Core Implantable Device Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Device resource using:
      GET [base]/Device/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Device?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALLpatient reference GET [base]/Device?patient=[patient]
    MAYtype token GET [base]/Device?type=[system]|[code]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+type reference+token GET [base]/Device?patient=[patient]&type=[system]|[code]

    DiagnosticReport

    Conformance Expectation: SHALL

    Supported Profiles: US Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support create, search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support update, patch, delete, history-type.
    create

    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.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a DiagnosticReport resource using:
      GET [base]/DiagnosticReport/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYstatus token GET [base]/DiagnosticReport?status=[status]
    SHALLpatient reference GET [base]/DiagnosticReport?patient=[patient]
    MAYcategory token GET [base]/DiagnosticReport?category=[system]|[code]
    MAYcode token GET [base]/DiagnosticReport?code=[system]|[code]
    MAYdate date GET [base]/DiagnosticReport?date=[date]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHALLpatient+category+date reference+token+date GET [base]/DiagnosticReport?patient=[patient]&category=[system]|[code]&date=[date]
    SHOULDpatient+status reference+token GET [base]/DiagnosticReport?patient=[patient]&status=[status]
    SHOULDpatient+code+date reference+token+date GET [base]/DiagnosticReport?patient=[patient]&code=[system]|[code]&date=[date]
    SHALLpatient+code reference+token GET [base]/DiagnosticReport?patient=[patient]&code=[system]|[code]
    SHALLpatient+category reference+token GET [base]/DiagnosticReport?patient=[patient]&category=[system]|[code]

    DocumentReference

    Conformance Expectation: SHALL

    Supported Profiles: US Core DocumentReference Profile

    Resource Specific Documentation:

    The DocumentReference.type binding SHALL support at a minimum the 5 Common Clinical Notes and may extend to the full US Core DocumentReference Type Value Set

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support create, search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support update, patch, delete, history-type.

    Operation Summary:

    • SHALL support the $docref operation

      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]

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a DocumentReference resource using:
      GET [base]/DocumentReference/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALL_id token GET [base]/DocumentReference?_id=[id]
    MAYstatus token GET [base]/DocumentReference?status=[status]
    SHALLpatient reference GET [base]/DocumentReference?patient=[patient]
    MAYcategory token GET [base]/DocumentReference?category=[system]|[code]
    MAYtype token GET [base]/DocumentReference?type=[system]|[code]
    MAYdate date GET [base]/DocumentReference?date=[date]
    MAYperiod date GET [base]/DocumentReference?period=[period]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+type+period reference+token+date GET [base]/DocumentReference?patient=[patient]&type=[system]|[code]&period=[period]
    SHALLpatient+type reference+token GET [base]/DocumentReference?patient=[patient]&type=[system]|[code]
    SHALLpatient+category+date reference+token+date GET [base]/DocumentReference?patient=[patient]&category=[system]|[code]&date=[date]
    SHOULDpatient+status reference+token GET [base]/DocumentReference?patient=[patient]&status=[status]
    SHALLpatient+category reference+token GET [base]/DocumentReference?patient=[patient]&category=[system]|[code]

    Encounter

    Conformance Expectation: SHALL

    Supported Profiles: US Core Encounter Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Encounter resource using:
      GET [base]/Encounter/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALL_id token GET [base]/Encounter?_id=[id]
    MAYclass token GET [base]/Encounter?class=[system]|[code]
    MAYdate date GET [base]/Encounter?date=[date]
    SHOULDidentifier token GET [base]/Encounter?identifier=[system]|[code]
    SHALLpatient reference GET [base]/Encounter?patient=[patient]
    MAYstatus token GET [base]/Encounter?status=[status]
    MAYtype token GET [base]/Encounter?type=[system]|[code]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDclass+patient token+reference GET [base]/Encounter?class=[system]|[code]&patient=[patient]
    SHOULDpatient+status reference+token GET [base]/Encounter?patient=[patient]&status=[status]
    SHOULDpatient+type reference+token GET [base]/Encounter?patient=[patient]&type=[system]|[code]
    SHALLdate+patient date+reference GET [base]/Encounter?date=[date]&patient=[patient]

    Goal

    Conformance Expectation: SHALL

    Supported Profiles: US Core Goal Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Goal resource using:
      GET [base]/Goal/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYlifecycle-status token GET [base]/Goal?lifecycle-status=[system]|[code]
    SHALLpatient reference GET [base]/Goal?patient=[patient]
    MAYtarget-date date GET [base]/Goal?target-date=[target-date]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+lifecycle-status reference+token GET [base]/Goal?patient=[patient]&lifecycle-status=[system]|[code]
    SHOULDpatient+target-date reference+date GET [base]/Goal?patient=[patient]&target-date=[target-date]

    Immunization

    Conformance Expectation: SHALL

    Supported Profiles: US Core Immunization Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Immunization resource using:
      GET [base]/Immunization/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALLpatient reference GET [base]/Immunization?patient=[patient]
    MAYstatus token GET [base]/Immunization?status=[status]
    MAYdate date GET [base]/Immunization?date=[date]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+date reference+date GET [base]/Immunization?patient=[patient]&date=[date]
    SHOULDpatient+status reference+token GET [base]/Immunization?patient=[patient]&status=[status]

    Location

    Conformance Expectation: SHALL

    Supported Profiles: US Core Location Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Location resource using:
      GET [base]/Location/[id]

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALLname string GET [base]/Location?name=[name]
    SHALLaddress string GET [base]/Location?address=[address]
    SHOULDaddress-city string GET [base]/Location?address-city=[address-city]
    SHOULDaddress-state string GET [base]/Location?address-state=[address-state]
    SHOULDaddress-postalcode string GET [base]/Location?address-postalcode=[address-postalcode]

    Medication

    Conformance Expectation: SHALL

    Supported Profiles: US Core Medication Profile

    Resource Specific Documentation:

    The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resourcse is used in a MedicationRequest, then the READ SHALL be supported.

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support read.
    • SHOULD support vread, history-instance.
    • MAY support create, search-type, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Medication resource using:
      GET [base]/Medication/[id]


    MedicationRequest

    Conformance Expectation: SHALL

    Supported Profiles: US Core MedicationRequest Profile

    Resource Specific 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 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

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a MedicationRequest resource using:
      GET [base]/MedicationRequest/[id]

    • A Server SHOULD be capable of supporting the following _includes:
      MedicationRequest:medication - GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYstatus token GET [base]/MedicationRequest?status=[status]
    MAYintent token GET [base]/MedicationRequest?intent=[system]|[code]
    MAYpatient reference GET [base]/MedicationRequest?patient=[patient]
    MAYencounter reference GET [base]/MedicationRequest?encounter=[encounter]
    MAYauthoredon date GET [base]/MedicationRequest?authoredon=[authoredon]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHALLpatient+intent reference+token GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]
    SHOULDpatient+intent+encounter reference+token+reference GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&encounter=[encounter]
    SHOULDpatient+intent+authoredon reference+token+date GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&authoredon=[authoredon]
    SHALLpatient+intent+status reference+token+token GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&status=[status]

    Observation

    Conformance Expectation: SHALL

    Supported Profiles: US Core Smoking Status Observation Profile, US Core Pediatric Weight for Height Observation Profile, US Core Laboratory Result Observation Profile, US Core Pediatric BMI for Age Observation Profile, US Core Pulse Oximetry Profile, US Core Pediatric Head Occipital-frontal Circumference Percentile Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Observation resource using:
      GET [base]/Observation/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYstatus token GET [base]/Observation?status=[status]
    MAYcategory token GET [base]/Observation?category=[system]|[code]
    MAYcode token GET [base]/Observation?code=[system]|[code]
    MAYdate date GET [base]/Observation?date=[date]
    MAYpatient reference GET [base]/Observation?patient=[patient]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHALLpatient+category+date reference+token+date GET [base]/Observation?patient=[patient]&category=[system]|[code]&date=[date]
    SHOULDpatient+category+status reference+token+token GET [base]/Observation?patient=[patient]&category=[system]|[code]&status=[status]
    SHOULDpatient+code+date reference+token+date GET [base]/Observation?patient=[patient]&code=[system]|[code]&date=[date]
    SHALLpatient+code reference+token GET [base]/Observation?patient=[patient]&code=[system]|[code]
    SHALLpatient+category reference+token GET [base]/Observation?patient=[patient]&category=[system]|[code]

    Organization

    Conformance Expectation: SHALL

    Supported Profiles: US Core Organization Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Organization resource using:
      GET [base]/Organization/[id]

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALLname string GET [base]/Organization?name=[name]
    SHALLaddress string GET [base]/Organization?address=[address]

    Patient

    Conformance Expectation: SHALL

    Supported Profiles: US Core Patient Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Patient resource using:
      GET [base]/Patient/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALL_id token GET [base]/Patient?_id=[id]
    MAYbirthdate date GET [base]/Patient?birthdate=[birthdate]
    MAYfamily string GET [base]/Patient?family=[family]
    MAYgender token GET [base]/Patient?gender=[system]|[code]
    MAYgiven string GET [base]/Patient?given=[given]
    SHALLidentifier token GET [base]/Patient?identifier=[system]|[code]
    SHALLname string GET [base]/Patient?name=[name]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDbirthdate+family date+string GET [base]/Patient?birthdate=[birthdate]&family=[family]
    SHOULDfamily+gender string+token GET [base]/Patient?family=[family]&gender=[system]|[code]
    SHALLbirthdate+name date+string GET [base]/Patient?birthdate=[birthdate]&name=[name]
    SHALLgender+name token+string GET [base]/Patient?gender=[system]|[code]&name=[name]

    Practitioner

    Conformance Expectation: SHALL

    Supported Profiles: US Core Practitioner Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Practitioner resource using:
      GET [base]/Practitioner/[id]

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALLname string GET [base]/Practitioner?name=[name]
    SHALLidentifier token GET [base]/Practitioner?identifier=[system]|[code]

    PractitionerRole

    Conformance Expectation: SHALL

    Supported Profiles: US Core PractitionerRole Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a PractitionerRole resource using:
      GET [base]/PractitionerRole/[id]

    • A Server SHOULD be capable of supporting the following _includes:
      PractitionerRole:endpoint - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint
      PractitionerRole:practitioner - GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHALLspecialty token GET [base]/PractitionerRole?specialty=[system]|[code]
    SHALLpractitioner reference GET [base]/PractitionerRole?practitioner=[practitioner]

    Procedure

    Conformance Expectation: SHALL

    Supported Profiles: US Core Procedure Profile

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support search-type, read.
    • SHOULD support vread, history-instance.
    • MAY support create, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Procedure resource using:
      GET [base]/Procedure/[id]

    • A Server SHALL be capable of supporting the following _revincludes:
      Provenance:target - GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target

    Search Parameter Summary:

    ConformanceParameterTypeExample
    MAYstatus token GET [base]/Procedure?status=[status]
    SHALLpatient reference GET [base]/Procedure?patient=[patient]
    MAYdate date GET [base]/Procedure?date=[date]
    MAYcode token GET [base]/Procedure?code=[system]|[code]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHALLpatient+date reference+date GET [base]/Procedure?patient=[patient]&date=[date]
    SHOULDpatient+status reference+token GET [base]/Procedure?patient=[patient]&status=[status]
    SHOULDpatient+code+date reference+token+date GET [base]/Procedure?patient=[patient]&code=[system]|[code]&date=[date]

    Provenance

    Conformance Expectation: SHALL

    Supported Profiles: US Core Provenance Profile

    Resource Specific 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.

    Reference Policy: resolves

    Profile Interaction Summary:

    • SHALL support read.
    • SHOULD support vread, history-instance.
    • MAY support create, search-type, update, patch, delete, history-type.

    Fetch and Search Criteria:

    • A Server SHALL be capable of returning a Provenance resource using:
      GET [base]/Provenance/[id]


    ValueSet

    Conformance Expectation: SHOULD

    Operation Summary:

    • SHOULD support the $expand operation

      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.