FHIR IG analytics| Package | hl7.fhir.us.core |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-us-core-client.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/US-Core/CapabilityStatement-us-core-client.html |
| URL | http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client |
| Version | 9.0.0 |
| Status | active |
| Date | 2025-12-19T19:16:08.871976-08:00 |
| Name | UsCoreClientCapabilityStatement |
| Title | US Core Client CapabilityStatement |
| Realm | us |
| Authority | hl7 |
| Description | This 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](CapabilityStatement-us-core-server.html). 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. |
| Copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| Kind | requirements |
| CapabilityStatement | |
| mcode-receiver-cancer-conditions-then-patients | mCODE Data Receiver: Get Conditions then Patients |
| mcode-receiver-patient-bundle | mCODE Data Receiver: Get Bundle for a Patient |
| mcode-receiver-patients-and-cancer-conditions | mCODE Data Receiver CapabilityStatement: Get in-scope patients (and associated Conditions) using _include |
| mcode-receiver-patients-in-group | mCODE Data Receiver: Get Patients in Group |
| mcode-receiver-patients-with-cancer-condition | mCODE Data Receiver CapabilityStatement: Get in-scope patients using reverse chaining |
| pa-patient-engagement | PA Patient Engagement |
| pa-service-provider-full | PA Service Provider (Full) |
| pa-service-provider-light | PA Service Provider (Light) |
| eltss-client | eLTSS Client |
| data-consumer-client | Data Consumer Client CapabilityStatement |
| data-source-client | Data Source Client CapabilityStatement |
| data-source-server | Data Source Server CapabilityStatement |
| CcdaOnFhirClient | CCDA on FHIR Client |
| NHSNCapabilityStatementEvaluationEngine | NHSN Data Evaluation Engine CapabilityStatement |
| full-dtr-ehr-311 | Full DTR EHR |
| full-dtr-ehr-700 | Full DTR EHR |
| smart-dtr-client | SMART on FHIR DTR Client |
| notification-forwarder | Notification Forwarder CapabilityStatement |
| notification-receiver | Notification Receiver CapabilityStatement |
| notification-sender | Notification Sender CapabilityStatement |
| mcc-client | MCC Client CapabilityStatement |
| SafrCapabilityStatementDataAggregator | US SAFR Data Aggregator CapabilityStatement |
| SafrCapabilityStatementEvaluationEngine | US SAFR Data Evaluation Engine CapabilityStatement |
| ImplementationGuide | |
| hl7.fhir.uv.smart-app-launch | SMART App Launch |
| OperationDefinition | |
| docref | US Core Fetch DocumentReference |
| StructureDefinition | |
| head-occipital-frontal-circumference-percentile | US Core Pediatric Head Occipital Frontal Circumference Percentile Profile |
| pediatric-bmi-for-age | US Core Pediatric BMI for Age Observation Profile |
| pediatric-weight-for-height | US Core Pediatric Weight for Height Observation Profile |
| us-core-adi-documentreference | US Core ADI DocumentReference Profile |
| us-core-allergyintolerance | US Core AllergyIntolerance Profile |
| us-core-average-blood-pressure | US Core Average Blood Pressure Profile |
| us-core-blood-pressure | US Core Blood Pressure Profile |
| us-core-bmi | US Core BMI Profile |
| us-core-body-height | US Core Body Height Profile |
| us-core-body-temperature | US Core Body Temperature Profile |
| us-core-body-weight | US Core Body Weight Profile |
| us-core-care-experience-preference | US Core Care Experience Preference Profile |
| us-core-careplan | US Core CarePlan Profile |
| us-core-careteam | US Core CareTeam Profile |
| us-core-condition-encounter-diagnosis | US Core Condition Encounter Diagnosis Profile |
| us-core-condition-problems-health-concerns | US Core Condition Problems and Health Concerns Profile |
| us-core-coverage | US Core Coverage Profile |
| us-core-device | US Core Device Profile |
| us-core-diagnosticreport-lab | US Core DiagnosticReport Profile for Laboratory Results Reporting |
| us-core-diagnosticreport-note | US Core DiagnosticReport Profile for Report and Note Exchange |
| us-core-documentreference | US Core DocumentReference Profile |
| us-core-encounter | US Core Encounter Profile |
| us-core-familymemberhistory | US Core FamilyMemberHistory Profile |
| us-core-goal | US Core Goal Profile |
| us-core-head-circumference | US Core Head Circumference Profile |
| us-core-heart-rate | US Core Heart Rate Profile |
| us-core-immunization | US Core Immunization Profile |
| us-core-location | US Core Location Profile |
| us-core-medication | US Core Medication Profile |
| us-core-medicationdispense | US Core MedicationDispense Profile |
| us-core-medicationrequest | US Core MedicationRequest Profile |
| us-core-observation-adi-documentation | US Core Observation ADI Documentation Profile |
| us-core-observation-clinical-result | US Core Observation Clinical Result Profile |
| us-core-observation-lab | US Core Laboratory Result Observation Profile |
| us-core-observation-occupation | US Core Observation Occupation Profile |
| us-core-observation-pregnancyintent | US Core Observation Pregnancy Intent Profile |
| us-core-observation-pregnancystatus | US Core Observation Pregnancy Status Profile |
| us-core-observation-screening-assessment | US Core Observation Screening Assessment Profile |
| us-core-observation-sexual-orientation | US Core Observation Sexual Orientation Profile |
| us-core-organization | US Core Organization Profile |
| us-core-patient | US Core Patient Profile |
| us-core-pmo-servicerequest | US Core PMO ServiceRequest Profile |
| us-core-practitioner | US Core Practitioner Profile |
| us-core-practitionerrole | US Core PractitionerRole Profile |
| us-core-procedure | US Core Procedure Profile |
| us-core-provenance | US Core Provenance Profile |
| us-core-pulse-oximetry | US Core Pulse Oximetry Profile |
| us-core-questionnaireresponse | US Core QuestionnaireResponse Profile |
| us-core-relatedperson | US Core RelatedPerson Profile |
| us-core-respiratory-rate | US Core Respiratory Rate Profile |
| us-core-servicerequest | US Core ServiceRequest Profile |
| us-core-simple-observation | US Core Simple Observation Profile |
| us-core-smokingstatus | US Core Smoking Status Observation Profile |
| us-core-specimen | US Core Specimen Profile |
| us-core-treatment-intervention-preference | US Core Treatment Intervention Preference Profile |
| us-core-vital-signs | US Core Vital Signs Profile |
| sdc-questionnaire | SDC Base Questionnaire |
Note: links and images are rebased to the (stated) source
| Supports other guides: |
|
|---|
The US Core Client SHALL:
NOTE: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:
multipleAndmultipleOrcomparatormodifierchainThey SHALL NOT be interpreted as search parameters for search. Servers and Clients SHOULD use the standard FHIR SearchParameters.
Security:
transaction interaction.batch interaction.search-system interaction.history-system interaction.| Resource Type | Supported Profiles | Supported Searches | Supported _includes |
Supported _revincludes |
Supported Operations |
|---|---|---|---|---|---|
| AllergyIntolerance |
•US Core AllergyIntolerance Profile |
exist clinical-status, patient , patient+clinical-status | - | Provenance:target | - |
| CarePlan |
•US Core CarePlan Profile |
exist category, date, patient, status , patient+category+status, patient+category, patient+category+date, patient+category+status+date | - | Provenance:target | - |
| CareTeam |
•US Core CareTeam Profile |
exist patient, role, status , patient+status, patient+role | CareTeam:participant:PractitionerRole CareTeam:participant:Practitioner CareTeam:participant:Patient CareTeam:participant:RelatedPerson | Provenance:target | - |
| Condition |
•US Core Condition Encounter Diagnosis Profile •US Core Condition Problems and Health Concerns Profile |
exist abatement-date, asserted-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date, _lastUpdated , patient+clinical-status, patient+code, patient+category, patient+abatement-date, patient+recorded-date, patient+_lastUpdated, patient+asserted-date, patient+category+clinical-status, patient+onset-date, patient+category+encounter | - | Provenance:target | - |
| Coverage |
•US Core Coverage Profile |
exist patient | - | Provenance:target | - |
| Device |
•US Core Device Profile |
exist patient, status, type , patient+type, patient+status | - | Provenance:target | - |
| DiagnosticReport |
•US Core DiagnosticReport Profile for Report and Note exchange •US Core DiagnosticReport Profile for Laboratory Results Reporting |
exist category, code, date, _lastUpdated, patient, status , patient+code+date, patient+category+_lastUpdated, patient+category+date, patient+category, patient+status, patient+code | - | Provenance:target | - |
| DocumentReference |
•US Core DocumentReference Profile •US Core ADI DocumentReference Profile |
exist _id, category, date, patient, period, status, type , patient+type, patient+category+date, patient+category, patient+type+period, patient+status | - | Provenance:target | $docref |
| Encounter |
•US Core Encounter Profile |
exist _id, class, date, _lastUpdated, discharge-disposition, identifier, location, patient, status, type , patient+type, class+patient, patient+status, patient+_lastUpdated, patient+location, date+patient, patient+discharge-disposition | - | Provenance:target | - |
| Endpoint | - | exist - | - | - | - |
| FamilyMemberHistory |
•US Core FamilyMemberHistory Profile |
exist patient, code , patient+code | - | Provenance:target | - |
| Goal |
•US Core Goal Profile |
exist description, lifecycle-status, patient, target-date , patient+description, patient+target-date, patient+lifecycle-status | - | Provenance:target | - |
| HealthcareService | - | exist - | - | - | - |
| Immunization |
•US Core Immunization Profile |
exist date, patient, status , patient+date, patient+status | - | Provenance:target | - |
| Location |
•US Core Location Profile |
exist address, address-city, address-postalcode, address-state, name | - | - | - |
| Media | - | exist - | - | - | - |
| Medication |
•US Core Medication Profile |
exist - | - | - | - |
| MedicationDispense |
•US Core MedicationDispense Profile |
exist patient, status, type , patient+status+type, patient+status | MedicationDispense:medication | Provenance:target | - |
| MedicationRequest |
•US Core MedicationRequest Profile |
exist authoredon, encounter, intent, patient, status , patient+intent+authoredon, patient+intent+encounter, patient+intent, patient+intent+status | MedicationRequest:medication | Provenance:target | - |
| Observation |
•US Core Observation ADI Documentation Profile •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 Treatment Intervention Preference Profile •US Core Care Experience Preference 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 Average Blood Pressure 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 |
exist category, code, date, _lastUpdated, patient, status , patient+code+date, patient+category+_lastUpdated, patient+category+date, patient+category, patient+category+status, patient+code | - | Provenance:target | - |
| Organization |
•US Core Organization Profile |
exist address, name | - | - | - |
| Patient |
•US Core Patient Profile |
exist _id, birthdate, death-date, family, given, identifier, name , birthdate+name, birthdate+family, death-date+family | - | Provenance:target | - |
| Practitioner |
•US Core Practitioner Profile |
exist _id, identifier, name | - | - | - |
| PractitionerRole |
•US Core PractitionerRole Profile |
exist practitioner, specialty | PractitionerRole:endpoint PractitionerRole:practitioner | - | - |
| Procedure |
•US Core Procedure Profile |
exist code, date, patient, status , patient+code+date, patient+date, patient+status | - | Provenance:target | - |
| Provenance |
•US Core Provenance Profile |
exist - | - | - | - |
| Questionnaire |
•SDC Base Questionnaire Profile |
exist - | - | - | - |
| QuestionnaireResponse |
•US Core QuestionnaireResponse Profile |
exist _id, authored, patient, questionnaire, status , patient+questionnaire, patient+authored, patient+status | - | Provenance:target | - |
| RelatedPerson |
•US Core RelatedPerson Profile |
exist _id, name, patient , patient+name | - | Provenance:target | - |
| ServiceRequest |
•US Core PMO ServiceRequest Profile •US Core ServiceRequest Profile |
exist _id, authored, category, code, patient, status , patient+code+authored, patient+category+authored, patient+category, patient+status, patient+code | - | Provenance:target | - |
| Specimen |
•US Core Specimen Profile |
exist _id, patient | - | - | - |
| ValueSet | - | exist - | - | - | $expand |
Conformance Expectation: SHOULD
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/AllergyIntolerance {?_format=[mime-type]}
PUT [base]/AllergyIntolerance/[id] {?_format=[mime-type]}
PATCH [base]/AllergyIntolerance/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching AllergyIntolerance resources matching a search query using:
GET [base]/AllergyIntolerance/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a AllergyIntolerance resource using:
GET [base]/AllergyIntolerance/[id]
vread interaction fetching a AllergyIntolerance resource using:
GET [base]/AllergyIntolerance/[id]/_history/vid
history-instance interaction fetching a history of a AllergyIntolerance using:
GET [base]/AllergyIntolerance/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of AllergyIntolerance resources using:
GET [base]/AllergyIntolerance/_history{?[parameters]&_format=[mime-type]}
GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/AllergyIntolerance?patient=[type]/[id]
|
| SHOULD | patient+clinical-status | Reference+Token |
GET [base]/AllergyIntolerance?patient=[type]/[id]&clinical-status=[system]|[code]
|
The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
Additional considerations for systems aligning with HL7 Consolidated (C-CDA) Care Plan requirements:
US Core Goal SHOULD be present in CarePlan.goal
US Core Condition SHOULD be present in CarePlan.addresses
Assessment and Plan MAY be included as narrative text
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/CarePlan {?_format=[mime-type]}
PUT [base]/CarePlan/[id] {?_format=[mime-type]}
PATCH [base]/CarePlan/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching CarePlan resources matching a search query using:
GET [base]/CarePlan/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a CarePlan resource using:
GET [base]/CarePlan/[id]
vread interaction fetching a CarePlan resource using:
GET [base]/CarePlan/[id]/_history/vid
history-instance interaction fetching a history of a CarePlan using:
GET [base]/CarePlan/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of CarePlan resources using:
GET [base]/CarePlan/_history{?[parameters]&_format=[mime-type]}
GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHOULD | patient+category+status | Reference+Token+Token |
GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]
|
| SHALL | patient+category | Reference+Token |
GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]
|
| SHOULD | patient+category+date | Reference+Token+Date/DateTime |
GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]
|
| SHOULD | patient+category+status+date | Reference+Token+Token+Date/DateTime |
GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]&date=[dateTime]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:
US Core Practitioner Profile
US Core PractitionerRole Profile
US Core Patient Profile
US Core RelatedPerson Profile
Although both US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references, but SHALL support at least one of them.
The client application SHALL support all four profile references.
Bacause the US Core PractitionerRole Profile supplies the provider's location and contact information and a reference to the Practitioner, server systems SHOULD reference it instead of the US Core Practitioner Profile.
Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/CareTeam {?_format=[mime-type]}
PUT [base]/CareTeam/[id] {?_format=[mime-type]}
PATCH [base]/CareTeam/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching CareTeam resources matching a search query using:
GET [base]/CareTeam/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a CareTeam resource using:
GET [base]/CareTeam/[id]
vread interaction fetching a CareTeam resource using:
GET [base]/CareTeam/[id]/_history/vid
history-instance interaction fetching a history of a CareTeam using:
GET [base]/CareTeam/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of CareTeam resources using:
GET [base]/CareTeam/_history{?[parameters]&_format=[mime-type]}
GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerRoleGET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerGET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PatientGET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:RelatedPersonGET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHOULD | role | Token |
GET [base]/CareTeam?role=[system]|[code]
|
| SHALL | patient+status | Reference+Token |
GET [base]/CareTeam?patient=[type]/[id]&status=[system]|[code]
|
| SHOULD | patient+role | Reference+Token |
GET [base]/CareTeam?patient=[type]/[id]&role=[system]|[code]
|
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- For Encounter Diagnosis use the US Core Condition Encounter Diagnosis Profile.
- When
Condition.categoryis "encounter-diagnosis" the encounter, SHOULD be referenced inCondition.encounter.- For Problems and Health Concerns use the US Core Condition Problems and Health Concerns Profile.
- When
Condition.categoryis a "problems-list-item", the `Condition.clinicalStatus SHOULD be present.- There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension,
Condition.onsetDateTime, orCondition.recordedDate.
- Although all three are marked as must support, the server is not required to support all.
- A server SHALL support
Condition.recordedDate.
- A server SHALL support at least one of the assertedDate Extension and
Condition.onsetDateTime. A server may support both, which means they support all three elements.- The client application SHALL support all three elements.
- See the US Core General Guidance page for Searching Using lastUpdated. Updates to
Condition.meta.lastUpdatedSHOULD reflect:
- New problems and health concerns
- Changes in the clinical status or verifications status of problems or health concern
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Condition {?_format=[mime-type]}
PUT [base]/Condition/[id] {?_format=[mime-type]}
PATCH [base]/Condition/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Condition resources matching a search query using:
GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Condition resource using:
GET [base]/Condition/[id]
vread interaction fetching a Condition resource using:
GET [base]/Condition/[id]/_history/vid
history-instance interaction fetching a history of a Condition using:
GET [base]/Condition/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Condition resources using:
GET [base]/Condition/_history{?[parameters]&_format=[mime-type]}
GET [base]/Condition?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/Condition?patient=[type]/[id]
|
| SHOULD | patient+clinical-status | Reference+Token |
GET [base]/Condition?patient=[type]/[id]&clinical-status=[system]|[code]
|
| SHOULD | patient+code | Reference+Token |
GET [base]/Condition?patient=[type]/[id]&code=[system]|[code]
|
| SHALL | patient+category | Reference+Token |
GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]
|
| SHOULD | patient+abatement-date | Reference+Date/DateTime |
GET [base]/Condition?patient=[type]/[id]&abatement-date=[dateTime]
|
| SHOULD | patient+recorded-date | Reference+Date/DateTime |
GET [base]/Condition?patient=[type]/[id]&recorded-date=[dateTime]
|
| SHOULD | patient+_lastUpdated | Reference+Date/DateTime |
GET [base]/Condition?patient=[type]/[id]&_lastUpdated=[dateTime]
|
| SHOULD | patient+asserted-date | Reference+Date/DateTime |
GET [base]/Condition?patient=[type]/[id]&asserted-date=[dateTime]
|
| SHOULD | patient+category+clinical-status | Reference+Token+Token |
GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]&clinical-status=[system]|[code]
|
| SHOULD | patient+onset-date | Reference+Date/DateTime |
GET [base]/Condition?patient=[type]/[id]&onset-date=[dateTime]
|
| SHOULD | patient+category+encounter | Reference+Token+Reference |
GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]&encounter=[type]/[id]
|
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
Conformance Expectation: SHOULD
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Coverage {?_format=[mime-type]}
PUT [base]/Coverage/[id] {?_format=[mime-type]}
PATCH [base]/Coverage/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Coverage resources matching a search query using:
GET [base]/Coverage/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Coverage resource using:
GET [base]/Coverage/[id]
vread interaction fetching a Coverage resource using:
GET [base]/Coverage/[id]/_history/vid
history-instance interaction fetching a history of a Coverage using:
GET [base]/Coverage/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Coverage resources using:
GET [base]/Coverage/_history{?[parameters]&_format=[mime-type]}
GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/Coverage?patient=[type]/[id]
|
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
Medical devices with UDI information SHALL represent the UDI code in
Device.udiCarrier.carrierHRF. All five UDI-PI elements defined in the UDI code may not always be present in every UDI instance. However, those UDI-PI elements present SHALL be represented in the corresponding *US Core Device Profile elements.UDI may not be present in all scenarios, such as historical medical devices, patient-reported implant information, payer-reported devices, or improperly documented implants. If UDI is not present and the manufacturer or model number information is available, they SHOULD be included to support historical reports of medical devices as follows:
medical device data element US Core Device Profile element manufacturer Device.manufacturermodel Device.model
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Device {?_format=[mime-type]}
PUT [base]/Device/[id] {?_format=[mime-type]}
PATCH [base]/Device/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Device resources matching a search query using:
GET [base]/Device/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Device resource using:
GET [base]/Device/[id]
vread interaction fetching a Device resource using:
GET [base]/Device/[id]/_history/vid
history-instance interaction fetching a history of a Device using:
GET [base]/Device/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Device resources using:
GET [base]/Device/_history{?[parameters]&_format=[mime-type]}
GET [base]/Device?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/Device?patient=[type]/[id]
|
| SHOULD | patient+type | Reference+Token |
GET [base]/Device?patient=[type]/[id]&type=[system]|[code]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/Device?patient=[type]/[id]&status=[system]|[code]
|
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
For laboratory result reports use the US Core DiagnosticReport Profile for Laboratory Results Reporting Profile.
Updates to
.meta.lastUpdatedSHOULD reflect:
New laboratory reports
Changes in the status of laboratory reports including events that trigger the same status (e.g., amended → amended).
For imaging and non-laboratory clinical test result reports use the US Core DiagnosticReport Profile for Report and Note Exchange Profile.
Diagnostic imaging results in visual images requiring interpretation and clinical test results/reports may also reference images as part of the report. There is no single approach for accessing imaging studies alongside clinical data using a single authorization flow to give patients and providers access to the images.
The
DiagnosticReport.media.linkelement SHOULD be used to support links to various patient-friendly content, such as jpg images of x-rays (see the DiagnosticReport Chest X-ray Report Example).The
DiagnosticReport.imagingStudyelement SHOULD be used to support exchange with systems that can view DICOM (Digital Imaging and Communications in Medicine) studies, series, and SOP (Service-Object Pair) instances referenced in the [ImagingStudy] resource.Alternatively, systems can use business identifiers such as accession numbers in the
identifierelement to access the source images from external sources.The
DiagnosticRequest.basedOnelement connects the DiagnosticReport to the originating order in the EHR. Systems that initiate the lab order SHOULD use this element when reporting the results.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/DiagnosticReport {?_format=[mime-type]}
PUT [base]/DiagnosticReport/[id] {?_format=[mime-type]}
PATCH [base]/DiagnosticReport/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching DiagnosticReport resources matching a search query using:
GET [base]/DiagnosticReport/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a DiagnosticReport resource using:
GET [base]/DiagnosticReport/[id]
vread interaction fetching a DiagnosticReport resource using:
GET [base]/DiagnosticReport/[id]/_history/vid
history-instance interaction fetching a history of a DiagnosticReport using:
GET [base]/DiagnosticReport/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of DiagnosticReport resources using:
GET [base]/DiagnosticReport/_history{?[parameters]&_format=[mime-type]}
GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:targetcreate
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.
Search Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/DiagnosticReport?patient=[type]/[id]
|
| SHOULD | patient+code+date | Reference+Token+Date/DateTime |
GET [base]/DiagnosticReport?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]
|
| SHOULD | patient+category+_lastUpdated | Reference+Token+Date/DateTime |
GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]&_lastUpdated=[dateTime]
|
| SHALL | patient+category+date | Reference+Token+Date/DateTime |
GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]
|
| SHALL | patient+category | Reference+Token |
GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/DiagnosticReport?patient=[type]/[id]&status=[system]|[code]
|
| SHALL | patient+code | Reference+Token |
GET [base]/DiagnosticReport?patient=[type]/[id]&code=[system]|[code]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
For Advance Directive Information (ADI) documents use the US Core ADI DocumentReference Profile.
For other clinical documents use the US Core DiagnosticReport Profile for Report and Note Exchange.
See the Clinical Notes page for important definitions, requirements, and guidance on creating, using, and sharing Clinical Notes.
The
DocumentReference.typebinding Must Support at a minimum the 10 Common Clinical Notes and may extend to the full US Core DocumentReference Type Value SetThe DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using
DocumentReference.attachment.urlor the content as inline base64 encoded data usingDocumentReference.attachment.data.
Although both are marked as must support, the server system is not required to support an address, and inline base64 encoded data, but SHALL support at least one of these elements.
The client application SHALL support both elements.
The
content.attachment.urlmay refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.If there are multiple
DocumentReference.contentelement repetitions, these SHALL all represent the same document in different format or attachment metadata. The content element SHALL NOT contain different versions of the same content. For version handling use multiple DocumentReferences withDocumentReference.relatesToEvery DocumentReference must have a responsible Organization. The organization responsible for the DocumentReference SHALL be present either in
DocumentReference.custodianor accessible in the Provenance resource targeting the DocumentReference usingProvenance.agent.whoorProvenance.agent.onBehalfOf.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/DocumentReference {?_format=[mime-type]}
PUT [base]/DocumentReference/[id] {?_format=[mime-type]}
PATCH [base]/DocumentReference/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching DocumentReference resources matching a search query using:
GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a DocumentReference resource using:
GET [base]/DocumentReference/[id]
vread interaction fetching a DocumentReference resource using:
GET [base]/DocumentReference/[id]/_history/vid
history-instance interaction fetching a history of a DocumentReference using:
GET [base]/DocumentReference/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of DocumentReference resources using:
GET [base]/DocumentReference/_history{?[parameters]&_format=[mime-type]}
GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | Token |
GET [base]/DocumentReference?_id=[id]
|
| SHALL | patient | Reference |
GET [base]/DocumentReference?patient=[type]/[id]
|
| SHALL | patient+type | Reference+Token |
GET [base]/DocumentReference?patient=[type]/[id]&type=[system]|[code]
|
| SHALL | patient+category+date | Reference+Token+Date/DateTime |
GET [base]/DocumentReference?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]
|
| SHALL | patient+category | Reference+Token |
GET [base]/DocumentReference?patient=[type]/[id]&category=[system]|[code]
|
| SHOULD | patient+type+period | Reference+Token+Date/DateTime |
GET [base]/DocumentReference?patient=[type]/[id]&type=[system]|[code]&period=[dateTime]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/DocumentReference?patient=[type]/[id]&status=[system]|[code]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
FHIR Operations:
$docref
$docref: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]
Conformance Expectation: SHOULD
Resource Specific Documentation:
The Encounter resource can represent a reason using either a code with
Encounter.reasonCode, or a reference withEncounter.reasonReferenceto Condition or other resource.
Although both are marked as must support, the server systems are not required to support both a code and a reference, but they SHALL support at least one of these elements.
The client application SHALL support both elements.
if
Encounter.reasonReferencereferences an Observation, it SHOULD conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)The location address can be represented by either by the Location referenced by
Encounter.location.locationor indirectly through the Organization referenced byEncounter.serviceProvider.
Although both are marked as must support, the server systems are not required to support both
Encounter.location.locationandEncounter.serviceProvider, but they SHALL support at least one of these elements.The client application SHALL support both elements.
If the event facility/location differs from the
Encounter.location, systems SHOULD reference it directly:Servers can use the US Core Interpreter Needed Extension on this profile or the [US Core Patient Profile] to communicate whether a patient needs an interpreter. Although the extension is marked as an Additional USCDI Requirements on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles, but SHALL support the extension on at least one. The certifying Client application SHALL support the extension on both profiles.
- Systems SHOULD designate the patient's preferred language in the
Patient.communication.preferredelement.Updates to
.meta.lastUpdatedSHOULD reflect:
New encounters/visits
Changes in the status of encounters, including events that trigger the same status (e.g., in-progress → in-progress). These status changes correspond to events that can initiate [HL7 V2] ADT messages.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Encounter {?_format=[mime-type]}
PUT [base]/Encounter/[id] {?_format=[mime-type]}
PATCH [base]/Encounter/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Encounter resources matching a search query using:
GET [base]/Encounter/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Encounter resource using:
GET [base]/Encounter/[id]
vread interaction fetching a Encounter resource using:
GET [base]/Encounter/[id]/_history/vid
history-instance interaction fetching a history of a Encounter using:
GET [base]/Encounter/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Encounter resources using:
GET [base]/Encounter/_history{?[parameters]&_format=[mime-type]}
GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | Token |
GET [base]/Encounter?_id=[id]
|
| SHOULD | identifier | Token |
GET [base]/Encounter?identifier=[system]|[code]
|
| SHALL | patient | Reference |
GET [base]/Encounter?patient=[type]/[id]
|
| SHOULD | patient+type | Reference+Token |
GET [base]/Encounter?patient=[type]/[id]&type=[system]|[code]
|
| SHOULD | class+patient | Token+Reference |
GET [base]/Encounter?class=[system]|[code]&patient=[type]/[id]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/Encounter?patient=[type]/[id]&status=[system]|[code]
|
| SHOULD | patient+_lastUpdated | Reference+Date/DateTime |
GET [base]/Encounter?patient=[type]/[id]&_lastUpdated=[dateTime]
|
| SHOULD | patient+location | Reference+Reference |
GET [base]/Encounter?patient=[type]/[id]&location=[type]/[id]
|
| SHALL | date+patient | Date/DateTime+Reference |
GET [base]/Encounter?date=[dateTime]&patient=[type]/[id]
|
| SHOULD | patient+discharge-disposition | Reference+Token |
GET [base]/Encounter?patient=[type]/[id]&discharge-disposition=[system]|[code]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
The Media Resource is a Must Support referenced resource when using the US Core PractitionerRole Profile.
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Endpoint {?_format=[mime-type]}
PUT [base]/Endpoint/[id] {?_format=[mime-type]}
PATCH [base]/Endpoint/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Endpoint resources matching a search query using:
GET [base]/Endpoint/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Endpoint resource using:
GET [base]/Endpoint/[id]
vread interaction fetching a Endpoint resource using:
GET [base]/Endpoint/[id]/_history/vid
history-instance interaction fetching a history of a Endpoint using:
GET [base]/Endpoint/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Endpoint resources using:
GET [base]/Endpoint/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/FamilyMemberHistory {?_format=[mime-type]}
PUT [base]/FamilyMemberHistory/[id] {?_format=[mime-type]}
PATCH [base]/FamilyMemberHistory/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching FamilyMemberHistory resources matching a search query using:
GET [base]/FamilyMemberHistory/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a FamilyMemberHistory resource using:
GET [base]/FamilyMemberHistory/[id]
vread interaction fetching a FamilyMemberHistory resource using:
GET [base]/FamilyMemberHistory/[id]/_history/vid
history-instance interaction fetching a history of a FamilyMemberHistory using:
GET [base]/FamilyMemberHistory/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of FamilyMemberHistory resources using:
GET [base]/FamilyMemberHistory/_history{?[parameters]&_format=[mime-type]}
GET [base]/FamilyMemberHistory?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/FamilyMemberHistory?patient=[type]/[id]
|
| SHOULD | patient+code | Reference+Token |
GET [base]/FamilyMemberHistory?patient=[type]/[id]&code=[system]|[code]
|
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Although both
Goal.startDateandGoal.target.dueDateare marked as must support, the server system is not required to support both, but SHALL support at least one of these elements. The client application SHALL support both elements.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Goal {?_format=[mime-type]}
PUT [base]/Goal/[id] {?_format=[mime-type]}
PATCH [base]/Goal/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Goal resources matching a search query using:
GET [base]/Goal/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Goal resource using:
GET [base]/Goal/[id]
vread interaction fetching a Goal resource using:
GET [base]/Goal/[id]/_history/vid
history-instance interaction fetching a history of a Goal using:
GET [base]/Goal/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Goal resources using:
GET [base]/Goal/_history{?[parameters]&_format=[mime-type]}
GET [base]/Goal?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/Goal?patient=[type]/[id]
|
| SHOULD | patient+description | Reference+Token |
GET [base]/Goal?patient=[type]/[id]&description=[system]|[code]
|
| SHOULD | patient+target-date | Reference+Date/DateTime |
GET [base]/Goal?patient=[type]/[id]&target-date=[dateTime]
|
| SHOULD | patient+lifecycle-status | Reference+Token |
GET [base]/Goal?patient=[type]/[id]&lifecycle-status=[system]|[code]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
Conformance Expectation: MAY
Resource Specific Documentation:
The HealthcareService Resource is a referenced resource when using the US Core PractitionerRole Profile and subject to constraint us-core-13: "SHALL have a practitioner, an organization, a healthcare service, or a location."
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/HealthcareService {?_format=[mime-type]}
PUT [base]/HealthcareService/[id] {?_format=[mime-type]}
PATCH [base]/HealthcareService/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching HealthcareService resources matching a search query using:
GET [base]/HealthcareService/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a HealthcareService resource using:
GET [base]/HealthcareService/[id]
vread interaction fetching a HealthcareService resource using:
GET [base]/HealthcareService/[id]/_history/vid
history-instance interaction fetching a history of a HealthcareService using:
GET [base]/HealthcareService/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of HealthcareService resources using:
GET [base]/HealthcareService/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Based upon the ASTP U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes SHOULD be supported as an additional code.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Immunization {?_format=[mime-type]}
PUT [base]/Immunization/[id] {?_format=[mime-type]}
PATCH [base]/Immunization/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Immunization resources matching a search query using:
GET [base]/Immunization/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Immunization resource using:
GET [base]/Immunization/[id]
vread interaction fetching a Immunization resource using:
GET [base]/Immunization/[id]/_history/vid
history-instance interaction fetching a history of a Immunization using:
GET [base]/Immunization/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Immunization resources using:
GET [base]/Immunization/_history{?[parameters]&_format=[mime-type]}
GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/Immunization?patient=[type]/[id]
|
| SHOULD | patient+date | Reference+Date/DateTime |
GET [base]/Immunization?patient=[type]/[id]&date=[dateTime]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/Immunization?patient=[type]/[id]&status=[system]|[code]
|
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Location.address.lineandLocation.address.city.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Location {?_format=[mime-type]}
PUT [base]/Location/[id] {?_format=[mime-type]}
PATCH [base]/Location/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Location resources matching a search query using:
GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Location resource using:
GET [base]/Location/[id]
vread interaction fetching a Location resource using:
GET [base]/Location/[id]/_history/vid
history-instance interaction fetching a history of a Location using:
GET [base]/Location/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Location resources using:
GET [base]/Location/_history{?[parameters]&_format=[mime-type]}
Search Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | address | String |
GET [base]/Location?address=[address]
|
| SHOULD | address-city | String |
GET [base]/Location?address-city=[address-city]
|
| SHOULD | address-postalcode | String |
GET [base]/Location?address-postalcode=[address-postalcode]
|
| SHOULD | address-state | String |
GET [base]/Location?address-state=[address-state]
|
| SHALL | name | String |
GET [base]/Location?name=[name]
|
Conformance Expectation: SHOULD
Resource Specific Documentation:
The Media Resource is a Must Support referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Media {?_format=[mime-type]}
PUT [base]/Media/[id] {?_format=[mime-type]}
PATCH [base]/Media/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Media resources matching a search query using:
GET [base]/Media/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Media resource using:
GET [base]/Media/[id]
vread interaction fetching a Media resource using:
GET [base]/Media/[id]/_history/vid
history-instance interaction fetching a history of a Media using:
GET [base]/Media/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Media resources using:
GET [base]/Media/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
- The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ SHALL be supported.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Medication {?_format=[mime-type]}
PUT [base]/Medication/[id] {?_format=[mime-type]}
PATCH [base]/Medication/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Medication resources matching a search query using:
GET [base]/Medication/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Medication resource using:
GET [base]/Medication/[id]
vread interaction fetching a Medication resource using:
GET [base]/Medication/[id]/_history/vid
history-instance interaction fetching a history of a Medication using:
GET [base]/Medication/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Medication resources using:
GET [base]/Medication/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
This Profile can represent a medication using a code or reference a Medication resource.
The Server systems are not required to support both a code and a reference, but SHALL support at least one of these methods.
The Client application SHALL support all methods.
Systems that primarily rely on NDC codes instead of RxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.
When referencing a Medication resource in
.medicationReference, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server SHALL support the_includeparameter for searching this element.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/MedicationDispense {?_format=[mime-type]}
PUT [base]/MedicationDispense/[id] {?_format=[mime-type]}
PATCH [base]/MedicationDispense/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching MedicationDispense resources matching a search query using:
GET [base]/MedicationDispense/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a MedicationDispense resource using:
GET [base]/MedicationDispense/[id]
vread interaction fetching a MedicationDispense resource using:
GET [base]/MedicationDispense/[id]/_history/vid
history-instance interaction fetching a history of a MedicationDispense using:
GET [base]/MedicationDispense/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of MedicationDispense resources using:
GET [base]/MedicationDispense/_history{?[parameters]&_format=[mime-type]}
GET [base]/MedicationDispense?[parameter=value]&_include=MedicationDispense:medicationGET [base]/MedicationDispense?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/MedicationDispense?patient=[type]/[id]
|
| SHOULD | patient+status+type | Reference+Token+Token |
GET [base]/MedicationDispense?patient=[type]/[id]&status=[system]|[code]&type=[system]|[code]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/MedicationDispense?patient=[type]/[id]&status=[system]|[code]
|
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
This Profile can represent a medication using a code or reference a Medication resource.
- The Server systems are not required to support both a code and a reference, but SHALL support at least one of these methods.
- The Client application SHALL support all methods.
- Systems that primarily rely on NDC codes instead of RxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.
- When referencing a Medication resource in
.medicationReference, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server SHALL support the_includeparameter for searching this element.The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in
MedicationRequest.reportedBoolean, or a reference usingMedicationRequest.reportedReferenceto Practitioner or other resource.
- Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but SHALL choose to support at least one of these elements.
- The client application SHALL support both elements.
When recording “self-prescribed” medication, requester SHOULD be used to indicate the Patient or RelatedPerson as the prescriber. (See the Medication List section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.)
The MedicationRequest resource can communicate the reason or indication for treatment using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference.
- Although both
MedicationRequest.reasonCodeandMedicationRequest.reasonReferenceare marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.- when using MedicationRequest.reasonReference:
- Servers SHALL support at least one target resource in
MedicationRequest.reasonReference. Clients SHALL support all target resources.- The referenced resources SHOULD be a US Core Profile as documented in Referencing US Core Profiles.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/MedicationRequest {?_format=[mime-type]}
PUT [base]/MedicationRequest/[id] {?_format=[mime-type]}
PATCH [base]/MedicationRequest/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching MedicationRequest resources matching a search query using:
GET [base]/MedicationRequest/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a MedicationRequest resource using:
GET [base]/MedicationRequest/[id]
vread interaction fetching a MedicationRequest resource using:
GET [base]/MedicationRequest/[id]/_history/vid
history-instance interaction fetching a history of a MedicationRequest using:
GET [base]/MedicationRequest/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of MedicationRequest resources using:
GET [base]/MedicationRequest/_history{?[parameters]&_format=[mime-type]}
GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medicationGET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHOULD | patient+intent+authoredon | Reference+Token+Date/DateTime |
GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&authoredon=[dateTime]
|
| SHOULD | patient+intent+encounter | Reference+Token+Reference |
GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&encounter=[type]/[id]
|
| SHALL | patient+intent | Reference+Token |
GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]
|
| SHALL | patient+intent+status | Reference+Token+Token |
GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&status=[system]|[code]
|
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Systems SHOULD support
Observation.effectivePeriodto accurately represent tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).- An Observation without a value, SHALL include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it
- Systems that never provide an observation without a value are not required to support
Observation.dataAbsentReason- An
Observation.componentwithout a value, SHALL include a reason why the data is absent.
- Systems that never provide an component observation without a component value are not required to support
Observation.component.dataAbsentReason.- There are multiple Observation profiles. Refer to the specific profile page for profile specific conformance rules and guidance
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Observation {?_format=[mime-type]}
PUT [base]/Observation/[id] {?_format=[mime-type]}
PATCH [base]/Observation/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Observation resources matching a search query using:
GET [base]/Observation/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Observation resource using:
GET [base]/Observation/[id]
vread interaction fetching a Observation resource using:
GET [base]/Observation/[id]/_history/vid
history-instance interaction fetching a history of a Observation using:
GET [base]/Observation/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Observation resources using:
GET [base]/Observation/_history{?[parameters]&_format=[mime-type]}
GET [base]/Observation?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHOULD | patient+code+date | Reference+Token+Date/DateTime |
GET [base]/Observation?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]
|
| SHOULD | patient+category+_lastUpdated | Reference+Token+Date/DateTime |
GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&_lastUpdated=[dateTime]
|
| SHALL | patient+category+date | Reference+Token+Date/DateTime |
GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]
|
| SHALL | patient+category | Reference+Token |
GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]
|
| SHOULD | patient+category+status | Reference+Token+Token |
GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]
|
| SHALL | patient+code | Reference+Token |
GET [base]/Observation?patient=[type]/[id]&code=[system]|[code]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
A server SHALL document the types of changes that can be detected using this parameter.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) and the National Association of Insurance Commissioners NAIC Company code (sometimes called "NAIC Number" or "cocode") for
Organization.Identifier.- Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Organization.address.lineandOrganization.address.city.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Organization {?_format=[mime-type]}
PUT [base]/Organization/[id] {?_format=[mime-type]}
PATCH [base]/Organization/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Organization resources matching a search query using:
GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Organization resource using:
GET [base]/Organization/[id]
vread interaction fetching a Organization resource using:
GET [base]/Organization/[id]/_history/vid
history-instance interaction fetching a history of a Organization using:
GET [base]/Organization/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Organization resources using:
GET [base]/Organization/_history{?[parameters]&_format=[mime-type]}
Search Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | address | String |
GET [base]/Organization?address=[address]
|
| SHALL | name | String |
GET [base]/Organization?name=[name]
|
Conformance Expectation: SHOULD
Resource Specific Documentation:
- The Patient's Social Security Numbers SHOULD NOT be used as a patient identifier in
Patient.identifier.value.- The Complex Extensions for Race and Ethnicity allow for one or more codes of which: Must Support at least one category code from the OMB Race and Ethnicity Category Value Sets that draw from the Race & Ethnicity - CDC (CDCREC] code system.
- MAY include additional codes from the detailed ethnicity and detailed race value sets drawn from the Race & Ethnicity - CDC (CDCREC) code system
- SHALL include a text description
- Although Patient.deceased[x] is marked as Additional USCDI Requirement, certifying systems are not required to support both choices, but SHALL support at least
Patient.deceasedDateTime.- Servers can use the US Core Interpreter Needed Extension on this profile or the US Core Encounter Profile to communicate whether a patient needs an interpreter. Although the extension is marked as an Additional USCDI Requirement on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles but SHALL support the extension on at least one. The certifying Client application SHALL support the extension on both profiles.
- Systems SHOULD designate the patient's preferred language in the
Patient.communication.preferredelement.- Certifying systems SHALL and non-certifying systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Patient.address.lineandPatient.address.cityfor new and updated records.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Patient {?_format=[mime-type]}
PUT [base]/Patient/[id] {?_format=[mime-type]}
PATCH [base]/Patient/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Patient resources matching a search query using:
GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Patient resource using:
GET [base]/Patient/[id]
vread interaction fetching a Patient resource using:
GET [base]/Patient/[id]/_history/vid
history-instance interaction fetching a history of a Patient using:
GET [base]/Patient/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Patient resources using:
GET [base]/Patient/_history{?[parameters]&_format=[mime-type]}
GET [base]/Patient?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | Token |
GET [base]/Patient?_id=[id]
|
| SHALL | identifier | Token |
GET [base]/Patient?identifier=[system]|[code]
|
| SHALL | name | String |
GET [base]/Patient?name=[name]
|
| SHALL | birthdate+name | Date/DateTime+String |
GET [base]/Patient?birthdate=[dateTime]&name=[name]
|
| SHOULD | birthdate+family | Date/DateTime+String |
GET [base]/Patient?birthdate=[dateTime]&family=[family]
|
| SHOULD | death-date+family | Date/DateTime+String |
GET [base]/Patient?death-date=[dateTime]&family=[family]
|
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
A client SHALL provide a value precise to the day.
A server SHALL support a value a value precise to the day.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.
- Although Practitioner.address is marked as Must Support, the server system is not required to support it if they support the US Core PractitionerRole Profile, but SHALL support it if they do not support the US Core PractitionerRole Profile. The client application SHALL support both.
To balance the privacy of healthcare workers with the patient's right to access information. Only professional/work contact information about the practitioner SHOULD be available to the patient (such as a work address or office telephone number).
Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
Practitioner.address.lineandPractitioner.address.city.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Practitioner {?_format=[mime-type]}
PUT [base]/Practitioner/[id] {?_format=[mime-type]}
PATCH [base]/Practitioner/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Practitioner resources matching a search query using:
GET [base]/Practitioner/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Practitioner resource using:
GET [base]/Practitioner/[id]
vread interaction fetching a Practitioner resource using:
GET [base]/Practitioner/[id]/_history/vid
history-instance interaction fetching a history of a Practitioner using:
GET [base]/Practitioner/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Practitioner resources using:
GET [base]/Practitioner/_history{?[parameters]&_format=[mime-type]}
Search Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHOULD | _id | Token |
GET [base]/Practitioner?_id=[id]
|
| SHALL | identifier | Token |
GET [base]/Practitioner?identifier=[system]|[code]
|
| SHALL | name | String |
GET [base]/Practitioner?name=[name]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile SHOULD be used as the default profile if referenced by another US Core profile.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/PractitionerRole {?_format=[mime-type]}
PUT [base]/PractitionerRole/[id] {?_format=[mime-type]}
PATCH [base]/PractitionerRole/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching PractitionerRole resources matching a search query using:
GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a PractitionerRole resource using:
GET [base]/PractitionerRole/[id]
vread interaction fetching a PractitionerRole resource using:
GET [base]/PractitionerRole/[id]/_history/vid
history-instance interaction fetching a history of a PractitionerRole using:
GET [base]/PractitionerRole/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of PractitionerRole resources using:
GET [base]/PractitionerRole/_history{?[parameters]&_format=[mime-type]}
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpointGET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitionerSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | practitioner | Reference |
GET [base]/PractitionerRole?practitioner=[type]/[id]
|
| SHALL | specialty | Token |
GET [base]/PractitionerRole?specialty=[system]|[code]
|
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.
- Only LOINC concepts that reflect actual procedures SHOULD be used
A procedure including an implantable device SHOULD use
Procedure.focalDevicewith a reference to the US Core Implantable Device Profile.Servers and Clients SHALL support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through
Procedure.basedOnlinking the Procedure to the US Core ServiceRequest Profile that includes eitherServiceRequest.reasonCodeorServiceRequest.reasonReference. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile'sProcedure.reasonCodeorProcedure.reasonReference. Depending on the procedure being documented, a server will select the appropriate Profile to use.
Although both
Procedure.reasonCodeandProcedure.reasonReferenceare marked as Additional USCDI Requirements. The certifying server system is not required to support both but SHALL support at least one of these elements. The certifying client application SHALL support both elements.
when using
Procedure.reasonReference:
Servers SHALL support at least one target resource in
Procedure.reasonReference. Clients SHALL support all target resources .The referenced resources SHOULD be a US Core Profile.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Procedure {?_format=[mime-type]}
PUT [base]/Procedure/[id] {?_format=[mime-type]}
PATCH [base]/Procedure/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Procedure resources matching a search query using:
GET [base]/Procedure/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Procedure resource using:
GET [base]/Procedure/[id]
vread interaction fetching a Procedure resource using:
GET [base]/Procedure/[id]/_history/vid
history-instance interaction fetching a history of a Procedure using:
GET [base]/Procedure/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Procedure resources using:
GET [base]/Procedure/_history{?[parameters]&_format=[mime-type]}
GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | patient | Reference |
GET [base]/Procedure?patient=[type]/[id]
|
| SHOULD | patient+code+date | Reference+Token+Date/DateTime |
GET [base]/Procedure?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]
|
| SHALL | patient+date | Reference+Date/DateTime |
GET [base]/Procedure?patient=[type]/[id]&date=[dateTime]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/Procedure?patient=[type]/[id]&status=[system]|[code]
|
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
The US Core Provenance resource SHALL be supported for these US Core resources:
AllergyIntolerance
CarePlan
CareTeam
Condition
Coverage
Device
DiagnosticReport
DocumentReference
Encounter
Goal
Immunization
MedicationDispense
MedicationRequest
Observation
Patient
Procedure
QuestionnaireResponse
RelatedPerson
ServiceRequest
If a system receives a provider in
Provenance.agent.whoas 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.Systems that need to know the activity has occurred SHOULD populate the activity.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Provenance {?_format=[mime-type]}
PUT [base]/Provenance/[id] {?_format=[mime-type]}
PATCH [base]/Provenance/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Provenance resources matching a search query using:
GET [base]/Provenance/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Provenance resource using:
GET [base]/Provenance/[id]
vread interaction fetching a Provenance resource using:
GET [base]/Provenance/[id]/_history/vid
history-instance interaction fetching a history of a Provenance using:
GET [base]/Provenance/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Provenance resources using:
GET [base]/Provenance/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
US Core defines two ways to represent the questions and responses to screening and assessment instruments:
Observation: US Core Observation Screening Assessment Profile
Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile
US Core Servers SHALL support US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Questionnaire {?_format=[mime-type]}
PUT [base]/Questionnaire/[id] {?_format=[mime-type]}
PATCH [base]/Questionnaire/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Questionnaire resources matching a search query using:
GET [base]/Questionnaire/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Questionnaire resource using:
GET [base]/Questionnaire/[id]
vread interaction fetching a Questionnaire resource using:
GET [base]/Questionnaire/[id]/_history/vid
history-instance interaction fetching a history of a Questionnaire using:
GET [base]/Questionnaire/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Questionnaire resources using:
GET [base]/Questionnaire/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
US Core defines two ways to represent the questions and responses to screening and assessment instruments:
Observation: US Core Observation Screening Assessment Profile
Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile
US Core Servers SHALL support US Core Observation Screening Assessment Profile and SHOULD support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/QuestionnaireResponse {?_format=[mime-type]}
PUT [base]/QuestionnaireResponse/[id] {?_format=[mime-type]}
PATCH [base]/QuestionnaireResponse/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching QuestionnaireResponse resources matching a search query using:
GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a QuestionnaireResponse resource using:
GET [base]/QuestionnaireResponse/[id]
vread interaction fetching a QuestionnaireResponse resource using:
GET [base]/QuestionnaireResponse/[id]/_history/vid
history-instance interaction fetching a history of a QuestionnaireResponse using:
GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of QuestionnaireResponse resources using:
GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}
GET [base]/QuestionnaireResponse?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | Token |
GET [base]/QuestionnaireResponse?_id=[id]
|
| SHALL | patient | Reference |
GET [base]/QuestionnaireResponse?patient=[type]/[id]
|
| SHOULD | patient+questionnaire | Reference+Reference |
GET [base]/QuestionnaireResponse?patient=[type]/[id]&questionnaire=[type]/[id]
|
| SHOULD | patient+authored | Reference+Date/DateTime |
GET [base]/QuestionnaireResponse?patient=[type]/[id]&authored=[dateTime]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/QuestionnaireResponse?patient=[type]/[id]&status=[system]|[code]
|
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for
RelatedPerson.address.lineandRelatedPerson.address.city.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/RelatedPerson {?_format=[mime-type]}
PUT [base]/RelatedPerson/[id] {?_format=[mime-type]}
PATCH [base]/RelatedPerson/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching RelatedPerson resources matching a search query using:
GET [base]/RelatedPerson/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a RelatedPerson resource using:
GET [base]/RelatedPerson/[id]
vread interaction fetching a RelatedPerson resource using:
GET [base]/RelatedPerson/[id]/_history/vid
history-instance interaction fetching a history of a RelatedPerson using:
GET [base]/RelatedPerson/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of RelatedPerson resources using:
GET [base]/RelatedPerson/_history{?[parameters]&_format=[mime-type]}
GET [base]/RelatedPerson?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | Token |
GET [base]/RelatedPerson?_id=[id]
|
| SHOULD | name | String |
GET [base]/RelatedPerson?name=[name]
|
| SHOULD | patient | Reference |
GET [base]/RelatedPerson?patient=[type]/[id]
|
| SHOULD | patient+name | Reference+String |
GET [base]/RelatedPerson?patient=[type]/[id]&name=[name]
|
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
The Must Support
ServiceRequest.categoryis bound, at a minimum, to the US Core ServiceRequest Category Codes, and other category codes can be used. API consumers can query by category when accessing patient information. For the USCDI Laboratory Order, Imaging Order, Clinical Test Order, and Procedure Order Data Elements, implementers SHOULD use the corresponding category codes listed in the table on the US Core ServiceRequest Profile page. For example, laboratory orders would have the category code "108252007" (Laboratory procedure).The
ServiceRequest.codevalue set is broad to accommodate a wide variety of use cases and SHOULD be constrained to a subset for a particular use case or domain. These value sets contain concepts that span many use cases and are not bound to any USCDI Data Element. However, the table on the US Core ServiceRequest Profile page identifies additional value set bindings for the USCDI Laboratory Order, Imaging Order and Clinical Test Order Data Elements. Implementers SHOULD conform to the binding strengths for each USCDI Order context listed in the table. For example, laboratory orders are extensibly bound to the LOINC Common Laboratory Orders Value Set. Note that the USCDI Class Procedure Order Data Element has no additional binding.Servers and Clients SHALL support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through
Procedure.basedOnlinking the Procedure to the US Core ServiceRequest Profile that includes eitherServiceRequest.reasonCodeorServiceRequest.reasonReference. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile'sProcedure.reasonCodeorProcedure.reasonReference. Depending on the procedure being documented, a server will select the appropriate Profile to use.
Although both
ServiceRequest.reasonCodeandServiceRequest.reasonReferenceare marked as Additional USCDI Requirements, the certifying server system is not required to support both, but SHALL support at least one of these elements. The certifying client application SHALL support both elements.
when using
ServiceRequest.reasonReference:
Servers SHALL support at least one target resource in
ServiceRequest.reasonReference. Clients SHALL support all target resources.The referenced resources SHOULD be a US Core Profile as documented in Referencing US Core Profiles.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/ServiceRequest {?_format=[mime-type]}
PUT [base]/ServiceRequest/[id] {?_format=[mime-type]}
PATCH [base]/ServiceRequest/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching ServiceRequest resources matching a search query using:
GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a ServiceRequest resource using:
GET [base]/ServiceRequest/[id]
vread interaction fetching a ServiceRequest resource using:
GET [base]/ServiceRequest/[id]/_history/vid
history-instance interaction fetching a history of a ServiceRequest using:
GET [base]/ServiceRequest/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of ServiceRequest resources using:
GET [base]/ServiceRequest/_history{?[parameters]&_format=[mime-type]}
GET [base]/ServiceRequest?[parameter=value]&_revinclude=Provenance:targetSearch Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | Token |
GET [base]/ServiceRequest?_id=[id]
|
| SHALL | patient | Reference |
GET [base]/ServiceRequest?patient=[type]/[id]
|
| SHOULD | patient+code+authored | Reference+Token+Date/DateTime |
GET [base]/ServiceRequest?patient=[type]/[id]&code=[system]|[code]&authored=[dateTime]
|
| SHALL | patient+category+authored | Reference+Token+Date/DateTime |
GET [base]/ServiceRequest?patient=[type]/[id]&category=[system]|[code]&authored=[dateTime]
|
| SHALL | patient+category | Reference+Token |
GET [base]/ServiceRequest?patient=[type]/[id]&category=[system]|[code]
|
| SHOULD | patient+status | Reference+Token |
GET [base]/ServiceRequest?patient=[type]/[id]&status=[system]|[code]
|
| SHALL | patient+code | Reference+Token |
GET [base]/ServiceRequest?patient=[type]/[id]&code=[system]|[code]
|
A client SHALL provide a value precise to the second + time offset.
A server SHALL support a value precise to the second + time offset.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
The client SHALL provide at least a id value and MAY provide both the Type and id values.
The server SHALL support both.
The client SHALL provide at least a code value and MAY provide both the system and code values.
The server SHALL support both.
Conformance Expectation: SHOULD
Resource Specific Documentation:
- Although both
Specimen.identifierandSpecimen.accessionIdentifierare marked as Must Support, the server system is not required to support both, but SHALL support at least one of these elements. The client application SHALL support both.
Supported Profiles:
FHIR RESTful Interactions
Summary:
Modify Criteria Details:
POST [base]/Specimen {?_format=[mime-type]}
PUT [base]/Specimen/[id] {?_format=[mime-type]}
PATCH [base]/Specimen/[id] {?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria Details:
search-type interaction fetching Specimen resources matching a search query using:
GET [base]/Specimen/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Specimen resource using:
GET [base]/Specimen/[id]
vread interaction fetching a Specimen resource using:
GET [base]/Specimen/[id]/_history/vid
history-instance interaction fetching a history of a Specimen using:
GET [base]/Specimen/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Specimen resources using:
GET [base]/Specimen/_history{?[parameters]&_format=[mime-type]}
Search Parameter Requirements (When Used Alone or in Combination):
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | Token |
GET [base]/Specimen?_id=[id]
|
| SHOULD | patient | Reference |
GET [base]/Specimen?patient=[type]/[id]
|
Conformance Expectation: SHOULD
FHIR Operations:
$expand
$expand:If a server supports DocumentReference for creating, using, and sharing clinical notes, it SHOULD also support the
contextandcontextdirectionparameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server.
{
"resourceType": "CapabilityStatement",
"id": "us-core-client",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cgp"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
}
]
}
}
],
"url": "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client",
"version": "9.0.0",
"name": "UsCoreClientCapabilityStatement",
"title": "US Core Client CapabilityStatement",
"status": "active",
"experimental": false,
"date": "2025-12-19T19:16:08.871976-08:00",
"publisher": "HL7 International / Cross-Group Projects",
"contact": [
{
"name": "HL7 International / Cross-Group Projects",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/cgp"
},
{
"system": "email",
"value": "cgp@lists.HL7.org"
}
]
}
],
"description": "This 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](CapabilityStatement-us-core-server.html). 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.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"json",
"xml"
],
"_format": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"patchFormat": [
"application/json-patch+json"
],
"_patchFormat": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"implementationGuide": [
"http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch"
],
"_implementationGuide": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"rest": [
{
"mode": "client",
"documentation": "The US Core Client **SHALL**:\n\n\n1. 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.\n1. Follow the requirements documented in the [General Requirements](general-requirements.html) and [Must Support](must-support.html) pages\n\n\n**NOTE**: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:\n\n\n- `multipleAnd`\n- `multipleOr`\n- `comparator`\n- `modifier`\n- `chain`\n\n\nThey **SHALL NOT** be interpreted as search parameters for search. Servers and Clients **SHOULD** use the standard FHIR SearchParameters.",
"security": {
"description": "1. See the [General Security Considerations](security.html) section for requirements and recommendations."
},
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "clinical-status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "AllergyIntolerance",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-allergyintolerance.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core AllergyIntolerance Profile"
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "clinical-status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "status"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "CarePlan",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-careplan.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core CarePlan Profile"
}
]
}
],
"documentation": "* Additional considerations for systems aligning with [HL7 Consolidated (C-CDA)](http://www.hl7.org/implement/standards/product_brief.cfm?product_id=492) Care Plan requirements:\n\n - US Core Goal **SHOULD** be present in CarePlan.goal\n\n - US Core Condition **SHOULD** be present in\nCarePlan.addresses\n\n - Assessment and Plan **MAY** be included as narrative\ntext",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "role"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "CareTeam",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-careteam.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core CareTeam Profile"
}
]
}
],
"documentation": "* In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:\n\n 1. US Core Practitioner Profile\n\n 1. US Core PractitionerRole Profile\n\n 1. US Core Patient Profile\n\n 1. US Core RelatedPerson Profile\n\n* Although *both* US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references, but **SHALL** support *at least* one of them.\n* The client application **SHALL** support all four profile references.\n* Bacause the *US Core PractitionerRole Profile* supplies the provider's location and contact information and a reference to the Practitioner, server systems **SHOULD** reference it instead of the *US Core Practitioner Profile*.\n* Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile **SHALL** provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchInclude": [
"CareTeam:participant:PractitionerRole",
"CareTeam:participant:Practitioner",
"CareTeam:participant:Patient",
"CareTeam:participant:RelatedPerson"
],
"_searchInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "role",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-role|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "clinical-status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "abatement-date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "recorded-date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "_lastUpdated"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "asserted-date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "clinical-status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "onset-date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "encounter"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Condition",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-condition-encounter-diagnosis.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Condition Encounter Diagnosis Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-condition-problems-health-concerns.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Condition Problems and Health Concerns Profile"
}
]
}
],
"documentation": "* For Encounter Diagnosis use the *US Core Condition Encounter Diagnosis Profile*.\n * When `Condition.category` is \"encounter-diagnosis\" the encounter, **SHOULD** be referenced in `Condition.encounter`.\n* For Problems and Health Concerns use the *US Core Condition Problems and Health Concerns Profile*.\n * When `Condition.category` is a \"problems-list-item\", the `Condition.clinicalStatus **SHOULD** be present.\n * There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, `Condition.onsetDateTime`, or `Condition.recordedDate`.\n * Although all three are marked as must support, the server is not required to support all.\n \t* A server **SHALL** support `Condition.recordedDate`.\n * A server **SHALL** support at least one of the assertedDate Extension and `Condition.onsetDateTime`. A server may support both, which means they support all three elements.\n * The client application **SHALL** support all three elements.\n * See the US Core General Guidance page for [Searching Using lastUpdated](general-guidance.html#searching-using-lastupdated). Updates to `Condition.meta.lastUpdated` **SHOULD** reflect:\n * New problems and health concerns\n * Changes in the clinical status or verifications status of problems or health concern",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "abatement-date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-abatement-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "asserted-date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-asserted-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "clinical-status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "code",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "encounter",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-encounter|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "onset-date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "recorded-date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-recorded-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-lastupdated|9.0.0",
"type": "date",
"documentation": "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Coverage",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-coverage.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Coverage Profile"
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-coverage-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "type"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Device",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-device|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-device.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Device Profile"
}
]
}
],
"documentation": "* Medical devices with UDI information **SHALL** represent the UDI code in `Device.udiCarrier.carrierHRF`. All five UDI-PI elements defined in the UDI code may not always be present in every UDI instance. However, those UDI-PI elements present **SHALL** be represented in the corresponding *US Core Device Profile elements.\n\n\n\n UDI may not be present in all scenarios, such as\nhistorical medical devices, patient-reported implant information, payer-reported devices, or improperly documented implants. If UDI is not present and the manufacturer or model number information is available, they **SHOULD** be included to support historical reports of medical devices as follows:\n\n >|medical device data element|US Core Device Profile element|\n >|---|---|\n >|manufacturer|`Device.manufacturer`|\n >|model|`Device.model`|",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "type",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-type|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "_lastUpdated"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "DiagnosticReport",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-diagnosticreport-note.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core DiagnosticReport Profile for Report and Note exchange"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-diagnosticreport-lab.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core DiagnosticReport Profile for Laboratory Results Reporting"
}
]
}
],
"documentation": "* For laboratory result reports use the *US Core DiagnosticReport Profile for Laboratory Results Reporting Profile*.\n\n * Updates to `.meta.lastUpdated` **SHOULD** reflect:\n\n * New laboratory reports\n\n * Changes in the status of laboratory reports including\nevents that trigger the same status (e.g., amended → amended).\n* For imaging and non-laboratory clinical test result reports use the *US Core DiagnosticReport Profile for Report and Note Exchange Profile*.\n\n * Diagnostic imaging results in visual images requiring\ninterpretation and clinical test results/reports may also reference images as part of the report. There is no single approach for accessing imaging studies alongside clinical data using a single authorization flow to give patients and providers access to the images.\n\n * The `DiagnosticReport.media.link` element **SHOULD**\nbe used to support links to various patient-friendly content, such as jpg images of x-rays (see the DiagnosticReport Chest X-ray Report Example).\n\n * The `DiagnosticReport.imagingStudy` element **SHOULD**\nbe used to support exchange with systems that can view DICOM (Digital Imaging and Communications in Medicine) studies, series, and SOP (Service-Object Pair) instances referenced in the [ImagingStudy] resource.\n\n * Alternatively, systems can use business identifiers\nsuch as accession numbers in the `identifier` element to access the source images from external sources.\n* The `DiagnosticRequest.basedOn` element connects the DiagnosticReport to the originating order in the EHR. Systems that initiate the lab order **SHOULD** use this element when reporting the results.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "create",
"documentation": "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**."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "code",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-lastupdated|9.0.0",
"type": "date",
"documentation": "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "type"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "type"
},
{
"url": "required",
"valueString": "period"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "DocumentReference",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-adi-documentreference|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-documentreference.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core DocumentReference Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-adi-documentreference.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core ADI DocumentReference Profile"
}
]
}
],
"documentation": "* For Advance Directive Information (ADI) documents use the *US Core ADI DocumentReference Profile*.\n* For other clinical documents use the *US Core DiagnosticReport Profile for Report and Note Exchange*.\n\n * See the [Clinical Notes](clinical-notes.html) page for\nimportant definitions, requirements, and guidance on creating, using, and sharing Clinical Notes.\n\n * The `DocumentReference.type` binding Must Support at\na minimum the [10 Common Clinical Notes](ValueSet-us-core-clinical-note-type.html) and may extend to the full US Core DocumentReference Type Value Set\n* The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using `DocumentReference.attachment.url` or the content as inline base64 encoded data using `DocumentReference.attachment.data`.\n\n * Although both are marked as must support, the server\nsystem is not required to support an address, and inline base64 encoded data, but **SHALL** support at least one of these elements.\n\n * The client application **SHALL** support both\nelements.\n\n * The `content.attachment.url` may refer to a FHIR\nBinary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.\n\n * If there are multiple `DocumentReference.content`\nelement repetitions, these **SHALL** all represent the same document in different format or attachment metadata. The content element **SHALL NOT** contain different versions of the same content. For version handling use multiple DocumentReferences with `DocumentReference.relatesTo`\n* Every DocumentReference must have a responsible Organization. The organization responsible for the DocumentReference **SHALL** be present either in `DocumentReference.custodian` or accessible in the Provenance resource targeting the DocumentReference using `Provenance.agent.who` or `Provenance.agent.onBehalfOf`.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "period",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "type",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
],
"operation": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "docref",
"definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref|9.0.0",
"_definition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "OperationDefinition-docref.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "$docref"
}
]
},
"documentation": "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.\n\n\n`GET [base]/DocumentReference/$docref?patient=[id]`"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "type"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "class"
},
{
"url": "required",
"valueString": "patient"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "_lastUpdated"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "location"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "date"
},
{
"url": "required",
"valueString": "patient"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "discharge-disposition"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Encounter",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-encounter.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Encounter Profile"
}
]
}
],
"documentation": "* The Encounter resource can represent a reason using either a code with `Encounter.reasonCode`, or a reference with `Encounter.reasonReference` to Condition or other resource.\n\n * Although both are marked as must support, the server\nsystems are not required to support both a code and a reference, but they **SHALL** support *at least one* of these elements.\n\n * The client application **SHALL** support both elements.\n\n * if `Encounter.reasonReference` references an\nObservation, it **SHOULD** conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)\n\n\n* The location address can be represented by either by the Location referenced by `Encounter.location.location` or indirectly through the Organization referenced by `Encounter.serviceProvider`.\n\n * Although both are marked as must support, the server\nsystems are not required to support both `Encounter.location.location` and `Encounter.serviceProvider`, but they **SHALL** support *at least one* of these elements.\n\n * The client application **SHALL** support both elements.\n\n* If the event facility/location differs from the `Encounter.location`, systems **SHOULD** reference it directly:\n* Servers can use the US Core Interpreter Needed Extension on this profile or the [US Core Patient Profile] to communicate whether a patient needs an interpreter. Although the extension is marked as an *Additional USCDI Requirements* on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles, but **SHALL** support the extension on at least one. The certifying Client application **SHALL** support the extension on both profiles.\n\n - Systems **SHOULD** designate the patient's preferred\nlanguage in the `Patient.communication.preferred` element.\n* Updates to `.meta.lastUpdated` **SHOULD** reflect:\n\n - New encounters/visits\n\n - Changes in the status of encounters, including events\nthat trigger the same status (e.g., in-progress → in-progress). These status changes correspond to events that can initiate [HL7 V2] ADT messages.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "class",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-class|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-lastupdated|9.0.0",
"type": "date",
"documentation": "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "discharge-disposition",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-discharge-disposition|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "identifier",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "location",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-location|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "type",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-type|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Endpoint",
"documentation": "The Media Resource is a Must Support referenced resource when using the US Core PractitionerRole Profile.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "FamilyMemberHistory",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-familymemberhistory|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-familymemberhistory.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core FamilyMemberHistory Profile"
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-familymemberhistory-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "code",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-familymemberhistory-code|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "description"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "target-date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "lifecycle-status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Goal",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-goal.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Goal Profile"
}
]
}
],
"documentation": "* Although both `Goal.startDate` and `Goal.target.dueDate` are marked as must support, the server system is not required to support both, but **SHALL** support at least one of these elements. The client application **SHALL** support both elements.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "description",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-description|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "lifecycle-status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-lifecycle-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "target-date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *day*.\n\n\nA server **SHALL** support a value a value precise to the *day*."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"type": "HealthcareService",
"documentation": "The HealthcareService Resource is a referenced resource when using the US Core PractitionerRole Profile and subject to constraint us-core-13: \"SHALL have a practitioner, an organization, a healthcare service, or a location.\"",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Immunization",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-immunization.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Immunization Profile"
}
]
}
],
"documentation": "* Based upon the ASTP U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes **SHOULD** be supported as an additional code.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Location",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-location.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Location Profile"
}
]
}
],
"documentation": "* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Location.address.line` and `Location.address.city`.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "address",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "address-city",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-city|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "address-postalcode",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-postalcode|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "address-state",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-state|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "name",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-name|9.0.0",
"type": "string"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Media",
"documentation": "The Media Resource is a Must Support referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Medication",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-medication.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Medication Profile"
}
]
}
],
"documentation": "* The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ **SHALL** be supported.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
},
{
"url": "required",
"valueString": "type"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "MedicationDispense",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-medicationdispense.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core MedicationDispense Profile"
}
]
}
],
"documentation": "* This Profile can represent a medication using a code or reference a Medication resource.\n\n * The Server systems are not required to support both\na code and a reference, but **SHALL** support at least one of these methods.\n\n * The Client application **SHALL** support all methods.\n\n * Systems that primarily rely on NDC codes instead of\nRxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.\n\n * When referencing a Medication resource in\n`.medicationReference`, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server **SHALL** support the `_include` parameter for searching this element.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchInclude": [
"MedicationDispense:medication"
],
"_searchInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationdispense-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationdispense-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "type",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationdispense-type|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "intent"
},
{
"url": "required",
"valueString": "authoredon"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "intent"
},
{
"url": "required",
"valueString": "encounter"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "intent"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "intent"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "MedicationRequest",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-medicationrequest.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core MedicationRequest Profile"
}
]
}
],
"documentation": "* This Profile can represent a medication using a code or reference a Medication resource.\n * The Server systems are not required to support both a code and a reference, but **SHALL** support at least one of these methods.\n * The Client application **SHALL** support all methods.\n * Systems that primarily rely on NDC codes instead of RxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.\n * When referencing a Medication resource in `.medicationReference`, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server **SHALL** support the `_include` parameter for searching this element. \n\n* The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in `MedicationRequest.reportedBoolean`, or a reference using `MedicationRequest.reportedReference` to Practitioner or other resource.\n * Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but **SHALL** choose to support at least one of these elements.\n * The client application **SHALL** support both elements.\n\n* When recording “self-prescribed” medication, requester **SHOULD** be used to indicate the Patient or RelatedPerson as the prescriber. (See the Medication List section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.)\n\n* The MedicationRequest resource can communicate the reason or indication for treatment using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference.\n * Although both `MedicationRequest.reasonCode` and `MedicationRequest.reasonReference` are marked as Additional USCDI Requirements. The certifying server system is not required to support both but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n * when using MedicationRequest.reasonReference:\n * Servers **SHALL** support at least one target resource in `MedicationRequest.reasonReference`. Clients **SHALL** support all target resources.\n * The referenced resources **SHOULD** be a US Core Profile as documented in Referencing US Core Profiles.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchInclude": [
"MedicationRequest:medication"
],
"_searchInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "authoredon",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "encounter",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "intent",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "_lastUpdated"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Observation",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-adi-documentation|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-simple-observation|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-treatment-intervention-preference|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-care-experience-preference|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-screening-assessment|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-average-blood-pressure|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-adi-documentation.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Observation ADI Documentation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-lab.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Laboratory Result Observation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-pregnancystatus.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Observation Pregnancy Status Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-pregnancyintent.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Observation Pregnancy Intent Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-occupation.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Observation Occupation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-respiratory-rate.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Respiratory Rate Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-simple-observation.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Simple Observation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-treatment-intervention-preference.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Treatment Intervention Preference Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-care-experience-preference.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Care Experience Preference Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-heart-rate.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Heart Rate Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-body-temperature.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Body Temperature Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-pediatric-weight-for-height.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Pediatric Weight for Height Observation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-pulse-oximetry.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Pulse Oximetry Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-smokingstatus.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Smoking Status Observation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-sexual-orientation.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Observation Sexual Orientation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-head-circumference.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Head Circumference Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-body-height.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Body Height Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-bmi.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core BMI Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-screening-assessment.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Observation Screening Assessment Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-average-blood-pressure.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Average Blood Pressure Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-blood-pressure.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Blood Pressure Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-observation-clinical-result.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Observation Clinical Result Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-pediatric-bmi-for-age.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Pediatric BMI for Age Observation Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-head-occipital-frontal-circumference-percentile.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Pediatric Head Occipital Frontal Circumference Percentile Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-body-weight.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Body Weight Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-vital-signs.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Vital Signs Profile"
}
]
}
],
"documentation": "* Systems **SHOULD** support `Observation.effectivePeriod` to accurately represent tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).\n* An Observation without a value, **SHALL** include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it\n * Systems that never provide an observation without a value are not required to support `Observation.dataAbsentReason`\n* An `Observation.component` without a value, **SHALL** include a reason why the data is absent.\n * Systems that never provide an component observation without a component value are not required to support `Observation.component.dataAbsentReason`.\n * There are multiple Observation profiles. Refer to the specific profile page for profile specific conformance rules and guidance ",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "code",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-lastupdated|9.0.0",
"type": "date",
"documentation": "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Organization",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-organization.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Organization Profile"
}
]
}
],
"documentation": "* Systems **SHALL** support National Provider Identifier (NPI) for organizations and **SHOULD** support Clinical Laboratory Improvement Amendments (CLIA) and the National Association of Insurance Commissioners NAIC Company code (sometimes called \"NAIC Number\" or \"cocode\") for `Organization.Identifier`.\n* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Organization.address.line` and `Organization.address.city`.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "address",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-address|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "name",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-name|9.0.0",
"type": "string"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "birthdate"
},
{
"url": "required",
"valueString": "name"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "birthdate"
},
{
"url": "required",
"valueString": "family"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "death-date"
},
{
"url": "required",
"valueString": "family"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Patient",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-patient.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Patient Profile"
}
]
}
],
"documentation": "* The Patient's Social Security Numbers **SHOULD NOT** be used as a patient identifier in `Patient.identifier.value`.\n* The Complex Extensions for Race and Ethnicity allow for one or more codes of which: Must Support at least one category code from the OMB Race and Ethnicity Category Value Sets that draw from the Race & Ethnicity - CDC (CDCREC] code system.\n - **MAY** include additional codes from the detailed ethnicity and detailed race value sets drawn from the Race & Ethnicity - CDC (CDCREC) code system\n - **SHALL** include a text description\n* Although Patient.deceased[x] is marked as *Additional USCDI Requirement*, certifying systems are not required to support both choices, but **SHALL** support at least `Patient.deceasedDateTime`.\n* Servers can use the US Core Interpreter Needed Extension on this profile or the US Core Encounter Profile to communicate whether a patient needs an interpreter. Although the extension is marked as an *Additional USCDI Requirement* on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles but **SHALL** support the extension on at least one. The certifying Client application **SHALL** support the extension on both profiles.\n - Systems **SHOULD** designate the patient's preferred language in the `Patient.communication.preferred` element.\n* Certifying systems **SHALL** and non-certifying systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Patient.address.line` and `Patient.address.city` for new and updated records.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "birthdate",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *day*.\n\n\nA server **SHALL** support a value a value precise to the *day*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "death-date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-death-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *day*.\n\n\nA server **SHALL** support a value a value precise to the *day*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "family",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "given",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "identifier",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "name",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name|9.0.0",
"type": "string"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Practitioner",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-practitioner.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Practitioner Profile"
}
]
}
],
"documentation": "* Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile **SHALL** provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.\n\n * Although Practitioner.address is marked as Must Support,\nthe server system is not required to support it if they support the US Core PractitionerRole Profile, but **SHALL** support it if they do not support the US Core PractitionerRole Profile. The client application **SHALL** support both.\n* To balance the privacy of healthcare workers with the patient's right to access information. Only professional/work contact information about the practitioner **SHOULD** be available to the patient (such as a work address or office telephone number).\n* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Practitioner.address.line` and `Practitioner.address.city`.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "identifier",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "name",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-name|9.0.0",
"type": "string"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "PractitionerRole",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-practitionerrole.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core PractitionerRole Profile"
}
]
}
],
"documentation": "* Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile **SHOULD** be used as the default profile if referenced by another US Core profile.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchInclude": [
"PractitionerRole:endpoint",
"PractitionerRole:practitioner"
],
"_searchInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "practitioner",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "specialty",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "date"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "Procedure",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-procedure.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Procedure Profile"
}
]
}
],
"documentation": "* Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.\n\n * Only LOINC concepts that reflect actual procedures\n**SHOULD** be used\n* A procedure including an implantable device **SHOULD** use `Procedure.focalDevice` with a reference to the *US Core Implantable Device Profile*.\n* Servers and Clients **SHALL** support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through `Procedure.basedOn` linking the Procedure to the US Core ServiceRequest Profile that includes either `ServiceRequest.reasonCode` or `ServiceRequest.reasonReference`. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's `Procedure.reasonCode` or `Procedure.reasonReference`. Depending on the procedure being documented, a server will select the appropriate Profile to use.\n\n * Although both `Procedure.reasonCode` and\n`Procedure.reasonReference` are marked as Additional USCDI Requirements. The certifying server system is not required to support both but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n\n * when using `Procedure.reasonReference`:\n\n * Servers **SHALL** support *at least one* target\nresource in `Procedure.reasonReference`. Clients **SHALL** support all target resources .\n\n * The referenced resources **SHOULD** be a US Core\nProfile.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "code",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Provenance",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-provenance.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Provenance Profile"
}
]
}
],
"documentation": "* The US Core Provenance resource **SHALL** be supported for these US Core resources:\n\n * AllergyIntolerance\n\n * CarePlan\n\n * CareTeam\n\n * Condition\n\n * Coverage\n\n * Device\n\n * DiagnosticReport\n\n * DocumentReference\n\n * Encounter\n\n * Goal\n\n * Immunization\n\n * MedicationDispense\n\n * MedicationRequest\n\n * Observation\n\n * Patient\n\n * Procedure\n\n * QuestionnaireResponse\n\n * RelatedPerson\n\n * ServiceRequest\n\n* 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.\n* Systems that need to know the activity has occurred **SHOULD** populate the activity.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Questionnaire",
"supportedProfile": [
"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "https://hl7.org/fhir/uv/sdc/StructureDefinition-sdc-questionnaire.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "SDC Base Questionnaire Profile"
}
]
}
],
"documentation": "* US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n\n\n - Observation: US Core Observation Screening Assessment\nProfile\n\n - Questionnaire/QuestionnaireResponse: SDC Base\nQuestionnaire/US Core QuestionnaireResponse Profile\n\n\n* US Core Servers **SHALL** support US Core Observation Screening Assessment Profile and **SHOULD** support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "questionnaire"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "authored"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "QuestionnaireResponse",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-questionnaireresponse.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core QuestionnaireResponse Profile"
}
]
}
],
"documentation": "* US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n\n\n - Observation: US Core Observation Screening Assessment\nProfile\n\n - Questionnaire/QuestionnaireResponse: SDC Base\nQuestionnaire/US Core QuestionnaireResponse Profile\n\n\n* US Core Servers **SHALL** support US Core Observation Screening Assessment Profile and **SHOULD** support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "authored",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-authored|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "questionnaire",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-questionnaire|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "name"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "RelatedPerson",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-relatedperson.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core RelatedPerson Profile"
}
]
}
],
"documentation": "* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `RelatedPerson.address.line` and `RelatedPerson.address.city`.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "name",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-name|9.0.0",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
},
{
"url": "required",
"valueString": "authored"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
},
{
"url": "required",
"valueString": "authored"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "category"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "code"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "ServiceRequest",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pmo-servicerequest|9.0.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-pmo-servicerequest.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core PMO ServiceRequest Profile"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-servicerequest.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core ServiceRequest Profile"
}
]
}
],
"documentation": "* The Must Support `ServiceRequest.category` is bound, *at a minimum*, to the [US Core ServiceRequest Category Codes](ValueSet-us-core-servicerequest-category.html), and other category codes can be used. API consumers can query by category when accessing patient information. For the USCDI *Laboratory Order*, *Imaging Order*, *Clinical Test Order*, and *Procedure Order* Data Elements, implementers **SHOULD** use the corresponding category codes listed in the table on the US Core ServiceRequest Profile page. For example, laboratory orders would have the category code \"108252007\" (Laboratory procedure).\n\n\n* The `ServiceRequest.code` value set is broad to accommodate a wide variety of use cases and **SHOULD** be constrained to a subset for a particular use case or domain. These value sets contain concepts that span many use cases and are not bound to any USCDI Data Element. However, the table on the US Core ServiceRequest Profile page identifies *additional* value set bindings for the USCDI *Laboratory Order, Imaging Order and Clinical Test Order* Data Elements. Implementers **SHOULD** conform to the binding strengths for each USCDI Order context listed in the table. For example, laboratory orders are extensibly bound to the LOINC Common Laboratory Orders Value Set. Note that the USCDI Class *Procedure Order* Data Element has no additional binding.\n\n\n* Servers and Clients **SHALL** support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through `Procedure.basedOn` linking the Procedure to the US Core ServiceRequest Profile that includes either `ServiceRequest.reasonCode` or `ServiceRequest.reasonReference`. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's `Procedure.reasonCode` or `Procedure.reasonReference`. Depending on the procedure being documented, a server will select the appropriate Profile to use.\n\n * Although both `ServiceRequest.reasonCode` and\n`ServiceRequest.reasonReference` are marked as Additional USCDI Requirements, the certifying server system is not required to support both, but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n\n * when using `ServiceRequest.reasonReference`:\n\n * Servers **SHALL** support *at least one* target\nresource in `ServiceRequest.reasonReference`. Clients **SHALL** support all target resources.\n\n * The referenced resources **SHOULD** be a US Core\nProfile as documented in Referencing US Core Profiles.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchRevInclude": [
"Provenance:target"
],
"_searchRevInclude": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "authored",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-authored|9.0.0",
"type": "date",
"documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-category|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "code",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-code|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-patient|9.0.0",
"type": "reference",
"documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-status|9.0.0",
"type": "token",
"documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "Specimen",
"supportedProfile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|9.0.0"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "StructureDefinition-us-core-specimen.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "US Core Specimen Profile"
}
]
}
],
"documentation": "* Although both `Specimen.identifier` and `Specimen.accessionIdentifier` are marked as Must Support, the server system is not required to support both, but **SHALL** support at least one of these elements. The client application **SHALL** support both.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "delete"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-type"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-specimen-id|9.0.0",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-specimen-patient|9.0.0",
"type": "reference"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"type": "ValueSet",
"operation": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "expand",
"definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"_definition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl": "https://hl7.org/fhir/R4/valueset-operation-expand.html"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/display",
"valueString": "$expand"
}
]
},
"documentation": "If a server supports DocumentReference for creating, using, and sharing clinical notes, it **SHOULD** also support the `context` and `contextdirection` parameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server."
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "transaction"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "batch"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-system"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-system"
}
]
}
]
}