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.0). 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 Client CapabilityStatement

  • Implementation Guide Version: 3.1.0
  • FHIR Version: 4.0.1
  • Supported formats: xml, json
  • Published: 2019-10-04
  • Published by: HL7 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 Server. 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 Client SHALL:

  1. 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:

  1. See the [General Security Considerations] section for requirements and recommendations.

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+date, patient+category, patient+category+status, patient+category+status+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+category, patient+onset-date, 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+category, patient+status, patient+code, patient+code+date Provenance:target
    DocumentReferenceUS Core DocumentReference Profile _id, status, patient, category, type, date, period, patient+category+date, patient+category, patient+type+period, patient+status, patient+type Provenance:target $docref
    EncounterUS Core Encounter Profile _id, class, date, identifier, patient, status, type, date+patient, class+patient, patient+type, patient+status Provenance:target
    GoalUS Core Goal Profile lifecycle-status, patient, target-date, patient+target-date, patient+lifecycle-status 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 Provenance:target
    MedicationUS Core Medication Profile Provenance:target
    MedicationRequestUS Core MedicationRequest Profile status, intent, patient, encounter, authoredon, patient+intent, patient+intent+encounter, patient+intent+status, patient+intent+authoredon 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 status, category, code, date, patient, patient+category+date, patient+category, patient+code, patient+code+date, patient+category+status Provenance:target
    OrganizationUS Core Organization Profile name, address Provenance:target
    PatientUS Core Patient Profile _id, birthdate, family, gender, given, identifier, name, birthdate+name, birthdate+family, gender+name, family+gender Provenance:target
    PractitionerUS Core Practitioner Profile name, identifier Provenance:target
    PractitionerRoleUS Core PractitionerRole Profile specialty, practitioner PractitionerRole:endpoint, PractitionerRole:practitioner Provenance:target
    ProcedureUS Core Procedure Profile status, patient, date, code, patient+date, patient+code+date, patient+status Provenance:target
    ProvenanceUS Core Provenance Profile
    ValueSet $expand

    AllergyIntolerance

    Supported Profiles: US Core AllergyIntolerance Profile

    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 Client SHALL be capable of fetching a AllergyIntolerance resource using:
      GET [base]/AllergyIntolerance/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDclinical-status token GET [base]/AllergyIntolerance?clinical-status=[system]|[code]
    SHOULDpatient 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

    Supported Profiles: US Core CarePlan Profile

    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 Client SHALL be capable of fetching a CarePlan resource using:
      GET [base]/CarePlan/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDcategory token GET [base]/CarePlan?category=[system]|[code]
    SHOULDdate date GET [base]/CarePlan?date=[date]
    SHOULDpatient reference GET [base]/CarePlan?patient=[patient]
    SHOULDstatus token GET [base]/CarePlan?status=[status]

    Search Parameter Combination Summary:

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

    CareTeam

    Supported Profiles: US Core CareTeam Profile

    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 Client SHALL be capable of fetching a CareTeam resource using:
      GET [base]/CareTeam/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDpatient reference GET [base]/CareTeam?patient=[patient]
    SHOULDstatus token GET [base]/CareTeam?status=[status]

    Search Parameter Combination Summary:

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

    Condition

    Supported Profiles: US Core Condition Profile

    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 Client SHALL be capable of fetching a Condition resource using:
      GET [base]/Condition/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDcategory token GET [base]/Condition?category=[system]|[code]
    SHOULDclinical-status token GET [base]/Condition?clinical-status=[system]|[code]
    SHOULDpatient reference GET [base]/Condition?patient=[patient]
    SHOULDonset-date date GET [base]/Condition?onset-date=[onset-date]
    SHOULDcode token GET [base]/Condition?code=[system]|[code]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+category reference+token GET [base]/Condition?patient=[patient]&category=[system]|[code]
    SHOULDpatient+onset-date reference+date GET [base]/Condition?patient=[patient]&onset-date=[onset-date]
    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

    Supported Profiles: US Core Implantable Device Profile

    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 Client SHALL be capable of fetching a Device resource using:
      GET [base]/Device/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDpatient reference GET [base]/Device?patient=[patient]
    SHOULDtype 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

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

    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 Client SHALL be capable of fetching a DiagnosticReport resource using:
      GET [base]/DiagnosticReport/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDstatus token GET [base]/DiagnosticReport?status=[status]
    SHOULDpatient reference GET [base]/DiagnosticReport?patient=[patient]
    SHOULDcategory token GET [base]/DiagnosticReport?category=[system]|[code]
    SHOULDcode token GET [base]/DiagnosticReport?code=[system]|[code]
    SHOULDdate date GET [base]/DiagnosticReport?date=[date]

    Search Parameter Combination Summary:

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

    DocumentReference

    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

    Profile Interaction Summary:

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

    Operation Summary:

    • SHOULD support the $docref operation

      A client SHOULD be capable of transacting a $docref operation and capable of receiving at least a reference to a generated CCD document, and MAY be able to receive other document types, if available. SHOULD be capable of receiving documents as included resources in response to the operation.

      GET [base]/DocumentReference/$docref?patient=[id]

    Fetch and Search Criteria:

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

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/DocumentReference?_id=[id]
    SHOULDstatus token GET [base]/DocumentReference?status=[status]
    SHOULDpatient reference GET [base]/DocumentReference?patient=[patient]
    SHOULDcategory token GET [base]/DocumentReference?category=[system]|[code]
    SHOULDtype token GET [base]/DocumentReference?type=[system]|[code]
    SHOULDdate date GET [base]/DocumentReference?date=[date]
    SHOULDperiod date GET [base]/DocumentReference?period=[period]

    Search Parameter Combination Summary:

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

    Encounter

    Supported Profiles: US Core Encounter Profile

    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 Client SHALL be capable of fetching a Encounter resource using:
      GET [base]/Encounter/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/Encounter?_id=[id]
    SHOULDclass token GET [base]/Encounter?class=[system]|[code]
    SHOULDdate date GET [base]/Encounter?date=[date]
    SHOULDidentifier token GET [base]/Encounter?identifier=[system]|[code]
    SHOULDpatient reference GET [base]/Encounter?patient=[patient]
    SHOULDstatus token GET [base]/Encounter?status=[status]
    SHOULDtype token GET [base]/Encounter?type=[system]|[code]

    Search Parameter Combination Summary:

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

    Goal

    Supported Profiles: US Core Goal Profile

    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 Client SHALL be capable of fetching a Goal resource using:
      GET [base]/Goal/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDlifecycle-status token GET [base]/Goal?lifecycle-status=[system]|[code]
    SHOULDpatient reference GET [base]/Goal?patient=[patient]
    SHOULDtarget-date date GET [base]/Goal?target-date=[target-date]

    Search Parameter Combination Summary:

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

    Immunization

    Supported Profiles: US Core Immunization Profile

    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 Client SHALL be capable of fetching a Immunization resource using:
      GET [base]/Immunization/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDpatient reference GET [base]/Immunization?patient=[patient]
    SHOULDstatus token GET [base]/Immunization?status=[status]
    SHOULDdate 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

    Supported Profiles: US Core Location Profile

    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 Client SHALL be capable of fetching a Location resource using:
      GET [base]/Location/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDname string GET [base]/Location?name=[name]
    SHOULDaddress 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

    Supported Profiles: US Core Medication Profile

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

    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 Client SHALL be capable of fetching a Medication resource using:
      GET [base]/Medication/[id]

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


    MedicationRequest

    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

    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 Client SHALL be capable of fetching a MedicationRequest resource using:
      GET [base]/MedicationRequest/[id]

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

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDstatus token GET [base]/MedicationRequest?status=[status]
    SHOULDintent token GET [base]/MedicationRequest?intent=[system]|[code]
    SHOULDpatient reference GET [base]/MedicationRequest?patient=[patient]
    SHOULDencounter reference GET [base]/MedicationRequest?encounter=[encounter]
    SHOULDauthoredon date GET [base]/MedicationRequest?authoredon=[authoredon]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationTypesExample
    SHOULDpatient+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+status reference+token+token GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&status=[status]
    SHOULDpatient+intent+authoredon reference+token+date GET [base]/MedicationRequest?patient=[patient]&intent=[system]|[code]&authoredon=[authoredon]

    Observation

    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

    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 Client SHALL be capable of fetching a Observation resource using:
      GET [base]/Observation/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDstatus token GET [base]/Observation?status=[status]
    SHOULDcategory token GET [base]/Observation?category=[system]|[code]
    SHOULDcode token GET [base]/Observation?code=[system]|[code]
    SHOULDdate date GET [base]/Observation?date=[date]
    SHOULDpatient reference GET [base]/Observation?patient=[patient]

    Search Parameter Combination Summary:

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

    Organization

    Supported Profiles: US Core Organization Profile

    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 Client SHALL be capable of fetching a Organization resource using:
      GET [base]/Organization/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDname string GET [base]/Organization?name=[name]
    SHOULDaddress string GET [base]/Organization?address=[address]

    Patient

    Supported Profiles: US Core Patient Profile

    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 Client SHALL be capable of fetching a Patient resource using:
      GET [base]/Patient/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/Patient?_id=[id]
    SHOULDbirthdate date GET [base]/Patient?birthdate=[birthdate]
    SHOULDfamily string GET [base]/Patient?family=[family]
    SHOULDgender token GET [base]/Patient?gender=[system]|[code]
    SHOULDgiven string GET [base]/Patient?given=[given]
    SHOULDidentifier token GET [base]/Patient?identifier=[system]|[code]
    SHOULDname string GET [base]/Patient?name=[name]

    Search Parameter Combination Summary:

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

    Practitioner

    Supported Profiles: US Core Practitioner Profile

    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 Client SHALL be capable of fetching a Practitioner resource using:
      GET [base]/Practitioner/[id]

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

    Search Parameter Summary:

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

    PractitionerRole

    Supported Profiles: US Core PractitionerRole Profile

    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 Client SHALL be capable of fetching a PractitionerRole resource using:
      GET [base]/PractitionerRole/[id]

    • A Client 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

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

    Search Parameter Summary:

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

    Procedure

    Supported Profiles: US Core Procedure Profile

    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 Client SHALL be capable of fetching a Procedure resource using:
      GET [base]/Procedure/[id]

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

    Search Parameter Summary:

    ConformanceParameterTypeExample
    SHOULDstatus token GET [base]/Procedure?status=[status]
    SHOULDpatient reference GET [base]/Procedure?patient=[patient]
    SHOULDdate date GET [base]/Procedure?date=[date]
    SHOULDcode token GET [base]/Procedure?code=[system]|[code]

    Search Parameter Combination Summary:

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

    Provenance

    Supported Profiles: US Core Provenance Profile

    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 Client SHALL be capable of fetching a Provenance resource using:
      GET [base]/Provenance/[id]


    ValueSet

    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.