diff --git a/fsh-generated/includes/fsh-link-references.md b/fsh-generated/includes/fsh-link-references.md index b3840d7..57f6742 100644 --- a/fsh-generated/includes/fsh-link-references.md +++ b/fsh-generated/includes/fsh-link-references.md @@ -1,5 +1,9 @@ +[encounter-diagnosis-example3]: Condition-encounter-diagnosis-example3.html [encounter-diagnosis-example1]: Condition-encounter-diagnosis-example1.html +[encounter-diagnosis-example2]: Condition-encounter-diagnosis-example2.html +[encounter-diagnosis-example4]: Condition-encounter-diagnosis-example4.html +[serum-bun]: Observation-serum-bun.html [USCoreCommonSDOHAssessments]: ValueSet-uscore-common-sdoh-assessments.html [USCoreConditionEncounterDiagnosisProfile]: StructureDefinition-us-core-condition-encounter-diagnosis.html -[USCorePatientProfile]: StructureDefinition-us-core-patient.html -[UsCoreServerCapabilityStatement]: CapabilityStatement-us-core-server.html \ No newline at end of file +[USCoreLaboratoryResultObservationProfile]: StructureDefinition-us-core-observation-lab.html +[USCorePatientProfile]: StructureDefinition-us-core-patient.html \ No newline at end of file diff --git a/fsh-generated/resources/ImplementationGuide-uscdi4-sandbox.json b/fsh-generated/resources/ImplementationGuide-uscdi4-sandbox.json index 3fc7669..2aaba7d 100644 --- a/fsh-generated/resources/ImplementationGuide-uscdi4-sandbox.json +++ b/fsh-generated/resources/ImplementationGuide-uscdi4-sandbox.json @@ -59,6 +59,14 @@ ], "definition": { "resource": [ + { + "reference": { + "reference": "Condition/encounter-diagnosis-example3" + }, + "description": "This example of a US Core Condition Encounter Diagnosis Profile illustrates its use to capture information about a patient's encounter diagnosis.", + "name": "Encounter Diagnosis Example 1", + "exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis" + }, { "reference": { "reference": "Condition/encounter-diagnosis-example1" @@ -67,6 +75,30 @@ "name": "Encounter Diagnosis Example 1", "exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis" }, + { + "reference": { + "reference": "Condition/encounter-diagnosis-example2" + }, + "description": "This example of a US Core Condition Encounter Diagnosis Profile illustrates its use to capture information about a patient's encounter diagnosis.", + "name": "Encounter Diagnosis Example 1", + "exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis" + }, + { + "reference": { + "reference": "Condition/encounter-diagnosis-example4" + }, + "description": "This example of a US Core Condition Encounter Diagnosis Profile illustrates its use to capture information about a patient's encounter diagnosis.", + "name": "Encounter Diagnosis Example 1", + "exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis" + }, + { + "reference": { + "reference": "Observation/serum-bun" + }, + "description": "This is a BUN example for the *US Core Observation Lab Profile*.", + "name": "Serum BUN Example", + "exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab" + }, { "reference": { "reference": "ValueSet/uscore-common-sdoh-assessments" @@ -85,19 +117,19 @@ }, { "reference": { - "reference": "StructureDefinition/us-core-patient" + "reference": "StructureDefinition/us-core-observation-lab" }, - "description": "The US Core Patient Profile meets the U.S. Core Data for Interoperability (USCDI) v3 'Patient Demographics' requirements. This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource when using this profile to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.", + "description": "The US Core Laboratory Result Observation Profile is based upon the US Core Observation Clinical Result Profile and, along with the US Core DiagnosticReport Profile for Laboratory Results Reporting, meets the U.S. Core Data for Interoperability (USCDI) Laboratory requirements. Laboratory results are grouped and summarized using the DiagnosticReport resource, which references Observation resources. Each Observation resource represents an individual laboratory test and result value, a “nested” panel (such as a microbial susceptibility panel) that references other observations, or rarely a laboratory test with component result values. The US Core Laboratory Result Observation Profile sets minimum expectations for the Observation resource to record, search, and fetch laboratory test results associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.", "exampleBoolean": false, - "name": "US Core Patient Profile" + "name": "US Core Laboratory Result Observation Profile" }, { "reference": { - "reference": "CapabilityStatement/us-core-server" + "reference": "StructureDefinition/us-core-patient" }, - "description": "This Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and the ONC [U.S. Core Data for Interoperability (USCDI) Version 4 July 2023](https://www.healthit.gov/sites/isa/files/2023-07/Final-USCDI-Version-4-July-2023-Final.pdf). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.", + "description": "The US Core Patient Profile meets the U.S. Core Data for Interoperability (USCDI) v3 'Patient Demographics' requirements. This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource when using this profile to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.", "exampleBoolean": false, - "name": "US Core Server CapabilityStatement" + "name": "US Core Patient Profile" } ], "page": { diff --git a/input/data/ig.yml b/input/data/ig.yml index 2887c87..8da98ef 100644 --- a/input/data/ig.yml +++ b/input/data/ig.yml @@ -36,12 +36,35 @@ dependsOn: id: hl7_fhir_uv_extensions_r4 definition: resource: + - reference: + reference: Condition/encounter-diagnosis-example3 + description: This example of a US Core Condition Encounter Diagnosis Profile illustrates + its use to capture information about a patient's encounter diagnosis. + name: Encounter Diagnosis Example 1 + exampleCanonical: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis - reference: reference: Condition/encounter-diagnosis-example1 description: This example of a US Core Condition Encounter Diagnosis Profile illustrates its use to capture information about a patient's encounter diagnosis. name: Encounter Diagnosis Example 1 exampleCanonical: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis + - reference: + reference: Condition/encounter-diagnosis-example2 + description: This example of a US Core Condition Encounter Diagnosis Profile illustrates + its use to capture information about a patient's encounter diagnosis. + name: Encounter Diagnosis Example 1 + exampleCanonical: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis + - reference: + reference: Condition/encounter-diagnosis-example4 + description: This example of a US Core Condition Encounter Diagnosis Profile illustrates + its use to capture information about a patient's encounter diagnosis. + name: Encounter Diagnosis Example 1 + exampleCanonical: http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis + - reference: + reference: Observation/serum-bun + description: This is a BUN example for the *US Core Observation Lab Profile*. + name: Serum BUN Example + exampleCanonical: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab - reference: reference: ValueSet/uscore-common-sdoh-assessments description: "Common SDOH assessment concepts covering the following categories\ @@ -67,6 +90,26 @@ definition: profile. It provides the floor for standards development for specific use cases. exampleBoolean: false name: US Core Condition Encounter Diagnosis Profile + - reference: + reference: StructureDefinition/us-core-observation-lab + description: "The US Core Laboratory Result Observation Profile is based upon\ + \ the US Core Observation Clinical Result Profile and, along with the US Core\ + \ DiagnosticReport Profile for Laboratory Results Reporting, meets the U.S.\ + \ Core Data for Interoperability (USCDI) Laboratory requirements. Laboratory\ + \ results are grouped and summarized using the DiagnosticReport resource, which\ + \ references Observation resources. Each Observation resource represents an\ + \ individual laboratory test and result value, a \u201Cnested\u201D panel (such\ + \ as a microbial susceptibility panel) that references other observations, or\ + \ rarely a laboratory test with component result values. The US Core Laboratory\ + \ Result Observation Profile sets minimum expectations for the Observation resource\ + \ to record, search, and fetch laboratory test results associated with a patient\ + \ to promote interoperability and adoption through common implementation. It\ + \ identifies which core elements, extensions, vocabularies, and value sets SHALL\ + \ be present in the resource and constrains the way the elements are used when\ + \ using this profile. It provides the floor for standards development for specific\ + \ use cases." + exampleBoolean: false + name: US Core Laboratory Result Observation Profile - reference: reference: StructureDefinition/us-core-patient description: The US Core Patient Profile meets the U.S. Core Data for Interoperability @@ -81,20 +124,6 @@ definition: for standards development for specific use cases. exampleBoolean: false name: US Core Patient Profile - - reference: - reference: CapabilityStatement/us-core-server - description: This Section describes the expected capabilities of the US Core Server - actor which is responsible for providing responses to the queries submitted - by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, - and search parameters supported by US Core Servers are defined. Systems implementing - this capability statement should meet the ONC 2015 Common Clinical Data Set - (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application - Access - Data Category Request 170.315(g)(8) and the ONC [U.S. Core Data for - Interoperability (USCDI) Version 4 July 2023](https://www.healthit.gov/sites/isa/files/2023-07/Final-USCDI-Version-4-July-2023-Final.pdf). US - Core Clients have the option of choosing from this list to access necessary - data based on their local use cases and other contextual requirements. - exampleBoolean: false - name: US Core Server CapabilityStatement page: nameUrl: toc.html title: Table of Contents diff --git a/input/examples-yaml/condition-encounter-diagnosis-addl-legacycode-example1.yml b/input/examples-yaml/condition-encounter-diagnosis-addl-legacycode-example1.yml new file mode 100644 index 0000000..eb25bda --- /dev/null +++ b/input/examples-yaml/condition-encounter-diagnosis-addl-legacycode-example1.yml @@ -0,0 +1,53 @@ +resourceType: Condition +id: encounter-diagnosis-example3 +meta: + extension: + - url: http://hl7.org/fhir/StructureDefinition/instance-name + valueString: Encounter Diagnosis Example 1 + - url: http://hl7.org/fhir/StructureDefinition/instance-description + valueMarkdown: This example of a US Core Condition Encounter Diagnosis Profile + illustrates its use to capture information about a patient's encounter diagnosis. + profile: + - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis +extension: +- url: http://hl7.org/fhir/StructureDefinition/condition-assertedDate + valueDateTime: 2015-10-31 +clinicalStatus: + coding: + - system: http://terminology.hl7.org/CodeSystem/condition-clinical + code: resolved +verificationStatus: + coding: + - system: http://terminology.hl7.org/CodeSystem/condition-ver-status + code: confirmed +category: +- coding: + - system: http://terminology.hl7.org/CodeSystem/condition-category + code: encounter-diagnosis + display: Encounter Diagnosis + +# ============= test codes for QA review ================= + +code: + coding: + - system: http://snomed.info/sct + code: '39065001' + display: Burn of ear + version: http://snomed.info/sct/731000124108 + + - system: http://example.org/fhir/codes + code: FOO + display: Foo + + text: Foo + +# ============= test codes for QA review ================= + +subject: + reference: Patient/example + display: Amy Shaw +encounter: + reference: Encounter/example-1 +onsetDateTime: 2015-10-31 +abatementDateTime: 2015-12-01 +recordedDate: 2015-11-01 diff --git a/input/examples-yaml/condition-encounter-diagnosis-example1.yml b/input/examples-yaml/condition-encounter-diagnosis-example1.yml index 86f9de3..9e1b9f3 100644 --- a/input/examples-yaml/condition-encounter-diagnosis-example1.yml +++ b/input/examples-yaml/condition-encounter-diagnosis-example1.yml @@ -25,6 +25,9 @@ category: - system: http://terminology.hl7.org/CodeSystem/condition-category code: encounter-diagnosis display: Encounter Diagnosis + +# ============= test codes for QA review ================= + code: coding: - system: http://snomed.info/sct @@ -32,6 +35,9 @@ code: display: Burn of ear version: http://snomed.info/sct/731000124108 text: Burnt Ear + +# ============= test codes for QA review ================= + subject: reference: Patient/example display: Amy Shaw diff --git a/input/examples-yaml/condition-encounter-diagnosis-legacycode-example1.yml b/input/examples-yaml/condition-encounter-diagnosis-legacycode-example1.yml new file mode 100644 index 0000000..48264c2 --- /dev/null +++ b/input/examples-yaml/condition-encounter-diagnosis-legacycode-example1.yml @@ -0,0 +1,53 @@ +resourceType: Condition +id: encounter-diagnosis-example2 +meta: + extension: + - url: http://hl7.org/fhir/StructureDefinition/instance-name + valueString: Encounter Diagnosis Example 1 + - url: http://hl7.org/fhir/StructureDefinition/instance-description + valueMarkdown: This example of a US Core Condition Encounter Diagnosis Profile + illustrates its use to capture information about a patient's encounter diagnosis. + profile: + - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis +extension: +- url: http://hl7.org/fhir/StructureDefinition/condition-assertedDate + valueDateTime: 2015-10-31 +clinicalStatus: + coding: + - system: http://terminology.hl7.org/CodeSystem/condition-clinical + code: resolved +verificationStatus: + coding: + - system: http://terminology.hl7.org/CodeSystem/condition-ver-status + code: confirmed +category: +- coding: + - system: http://terminology.hl7.org/CodeSystem/condition-category + code: encounter-diagnosis + display: Encounter Diagnosis + +# ============= test codes for QA review ================= + +code: + coding: + # - system: http://snomed.info/sct + # code: '39065001' + # display: Burn of ear + # version: http://snomed.info/sct/731000124108 + + - system: http://example.org/fhir/codes + code: FOO + display: Foo + + text: Foo + +# ============= test codes for QA review ================= + +subject: + reference: Patient/example + display: Amy Shaw +encounter: + reference: Encounter/example-1 +onsetDateTime: 2015-10-31 +abatementDateTime: 2015-12-01 +recordedDate: 2015-11-01 diff --git a/input/examples-yaml/condition-encounter-diagnosis-text-only-example1.yml b/input/examples-yaml/condition-encounter-diagnosis-text-only-example1.yml new file mode 100644 index 0000000..2ee083f --- /dev/null +++ b/input/examples-yaml/condition-encounter-diagnosis-text-only-example1.yml @@ -0,0 +1,43 @@ +resourceType: Condition +id: encounter-diagnosis-example4 +meta: + extension: + - url: http://hl7.org/fhir/StructureDefinition/instance-name + valueString: Encounter Diagnosis Example 1 + - url: http://hl7.org/fhir/StructureDefinition/instance-description + valueMarkdown: This example of a US Core Condition Encounter Diagnosis Profile + illustrates its use to capture information about a patient's encounter diagnosis. + profile: + - http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis +extension: +- url: http://hl7.org/fhir/StructureDefinition/condition-assertedDate + valueDateTime: 2015-10-31 +clinicalStatus: + coding: + - system: http://terminology.hl7.org/CodeSystem/condition-clinical + code: resolved +verificationStatus: + coding: + - system: http://terminology.hl7.org/CodeSystem/condition-ver-status + code: confirmed +category: +- coding: + - system: http://terminology.hl7.org/CodeSystem/condition-category + code: encounter-diagnosis + display: Encounter Diagnosis + +# ============= test codes for QA review ================= + +code: + text: Foo + +# ============= test codes for QA review ================= + +subject: + reference: Patient/example + display: Amy Shaw +encounter: + reference: Encounter/example-1 +onsetDateTime: 2015-10-31 +abatementDateTime: 2015-12-01 +recordedDate: 2015-11-01 diff --git a/input/examples-yaml/observation-serum-bun.yml b/input/examples-yaml/observation-serum-bun.yml new file mode 100644 index 0000000..ef07709 --- /dev/null +++ b/input/examples-yaml/observation-serum-bun.yml @@ -0,0 +1,61 @@ +category: +- coding: + - code: laboratory + display: Laboratory + system: http://terminology.hl7.org/CodeSystem/observation-category + text: Laboratory +code: + coding: + - code: 3094-0 + display: BUN SerPl-mCnc + system: http://loinc.org + text: BUN SerPl-mCnc +effectiveDateTime: '2005-07-05' +id: serum-bun +meta: + extension: + - url: http://hl7.org/fhir/StructureDefinition/instance-name + valueString: Serum BUN Example + - url: http://hl7.org/fhir/StructureDefinition/instance-description + valueMarkdown: This is a BUN example for the *US Core Observation Lab Profile*. + lastUpdated: '2016-03-09T15:29:58.597+00:00' + profile: + - http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab + versionId: '1237' +referenceRange: +- high: + code: mg/dL + system: http://unitsofmeasure.org + unit: mg/dL + value: 20.0 + low: + code: mg/dL + system: http://unitsofmeasure.org + unit: mg/dL + value: 5.0 + type: + coding: + - code: normal + display: Normal Range + system: http://terminology.hl7.org/CodeSystem/referencerange-meaning + text: Normal Range +resourceType: Observation +status: final +subject: + display: Amy Shaw + reference: Patient/example +valueQuantity: + system: http://unitsofmeasure.org + unit: mg/dL + value: 10.0 +specimen: + reference: Specimen/specimen-example-serum + display: Serum specimen +interpretation: + - + coding: + - code: N + display: Normal + system: http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation + text: Normal + diff --git a/input/examples/condition-encounter-diagnosis-addl-legacycode-example1.json b/input/examples/condition-encounter-diagnosis-addl-legacycode-example1.json new file mode 100644 index 0000000..17f5f5f --- /dev/null +++ b/input/examples/condition-encounter-diagnosis-addl-legacycode-example1.json @@ -0,0 +1,68 @@ +{ + "resourceType": "Condition", + "id": "encounter-diagnosis-example3", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis" + ] + }, + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/condition-assertedDate", + "valueDateTime": "2015-10-31" + } + ], + "clinicalStatus": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", + "code": "resolved" + } + ] + }, + "verificationStatus": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", + "code": "confirmed" + } + ] + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-category", + "code": "encounter-diagnosis", + "display": "Encounter Diagnosis" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39065001", + "display": "Burn of ear", + "version": "http://snomed.info/sct/731000124108" + }, + { + "system": "http://example.org/fhir/codes", + "code": "FOO", + "display": "Foo" + } + ], + "text": "Foo" + }, + "subject": { + "reference": "Patient/example", + "display": "Amy Shaw" + }, + "encounter": { + "reference": "Encounter/example-1" + }, + "onsetDateTime": "2015-10-31", + "abatementDateTime": "2015-12-01", + "recordedDate": "2015-11-01" +} diff --git a/input/examples/condition-encounter-diagnosis-legacycode-example1.json b/input/examples/condition-encounter-diagnosis-legacycode-example1.json new file mode 100644 index 0000000..968ccf9 --- /dev/null +++ b/input/examples/condition-encounter-diagnosis-legacycode-example1.json @@ -0,0 +1,62 @@ +{ + "resourceType": "Condition", + "id": "encounter-diagnosis-example2", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis" + ] + }, + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/condition-assertedDate", + "valueDateTime": "2015-10-31" + } + ], + "clinicalStatus": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", + "code": "resolved" + } + ] + }, + "verificationStatus": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", + "code": "confirmed" + } + ] + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-category", + "code": "encounter-diagnosis", + "display": "Encounter Diagnosis" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://example.org/fhir/codes", + "code": "FOO", + "display": "Foo" + } + ], + "text": "Foo" + }, + "subject": { + "reference": "Patient/example", + "display": "Amy Shaw" + }, + "encounter": { + "reference": "Encounter/example-1" + }, + "onsetDateTime": "2015-10-31", + "abatementDateTime": "2015-12-01", + "recordedDate": "2015-11-01" +} diff --git a/input/examples/condition-encounter-diagnosis-text-only-example1.json b/input/examples/condition-encounter-diagnosis-text-only-example1.json new file mode 100644 index 0000000..a86b40d --- /dev/null +++ b/input/examples/condition-encounter-diagnosis-text-only-example1.json @@ -0,0 +1,55 @@ +{ + "resourceType": "Condition", + "id": "encounter-diagnosis-example4", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis" + ] + }, + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/condition-assertedDate", + "valueDateTime": "2015-10-31" + } + ], + "clinicalStatus": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-clinical", + "code": "resolved" + } + ] + }, + "verificationStatus": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status", + "code": "confirmed" + } + ] + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/condition-category", + "code": "encounter-diagnosis", + "display": "Encounter Diagnosis" + } + ] + } + ], + "code": { + "text": "Foo" + }, + "subject": { + "reference": "Patient/example", + "display": "Amy Shaw" + }, + "encounter": { + "reference": "Encounter/example-1" + }, + "onsetDateTime": "2015-10-31", + "abatementDateTime": "2015-12-01", + "recordedDate": "2015-11-01" +} diff --git a/input/examples/observation-serum-bun.json b/input/examples/observation-serum-bun.json new file mode 100644 index 0000000..cda9abd --- /dev/null +++ b/input/examples/observation-serum-bun.json @@ -0,0 +1,86 @@ +{ + "category": [ + { + "coding": [ + { + "code": "laboratory", + "display": "Laboratory", + "system": "http://terminology.hl7.org/CodeSystem/observation-category" + } + ], + "text": "Laboratory" + } + ], + "code": { + "coding": [ + { + "code": "3094-0", + "display": "BUN SerPl-mCnc", + "system": "http://loinc.org" + } + ], + "text": "BUN SerPl-mCnc" + }, + "effectiveDateTime": "2005-07-05", + "id": "serum-bun", + "meta": { + "lastUpdated": "2016-03-09T15:29:58.597+00:00", + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab" + ], + "versionId": "1237" + }, + "referenceRange": [ + { + "high": { + "code": "mg/dL", + "system": "http://unitsofmeasure.org", + "unit": "mg/dL", + "value": 20 + }, + "low": { + "code": "mg/dL", + "system": "http://unitsofmeasure.org", + "unit": "mg/dL", + "value": 5 + }, + "type": { + "coding": [ + { + "code": "normal", + "display": "Normal Range", + "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning" + } + ], + "text": "Normal Range" + } + } + ], + "resourceType": "Observation", + "status": "final", + "subject": { + "display": "Amy Shaw", + "reference": "Patient/example" + }, + "valueQuantity": { + "system": "http://unitsofmeasure.org", + "unit": "mg/dL", + "value": 10 + }, + "specimen": { + "reference": "Specimen/specimen-example-serum", + "display": "Serum specimen" + }, + "interpretation": [ + { + "coding": [ + { + "code": "N", + "display": "Normal", + "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation" + } + ], + "text": "Normal" + } + ] +} diff --git a/input/includes/DAR-exception.md b/input/includes/DAR-exception.md new file mode 100644 index 0000000..34a0156 --- /dev/null +++ b/input/includes/DAR-exception.md @@ -0,0 +1,5 @@ +- \*An Observation without a value, **SHALL** include a reason why the data is absent *unless* there are 1) component observations, or 2) reporting panel observations using `Observation.hasMember`. + - For further guidance see the [Observation Grouping] section in FHIR Specification. + - Systems that never provide an observation without a value are not required to support `Observation.dataAbsentReason`. +- \*An `Observation.component` without a value, **SHALL** include a reason why the data is absent. + - Systems that never provide a component observation without a component value are not required to support `Observation.component.dataAbsentReason`. diff --git a/input/includes/link-list.md b/input/includes/link-list.md index 8a09ece..7541e61 100644 --- a/input/includes/link-list.md +++ b/input/includes/link-list.md @@ -5,4 +5,5 @@ [extensible]: {{site.data.fhir.path}}terminologies.html#extensible [component]: foo.html [Additional USCDI Requirements]: must-support.html#additional-uscdi-requirements -[current]: https://hl7.org/fhir/R5/terminologies.html#binding \ No newline at end of file +[current]: https://hl7.org/fhir/R5/terminologies.html#binding +[searching using lastUpdated]: guidance.html#searching-using-lastupdated \ No newline at end of file diff --git a/input/includes/observation-quickstart1.md b/input/includes/observation-quickstart1.md new file mode 100644 index 0000000..d1ada02 --- /dev/null +++ b/input/includes/observation-quickstart1.md @@ -0,0 +1,91 @@ + + + +{% include quickstart-intro.md %} + +#### Mandatory Search Parameters: + +The following search parameters and search parameter combinations SHALL be supported: + +1. **SHALL** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** search parameters: + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory` + + Example: + + 1. GET [base]/Observation?patient=1134281&category={% if include.system %}{{include.system }}\|{% endif %}{{include.category | default: '[category]'}} + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and a category code = `laboratory` ([how to search by reference] and [how to search by token]) + +1. **SHALL** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`code`](SearchParameter-us-core-observation-code.html)** search parameters: + - including optional support for *OR* search on `code` (e.g.`code={system|}[code],{system|}[code],...`) + + `GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}` + + Example: + + 1. GET [base]/Observation?patient=1134281&code=http://loinc.org\|{{include.code1 | default: '[code]'}} + {% if include.code2 %}2. GET [base]/Observation?patient=1134281&code=http://loinc.org\|{{include.code1 | default: '[code]'}},http://loinc.org\|{{include.code2 | default: '[code]'}},http://loinc.org\|{{include.code3 | default: '[code]'}}{% endif %} + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and observation code(s). SHOULD support search by multiple report codes. The Observation `code` parameter searches `Observation.code only. ([how to search by reference] and [how to search by token]) + +1. **SHALL** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** and **[`date`](SearchParameter-us-core-observation-date.html)** search parameters: + - including support for these `date` comparators: `gt,lt,ge,le` + - including optional support for *AND* search on `date` (e.g.`date=[date]&date=[date]]&...`) + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}` + + Example: + + 1. GET [base]Observation?patient=555580&category={% if include.system %}{{include.system }}\|{% endif %}{{include.category | default: '[category]'}}&date=ge2018-03-14T00:00:00Z + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and date and a category code = `laboratory` ([how to search by reference] and [how to search by token] and [how to search by date]) + + +#### Optional Search Parameters: + +The following search parameter combinations **SHOULD** be supported: + +1. **SHOULD** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** and **[`status`](SearchParameter-us-core-observation-status.html)** search parameters: + - including support for *OR* search on `status` (e.g.`status={system|}[code],{system|}[code],...`) + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&status={system|}[code]{,{system|}[code],...}` + + Example: + + 1. GET [base]/Observation?patient=1134281&category={% if include.system %}{{include.system }}\|{% endif %}{{include.category | default: '[category]'}}&status=final + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and category = `laboratory` and status ([how to search by reference] and [how to search by token]) + +1. {:.new-content}**SHOULD** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** and **[`_lastUpdated`](SearchParameter-us-core-observation-lastupdated.html)** search parameters: + - including support for these `_lastUpdated` comparators: `gt,lt,ge,le` + - including optional support for *AND* search on `_lastUpdated` (e.g.`_lastUpdated=[date]&_lastUpdated=[date]]&...`) + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&_lastUpdated={gt|lt|ge|le}[date]{&_lastUpdated={gt|lt|ge|le}[date]&...}` + + Example: + + 1. GET [base]Observation?patient=555580&category={% if include.system %}{{include.system }}\|{% endif %}{{include.category | default: '[category]'}}&_lastUpdated=ge2024-01-01T00:00:00Z + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and category and _lastUpdated. See the US Core General Guidance page for [searching using lastUpdated]. ([how to search by reference] and [how to search by token] and [how to search by date]) + +1. **SHOULD** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`code`](SearchParameter-us-core-observation-code.html)** and **[`date`](SearchParameter-us-core-observation-date.html)** search parameters: + - including optional support for *OR* search on `code` (e.g.`code={system|}[code],{system|}[code],...`) + - including support for these `date` comparators: `gt,lt,ge,le` + - including optional support for *AND* search on `date` (e.g.`date=[date]&date=[date]]&...`) + + `GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}` + + Example: + + 1. GET [base]Observation?patient=555580&code=http://loinc.org\|{{include.code1 | default: '[code]'}}&date=ge2019-01-01T00:00:00Z + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and date and report code(s). SHOULD support search by multiple report codes. ([how to search by reference] and [how to search by token] and [how to search by date]) + +{% include link-list.md %} \ No newline at end of file diff --git a/input/includes/observation_guidance_1.md b/input/includes/observation_guidance_1.md new file mode 100644 index 0000000..3ffe18b --- /dev/null +++ b/input/includes/observation_guidance_1.md @@ -0,0 +1,20 @@ + + + +{% include obs_cat_guidance.md -%} +{% include additional-codings.md %} +* Systems **SHOULD** support `Observation.effectivePeriod` to accurately represent procedure tests that are collected over a period of time {{include.example2}}. +{% include DAR-exception.md %} +* See the [General Guidance] page for further guidance on using SNOMED and UCUM. +* See the [LOINC scale type to FHIR data type mapping] for guidance on which `Observation.value[x]` data type to use based on the LOINC Type of Scale. + +{% include link-list.md %} diff --git a/input/includes/quickstart-intro.md b/input/includes/quickstart-intro.md index c990acc..b2ebf1b 100644 --- a/input/includes/quickstart-intro.md +++ b/input/includes/quickstart-intro.md @@ -38,7 +38,7 @@ Below is an overview of the required Server RESTful FHIR interactions for this p {% if smart_scope -%}- See the [Scopes Format](scopes.html#scopes-format) section for a description of the SMART scopes syntax.{% endif %} - See the [Search Syntax](general-guidance.html#search-syntax) section for a description of the US Core search syntax. - See the [General Requirements] section for additional rules and expectations when a server requires status parameters. -- See the [General Guidance] section for additional guidance on searching for multiple s. +- See the [General Guidance] section for additional guidance on searching for multiple patients. diff --git a/input/intro-notes/StructureDefinition-us-core-observation-lab-intro.md b/input/intro-notes/StructureDefinition-us-core-observation-lab-intro.md new file mode 100644 index 0000000..940baee --- /dev/null +++ b/input/intro-notes/StructureDefinition-us-core-observation-lab-intro.md @@ -0,0 +1,42 @@ + +**Example Usage Scenarios:** + +The following are example usage scenarios for this profile: + +- Query for lab results belonging to a Patient +- [Record or update] lab results belonging to a Patient + +### Mandatory and Must Support Data Elements + +*In addition* to the Mandatory and Must Support data elements in the [US Core Observation Clinical Result Profile], The following data-elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] section below provides the formal summary, definitions, and terminology requirements. {% include diff-display-note.md parent_profile='US Core Observation Clinical Result Profile' %} + +**Each Observation Must Have:** + +1. a category code of 'laboratory' +2. a laboratory [LOINC] code, if available, which tells you what is being measured + +**Each Observation Must Support:** + +1. a timestamp when the resource last changed +2. a result value* + - if the result value is a numeric quantity, a standard [UCUM] unit + - if the result value is a coded quantity, a standard [SNOMED CT] +3. result interpretation + - + if the result value is a numeric quantity, a standard [UCUM] unit + +4. result reference range +5. a specimen type (e.g., blood, serum, urine) + +\* see guidance below + +**Profile Specific Implementation Guidance:** + +- For USCDI, systems are required to use SNOMED CT for coded results if the SCT code exists. +- The specimen type can be communicated in the mandatory `Observation.code` (e.g., Blood Glucose), or the Must Support `Observation.specimen` element, or through both elements. +{% include observation_guidance_1.md category="laboratory" example1=" such as 'chemistry'" example2=" (for example, a 24-Hour Urine Collection test)" %} +- \*This profile inherits the invariant "us-core-3" from the US Core Observation Clinical Result Profile that requires UCUM to be used as a unit type for `Observation.valeQuantity.code'. + + + +{% include link-list.md %} diff --git a/input/intro-notes/StructureDefinition-us-core-observation-lab-notes.md b/input/intro-notes/StructureDefinition-us-core-observation-lab-notes.md new file mode 100644 index 0000000..438d3a5 --- /dev/null +++ b/input/intro-notes/StructureDefinition-us-core-observation-lab-notes.md @@ -0,0 +1 @@ +{% include observation-quickstart1.md system="http://terminology.hl7.org/CodeSystem/observation-category" category="laboratory" code1="2339-0" code2="25428-4" code3="2514-8" %} diff --git a/input/intro-notes/StructureDefinition-us-core-observation-notes.md b/input/intro-notes/StructureDefinition-us-core-observation-notes.md new file mode 100644 index 0000000..f3cdb25 --- /dev/null +++ b/input/intro-notes/StructureDefinition-us-core-observation-notes.md @@ -0,0 +1,88 @@ + + +{% include quickstart-intro.md %} + +#### Mandatory Search Parameters: + +The following search parameters and search parameter combinations SHALL be supported: + +1. **SHALL** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** search parameters: + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory` + + Example: + + 1. GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category\|laboratory + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and a category code = `laboratory` ([how to search by reference] and [how to search by token]) + +1. **SHALL** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`code`](SearchParameter-us-core-observation-code.html)** search parameters: + - including optional support for *OR* search on `code` (e.g.`code={system|}[code],{system|}[code],...`) + + `GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}` + + Example: + + 1. GET [base]/Observation?patient=1134281&code=http://loinc.org\|2339-0 + 1. GET [base]/Observation?patient=1134281&code=http://loinc.org\|2339-0,http://loinc.org\|25428-4,2514-8 + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and observation code(s). SHOULD support search by multiple report codes. The Observation `code` parameter searches `Observation.code only. ([how to search by reference] and [how to search by token]) + +1. **SHALL** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** and **[`date`](SearchParameter-us-core-observation-date.html)** search parameters: + - including support for these `date` comparators: `gt,lt,ge,le` + - including optional support for *AND* search on `date` (e.g.`date=[date]&date=[date]]&...`) + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}` + + Example: + + 1. GET [base]Observation?patient=555580&category=http://terminology.hl7.org/CodeSystem/observation-category\|laboratory&date=ge2018-03-14T00:00:00Z + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and date and a category code = `laboratory` ([how to search by reference] and [how to search by token] and [how to search by date]) + + +#### Optional Search Parameters: + +The following search parameter combinations **SHOULD** be supported: + +1. **SHOULD** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** and **[`status`](SearchParameter-us-core-observation-status.html)** search parameters: + - including support for *OR* search on `status` (e.g.`status={system|}[code],{system|}[code],...`) + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&status={system|}[code]{,{system|}[code],...}` + + Example: + + 1. GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category\|laboratory&status=final + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and category = `laboratory` and status ([how to search by reference] and [how to search by token]) + +1. **SHOULD** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`category`](SearchParameter-us-core-observation-category.html)** and **[`_lastUpdated`](SearchParameter-us-core-observation-lastupdated.html)** search parameters: + - including support for these `_lastUpdated` comparators: `gt,lt,ge,le` + - including optional support for *AND* search on `_lastUpdated` (e.g.`_lastUpdated=[date]&_lastUpdated=[date]]&...`) + + `GET [base]/Observation?patient={Type/}[id]&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&_lastUpdated={gt|lt|ge|le}[date]{&_lastUpdated={gt|lt|ge|le}[date]&...}` + + Example: + + 1. GET [base]Observation?patient=555580&category=http://terminology.hl7.org/CodeSystem/observation-category\|laboratory&_lastUpdated=ge2024-01-01T00:00:00Z + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and category and _lastUpdated. See the US Core General Guidance page for [searching using lastUpdated]. ([how to search by reference] and [how to search by token] and [how to search by date]) + +1. **SHOULD** support searching using the combination of the **[`patient`](SearchParameter-us-core-observation-patient.html)** and **[`code`](SearchParameter-us-core-observation-code.html)** and **[`date`](SearchParameter-us-core-observation-date.html)** search parameters: + - including optional support for *OR* search on `code` (e.g.`code={system|}[code],{system|}[code],...`) + - including support for these `date` comparators: `gt,lt,ge,le` + - including optional support for *AND* search on `date` (e.g.`date=[date]&date=[date]]&...`) + + `GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}` + + Example: + + 1. GET [base]Observation?patient=555580&code=http://loinc.org\|2339-0&date=ge2019-01-01T00:00:00Z + + *Implementation Notes:* Fetches a bundle of all Observation resources for the specified patient and date and report code(s). SHOULD support search by multiple report codes. ([how to search by reference] and [how to search by token] and [how to search by date]) + + + + + +{% include link-list.md %} \ No newline at end of file diff --git a/input/pagecontent/general-requirements.md b/input/pagecontent/general-requirements.md index d162805..50454a7 100644 --- a/input/pagecontent/general-requirements.md +++ b/input/pagecontent/general-requirements.md @@ -19,7 +19,7 @@ The [US Core AllergyIntolerance Profile] illustrates the extensible binding rule #### Current Binding for Coded Elements -The FHIR guidance for extensible bindings indicates that *all conceptual overlaps* including free text, be mapped to the coded values in the bindings. US Core guidance adopts the [current] additional binding from FHIR R5 for more flexibility for legacy and text-only data. However, for newly recorded, non-legacy data, a system **SHALL** adhere to the extensible binding rules. +The FHIR guidance for extensible bindings indicates that *all conceptual overlaps* including free text, be mapped to the coded values in the bindings. US Core adopts the [current] additional binding from FHIR R5 for more flexibility for exchanging legacy and text-only data. However, for newly recorded, non-legacy data, a system **SHALL** adhere to the extensible binding rules. For example, the [US Core Procedure Codes] and [US Core Condition Codes] ValueSets completely cover the domain. For data not captured by fine-grained code it is possible to provide a a high-level abstract code*, such as SNOMED CT "Procedure". Therefore instead of requiring all legacy and text data be mapped to a standard code, the valueset uses a "current" binding diff --git a/input/resources-yaml/StructureDefinition-us-core-condition-encounter-diagnosis.yml b/input/resources-yaml/StructureDefinition-us-core-condition-encounter-diagnosis.yml index 5843300..6ada7b1 100644 --- a/input/resources-yaml/StructureDefinition-us-core-condition-encounter-diagnosis.yml +++ b/input/resources-yaml/StructureDefinition-us-core-condition-encounter-diagnosis.yml @@ -106,25 +106,19 @@ differential: - url: valueSet valueCanonical: http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code - url: documentation - valueMarkdown: US Core Extensible definition of extensible - - url: shortDoco - valueString: US Core Extensible + valueMarkdown: US Core uses the current additional binding from FHIR R5 for this coded element for more flexibility when exchanging legacy and text-only data. + # ====== New R5 additional Binding Element Here ==== strength: preferred description: Valueset to describe the actual problem experienced by the patient - # valueSet: http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code + valueSet: http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code mapping: - identity: argonaut-dq-dstu2 map: Condition.code - - - - - - id: Condition.subject path: Condition.subject type: diff --git a/input/resources-yaml/StructureDefinition-us-core-observation-lab.yml b/input/resources-yaml/StructureDefinition-us-core-observation-lab.yml new file mode 100644 index 0000000..7a00c8a --- /dev/null +++ b/input/resources-yaml/StructureDefinition-us-core-observation-lab.yml @@ -0,0 +1,148 @@ +resourceType: StructureDefinition +id: us-core-observation-lab +url: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab +name: USCoreLaboratoryResultObservationProfile +title: US Core Laboratory Result Observation Profile +status: active +experimental: false +date: 2023-10-17 +description: "The US Core Laboratory Result Observation Profile is based upon the + US Core Observation Clinical Result Profile and, along with the US Core DiagnosticReport + Profile for Laboratory Results Reporting, meets the U.S. Core Data for Interoperability + (USCDI) Laboratory requirements. Laboratory results are grouped and summarized using + the DiagnosticReport resource, which references Observation resources. Each Observation + resource represents an individual laboratory test and result value, a \u201Cnested\u201D + panel (such as a microbial susceptibility panel) that references other observations, + or rarely a laboratory test with component result values. The US Core Laboratory + Result Observation Profile sets minimum expectations for the Observation resource + to record, search, and fetch laboratory test results associated with a patient to + promote interoperability and adoption through common implementation. It identifies + which core elements, extensions, vocabularies, and value sets SHALL be present in + the resource and constrains the way the elements are used when using this profile. + It provides the floor for standards development for specific use cases." +fhirVersion: 4.0.1 +kind: resource +abstract: false +type: Observation +baseDefinition: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result +derivation: constraint +differential: + + element: + + +# ==== added lastUpdated to the mustSupport list ==== + + - id: Observation.meta + path: Observation.meta + mustSupport: true + - id: Observation.meta.lastUpdated + path: Observation.meta.lastUpdated + short: When the resource last changed + mustSupport: true + +# ==== added lastUpdated to the mustSupport list ==== + + + - id: Observation.category:us-core + path: Observation.category + sliceName: us-core + min: 1 + max: '1' + patternCodeableConcept: + coding: + - system: http://terminology.hl7.org/CodeSystem/observation-category + code: laboratory + mustSupport: true + mapping: + - identity: argonaut-dq-dstu2 + map: Observation.category + - id: Observation.code + path: Observation.code + short: Laboratory Test Name + mustSupport: true + binding: + strength: extensible + description: Laboratory LOINC Codes + valueSet: http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes + mapping: + - identity: argonaut-dq-dstu2 + map: Observation.code + - id: Observation.value[x] + path: Observation.value[x] + short: Result Value + definition: The Laboratory result value. If a coded value, the valueCodeableConcept.code + **SHOULD** be selected from [SNOMED CT](http://hl7.org/fhir/ValueSet/uslab-obs-codedresults) + if the concept exists. If a numeric value, valueQuantity.code **SHALL** be selected + from [UCUM](http://unitsofmeasure.org). A FHIR [UCUM Codes value set](http://hl7.org/fhir/STU3/valueset-ucum-units.html) + that defines all UCUM codes is in the FHIR specification. + type: + - extension: + - url: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support + valueBoolean: true + code: Quantity + - extension: + - url: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support + valueBoolean: true + code: CodeableConcept + - extension: + - url: http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support + valueBoolean: true + code: string + - code: boolean + - code: integer + - code: Range + - code: Ratio + - code: SampledData + - code: time + - code: dateTime + - code: Period + condition: + - us-core-4 + constraint: + - extension: + - url: http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice + valueBoolean: true + key: us-core-4 + severity: warning + human: SHOULD use Snomed CT for coded Results + expression: ofType(CodeableConcept).coding.system.empty() or (ofType(CodeableConcept).coding.system + contains 'http://snomed.info/sct') + xpath: not(exists(f:valueCodeableConcept/f:coding/f:system) ) or f:valueCodeableConcept/f:coding/f:system[@value='http://snomed.info/sct'] + mustSupport: true + mapping: + - identity: argonaut-dq-dstu2 + map: Observation.value[x] + - id: Observation.interpretation + path: Observation.interpretation + short: Result interpretation + comment: Categorical assessment of a laboratory value, often in relation to a + test's reference range. Examples include but are not limited to high, low, critical, + and normal. + mustSupport: true + binding: + strength: extensible + description: Observation Interpretation Codes + valueSet: http://hl7.org/fhir/ValueSet/observation-interpretation + - id: Observation.specimen + path: Observation.specimen + type: + - code: Reference + targetProfile: + - http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen + mustSupport: true + - id: Observation.referenceRange + path: Observation.referenceRange + short: Result reference range + comment: Upper and lower limit of test values expected for a designated population + of individuals. Reference range values may differ by patient characteristics, + laboratory test manufacturer and laboratory test performer. + condition: + - us-core-22 + constraint: + - key: us-core-22 + severity: error + human: SHALL use UCUM for coded quantity units. + expression: (low.system.empty() or low.system = 'http://unitsofmeasure.org') and (high.system.empty() or high.system = 'http://unitsofmeasure.org') + mustSupport: true + diff --git a/input/resources/StructureDefinition-us-core-condition-encounter-diagnosis.json b/input/resources/StructureDefinition-us-core-condition-encounter-diagnosis.json index b46ac3b..0eb3304 100644 --- a/input/resources/StructureDefinition-us-core-condition-encounter-diagnosis.json +++ b/input/resources/StructureDefinition-us-core-condition-encounter-diagnosis.json @@ -131,17 +131,14 @@ }, { "url": "documentation", - "valueMarkdown": "US Core Extensible definition of extensible" - }, - { - "url": "shortDoco", - "valueString": "US Core Extensible" + "valueMarkdown": "US Core uses the current additional binding from FHIR R5 for this coded element for more flexibility when exchanging legacy and text-only data." } ] } ], "strength": "preferred", - "description": "Valueset to describe the actual problem experienced by the patient" + "description": "Valueset to describe the actual problem experienced by the patient", + "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code" }, "mapping": [ { diff --git a/input/resources/StructureDefinition-us-core-observation-lab.json b/input/resources/StructureDefinition-us-core-observation-lab.json new file mode 100644 index 0000000..292f7a4 --- /dev/null +++ b/input/resources/StructureDefinition-us-core-observation-lab.json @@ -0,0 +1,197 @@ +{ + "resourceType": "StructureDefinition", + "id": "us-core-observation-lab", + "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", + "name": "USCoreLaboratoryResultObservationProfile", + "title": "US Core Laboratory Result Observation Profile", + "status": "active", + "experimental": false, + "date": "2023-10-17", + "description": "The US Core Laboratory Result Observation Profile is based upon the US Core Observation Clinical Result Profile and, along with the US Core DiagnosticReport Profile for Laboratory Results Reporting, meets the U.S. Core Data for Interoperability (USCDI) Laboratory requirements. Laboratory results are grouped and summarized using the DiagnosticReport resource, which references Observation resources. Each Observation resource represents an individual laboratory test and result value, a \u201cnested\u201d panel (such as a microbial susceptibility panel) that references other observations, or rarely a laboratory test with component result values. The US Core Laboratory Result Observation Profile sets minimum expectations for the Observation resource to record, search, and fetch laboratory test results associated with a patient to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases.", + "fhirVersion": "4.0.1", + "kind": "resource", + "abstract": false, + "type": "Observation", + "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result", + "derivation": "constraint", + "differential": { + "element": [ + { + "id": "Observation.meta", + "path": "Observation.meta", + "mustSupport": true + }, + { + "id": "Observation.meta.lastUpdated", + "path": "Observation.meta.lastUpdated", + "mustSupport": true + }, + { + "id": "Observation.category:us-core", + "path": "Observation.category", + "sliceName": "us-core", + "min": 1, + "max": "1", + "patternCodeableConcept": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/observation-category", + "code": "laboratory" + } + ] + }, + "mustSupport": true, + "mapping": [ + { + "identity": "argonaut-dq-dstu2", + "map": "Observation.category" + } + ] + }, + { + "id": "Observation.code", + "path": "Observation.code", + "short": "Laboratory Test Name", + "mustSupport": true, + "binding": { + "strength": "extensible", + "description": "Laboratory LOINC Codes", + "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes" + }, + "mapping": [ + { + "identity": "argonaut-dq-dstu2", + "map": "Observation.code" + } + ] + }, + { + "id": "Observation.value[x]", + "path": "Observation.value[x]", + "short": "Result Value", + "definition": "The Laboratory result value. If a coded value, the valueCodeableConcept.code **SHOULD** be selected from [SNOMED CT](http://hl7.org/fhir/ValueSet/uslab-obs-codedresults) if the concept exists. If a numeric value, valueQuantity.code **SHALL** be selected from [UCUM](http://unitsofmeasure.org). A FHIR [UCUM Codes value set](http://hl7.org/fhir/STU3/valueset-ucum-units.html) that defines all UCUM codes is in the FHIR specification.", + "type": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", + "valueBoolean": true + } + ], + "code": "Quantity" + }, + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", + "valueBoolean": true + } + ], + "code": "CodeableConcept" + }, + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", + "valueBoolean": true + } + ], + "code": "string" + }, + { + "code": "boolean" + }, + { + "code": "integer" + }, + { + "code": "Range" + }, + { + "code": "Ratio" + }, + { + "code": "SampledData" + }, + { + "code": "time" + }, + { + "code": "dateTime" + }, + { + "code": "Period" + } + ], + "condition": [ + "us-core-4" + ], + "constraint": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", + "valueBoolean": true + } + ], + "key": "us-core-4", + "severity": "warning", + "human": "SHOULD use Snomed CT for coded Results", + "expression": "ofType(CodeableConcept).coding.system.empty() or (ofType(CodeableConcept).coding.system contains 'http://snomed.info/sct')", + "xpath": "not(exists(f:valueCodeableConcept/f:coding/f:system) ) or f:valueCodeableConcept/f:coding/f:system[@value='http://snomed.info/sct']" + } + ], + "mustSupport": true, + "mapping": [ + { + "identity": "argonaut-dq-dstu2", + "map": "Observation.value[x]" + } + ] + }, + { + "id": "Observation.interpretation", + "path": "Observation.interpretation", + "short": "Result interpretation", + "comment": "Categorical assessment of a laboratory value, often in relation to a test's reference range. Examples include but are not limited to high, low, critical, and normal.", + "mustSupport": true, + "binding": { + "strength": "extensible", + "description": "Observation Interpretation Codes", + "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation" + } + }, + { + "id": "Observation.specimen", + "path": "Observation.specimen", + "type": [ + { + "code": "Reference", + "targetProfile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen" + ] + } + ], + "mustSupport": true + }, + { + "id": "Observation.referenceRange", + "path": "Observation.referenceRange", + "short": "Result reference range", + "comment": "Upper and lower limit of test values expected for a designated population of individuals. Reference range values may differ by patient characteristics, laboratory test manufacturer and laboratory test performer.", + "condition": [ + "us-core-22" + ], + "constraint": [ + { + "key": "us-core-22", + "severity": "error", + "human": "SHALL use UCUM for coded quantity units.", + "expression": "(low.system.empty() or low.system = 'http://unitsofmeasure.org') and (high.system.empty() or high.system = 'http://unitsofmeasure.org')" + } + ], + "mustSupport": true + } + ] + } +} \ No newline at end of file diff --git a/input/resources/capabilitystatement-us-core-server.json b/input/resources/capabilitystatement-us-core-server.json deleted file mode 100644 index e642b37..0000000 --- a/input/resources/capabilitystatement-us-core-server.json +++ /dev/null @@ -1,6735 +0,0 @@ -{ - "resourceType": "CapabilityStatement", - "id": "us-core-server", - "text": { - "status": "generated", - "div": "

SHOULD Support the Following Implementation Guides:

SHALL Implement All Or Parts Of The Following Capability Statements:

FHIR RESTful Capabilities

The US Core Server SHALL:

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

The US Core Server SHOULD:

  1. Follow the guidance documented in the General Guidance page
  2. Support XML source formats for all US Core interactions.
  3. Identify the US Core profiles supported as part of the FHIR meta.profile attribute for each instance.

Security:

  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found"

Summary of System Wide Interactions

RESTful Capabilities by Resource/Profile:

Summary

Resource Type Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations
AllergyIntolerance US Core AllergyIntolerance Profile clinical-status, patient patient+clinical-status - Provenance:target -
CarePlan US Core CarePlan Profile category, date, patient, status patient+category+status+date, patient+category+date, patient+category+status, patient+category - Provenance:target -
CareTeam US Core CareTeam Profile patient, role, status patient+role, patient+status 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 abatement-date, asserted-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date patient+asserted-date, patient+abatement-date, patient+onset-date, patient+code, patient+category+clinical-status, patient+clinical-status, patient+category+encounter, patient+recorded-date, patient+category - Provenance:target -
Coverage US Core Coverage Profile patient - Provenance:target -
Device US Core Implantable Device Profile patient, status, type patient+status, patient+type - Provenance:target -
DiagnosticReport US Core DiagnosticReport Profile for Report and Note exchange, US Core DiagnosticReport Profile for Laboratory Results Reporting category, code, date, patient, status patient+category, patient+status, patient+code+date, patient+code, patient+category+date - Provenance:target -
DocumentReference US Core DocumentReference Profile _id, category, date, patient, period, status, type patient+type+period, patient+category, patient+status, patient+type, patient+category+date - Provenance:target docref
Encounter US Core Encounter Profile _id, class, date, discharge-disposition, identifier, location, patient, status, type class+patient, patient+type, patient+discharge-disposition, patient+status, patient+location, date+patient - Provenance:target -
Endpoint - - - - -
Goal US Core Goal Profile description, lifecycle-status, patient, target-date patient+description, patient+target-date, patient+lifecycle-status - Provenance:target -
HealthcareService - - - - -
Immunization US Core Immunization Profile date, patient, status patient+status, patient+date - Provenance:target -
Location US Core Location Profile address, address-city, address-postalcode, address-state, name - - -
Media - - - - -
Medication US Core Medication Profile - - - -
MedicationDispense US Core MedicationDispense Profile patient, status, type patient+status, patient+status+type MedicationDispense:medication Provenance:target -
MedicationRequest US Core MedicationRequest Profile authoredon, encounter, intent, patient, status patient+intent+authoredon, patient+intent+encounter, patient+intent+status, patient+intent MedicationRequest:medication Provenance:target -
Observation 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 category, code, date, patient, status patient+category+status, patient+category, patient+code+date, patient+code, patient+category+date - Provenance:target -
Organization US Core Organization Profile address, name - - -
Patient US Core Patient Profile _id, birthdate, death-date, family, gender, given, identifier, name death-date+family, family+gender, birthdate+family, birthdate+name, gender+name - Provenance:target -
Practitioner US Core Practitioner Profile _id, identifier, name - - -
PractitionerRole US Core PractitionerRole Profile practitioner, specialty PractitionerRole:endpoint, PractitionerRole:practitioner - -
Procedure US Core Procedure Profile code, date, patient, status patient+status, patient+code+date, patient+date - Provenance:target -
Provenance US Core Provenance Profile - - - -
Questionnaire SDC Base Questionnaire Profile - - - -
QuestionnaireResponse US Core QuestionnaireResponse Profile _id, authored, patient, questionnaire, status patient+status, patient+questionnaire, patient+authored - Provenance:target -
RelatedPerson US Core RelatedPerson Profile _id, name, patient patient+name - Provenance:target -
ServiceRequest US Core ServiceRequest Profile _id, authored, category, code, patient, status patient+status, patient+category+authored, patient+code, patient+code+authored, patient+category - Provenance:target -
Specimen US Core Specimen Profile _id, patient - - -
ValueSet - - - - expand

Summary of Must Support References

US Core Profile Resource Type Target Profile Target Resource Type
US Core Pediatric Head Occipital Frontal Circumference Percentile Profile Observation US Core Patient Profile Patient
US Core Pediatric BMI for Age Observation Profile Observation US Core Patient Profile Patient
US Core Pediatric Weight for Height Observation Profile Observation US Core Patient Profile Patient
US Core AllergyIntolerance Profile AllergyIntolerance US Core Patient Profile Patient
US Core Average Blood Pressure Profile Observation - -
US Core Blood Pressure Profile Observation US Core Patient Profile Patient
US Core BMI Profile Observation US Core Patient Profile Patient
US Core Body Height Profile Observation US Core Patient Profile Patient
US Core Body Temperature Profile Observation US Core Patient Profile Patient
US Core Body Weight Profile Observation US Core Patient Profile Patient
US Core Care Experience Preference Profile Observation US Core Patient Profile Patient
US Core CarePlan Profile CarePlan US Core Patient Profile Patient
US Core CareTeam Profile CareTeam US Core PractitionerRole Profile
US Core Patient Profile
US Core Practitioner Profile
US Core RelatedPerson Profile 		PractitionerRole
Patient
Practitioner
RelatedPerson
US Core Condition Encounter Diagnosis Profile Condition US Core Encounter Profile
US Core Patient Profile 		Encounter
Patient
US Core Condition Problems and Health Concerns Profile Condition US Core Patient Profile Patient
US Core Coverage Profile Coverage US Core Patient Profile
US Core Organization Profile 		Patient
Organization
US Core DiagnosticReport Profile for Laboratory Results Reporting DiagnosticReport US Core Laboratory Result Observation Profile
US Core Encounter Profile
US Core Patient Profile
US Core Practitioner Profile 		Observation
Encounter
Patient
Practitioner
US Core DiagnosticReport Profile for Report and Note Exchange DiagnosticReport Media
US Core Observation Clinical Result Profile
US Core Patient Profile
US Core Practitioner Profile
US Core Laboratory Result Observation Profile
US Core Encounter Profile
US Core Organization Profile 		Media
Observation
Patient
Practitioner
Observation
Encounter
Organization
US Core DocumentReference Profile DocumentReference US Core Encounter Profile
US Core Patient Profile
US Core Practitioner Profile 		Encounter
Patient
Practitioner
US Core Encounter Profile Encounter US Core Location Profile
US Core Condition Problems and Health Concerns Profile
US Core Condition Encounter Diagnosis Profile
US Core Patient Profile
US Core Practitioner Profile
US Core Organization Profile 		Location
Condition
Condition
Patient
Practitioner
Organization
US Core Goal Profile Goal US Core Patient Profile Patient
US Core Head Circumference Profile Observation US Core Patient Profile Patient
US Core Heart Rate Profile Observation US Core Patient Profile Patient
US Core Immunization Profile Immunization US Core Encounter Profile
US Core Patient Profile
US Core Location Profile 		Encounter
Patient
Location
US Core Implantable Device Profile Device US Core Patient Profile Patient
US Core Location Profile Location US Core Organization Profile Organization
US Core Medication Profile Medication - -
US Core MedicationDispense Profile MedicationDispense US Core MedicationRequest Profile
US Core Patient Profile
US Core Practitioner Profile
US Core Encounter Profile
US Core Organization Profile
US Core Medication Profile 		MedicationRequest
Patient
Practitioner
Encounter
Organization
Medication
US Core MedicationRequest Profile MedicationRequest US Core Encounter Profile
US Core Patient Profile
US Core Practitioner Profile
US Core Medication Profile 		Encounter
Patient
Practitioner
Medication
US Core Observation Clinical Result Profile Observation US Core Encounter Profile
US Core Patient Profile 		Encounter
Patient
US Core Laboratory Result Observation Profile Observation US Core Specimen Profile
US Core Encounter Profile
US Core Patient Profile 		Specimen
Encounter
Patient
US Core Observation Occupation Profile Observation US Core Patient Profile Patient
US Core Observation Pregnancy Intent Profile Observation US Core Patient Profile Patient
US Core Observation Pregnancy Status Profile Observation US Core Patient Profile Patient
US Core Observation Screening Assessment Profile Observation US Core Observation Screening Assessment Profile
US Core Patient Profile
US Core QuestionnaireResponse Profile 		Observation
Patient
QuestionnaireResponse
US Core Observation Sexual Orientation Profile Observation US Core Patient Profile Patient
US Core Organization Profile Organization - -
US Core Patient Profile Patient - -
US Core Practitioner Profile Practitioner - -
US Core PractitionerRole Profile PractitionerRole Endpoint
US Core Practitioner Profile
US Core Organization Profile
US Core Location Profile 		Endpoint
Practitioner
Organization
Location
US Core Procedure Profile Procedure US Core Encounter Profile
US Core Patient Profile 		Encounter
Patient
US Core Provenance Profile Provenance Any Resource
US Core Organization Profile 		Any Resource
Organization
US Core Pulse Oximetry Profile Observation US Core Patient Profile Patient
US Core QuestionnaireResponse Profile QuestionnaireResponse Any Resource
US Core Patient Profile
US Core Practitioner Profile 		Any Resource
Patient
Practitioner
US Core RelatedPerson Profile RelatedPerson US Core Patient Profile Patient
US Core Respiratory Rate Profile Observation US Core Patient Profile Patient
US Core ServiceRequest Profile ServiceRequest US Core Encounter Profile
US Core Patient Profile
US Core Practitioner Profile 		Encounter
Patient
Practitioner
US Core Simple Observation Profile Observation US Core Patient Profile Patient
US Core Smoking Status Observation Profile Observation US Core Patient Profile Patient
US Core Specimen Profile Specimen US Core Patient Profile Patient
US Core Treatment Intervention Preference Profile Observation US Core Patient Profile Patient
US Core Vital Signs Profile Observation US Core Patient Profile Patient

Summary of Additional USCDI Requirement References

US Core Profile Resource Type Target Profile Target Resource Type
US Core Pediatric Head Occipital Frontal Circumference Percentile Profile Observation - -
US Core Pediatric BMI for Age Observation Profile Observation - -
US Core Pediatric Weight for Height Observation Profile Observation - -
US Core AllergyIntolerance Profile AllergyIntolerance - -
US Core Average Blood Pressure Profile Observation - -
US Core Blood Pressure Profile Observation - -
US Core BMI Profile Observation - -
US Core Body Height Profile Observation - -
US Core Body Temperature Profile Observation - -
US Core Body Weight Profile Observation - -
US Core Care Experience Preference Profile Observation - -
US Core CarePlan Profile CarePlan - -
US Core CareTeam Profile CareTeam - -
US Core Condition Encounter Diagnosis Profile Condition - -
US Core Condition Problems and Health Concerns Profile Condition - -
US Core Coverage Profile Coverage - -
US Core DiagnosticReport Profile for Laboratory Results Reporting DiagnosticReport - -
US Core DiagnosticReport Profile for Report and Note Exchange DiagnosticReport - -
US Core DocumentReference Profile DocumentReference - -
US Core Encounter Profile Encounter - -
US Core Goal Profile Goal - -
US Core Head Circumference Profile Observation - -
US Core Heart Rate Profile Observation - -
US Core Immunization Profile Immunization - -
US Core Implantable Device Profile Device - -
US Core Location Profile Location - -
US Core Medication Profile Medication - -
US Core MedicationDispense Profile MedicationDispense - -
US Core MedicationRequest Profile MedicationRequest Condition
Observation 		Condition
Observation
US Core Observation Clinical Result Profile Observation - -
US Core Laboratory Result Observation Profile Observation - -
US Core Observation Occupation Profile Observation - -
US Core Observation Pregnancy Intent Profile Observation - -
US Core Observation Pregnancy Status Profile Observation - -
US Core Observation Screening Assessment Profile Observation - -
US Core Observation Sexual Orientation Profile Observation - -
US Core Organization Profile Organization - -
US Core Patient Profile Patient - -
US Core Practitioner Profile Practitioner - -
US Core PractitionerRole Profile PractitionerRole HealthcareService HealthcareService
US Core Procedure Profile Procedure DiagnosticReport
Procedure
DocumentReference
Observation
Condition 		DiagnosticReport
Procedure
DocumentReference
Observation
Condition
US Core Provenance Profile Provenance - -
US Core Pulse Oximetry Profile Observation - -
US Core QuestionnaireResponse Profile QuestionnaireResponse - -
US Core RelatedPerson Profile RelatedPerson - -
US Core Respiratory Rate Profile Observation - -
US Core ServiceRequest Profile ServiceRequest Condition
DiagnosticReport
Observation
DocumentReference 		Condition
DiagnosticReport
Observation
DocumentReference
US Core Simple Observation Profile Observation - -
US Core Smoking Status Observation Profile Observation - -
US Core Specimen Profile Specimen - -
US Core Treatment Intervention Preference Profile Observation - -
US Core Vital Signs Profile Observation - -

AllergyIntolerance

Conformance Expectation: SHALL

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ clinical-status reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • clinical-status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

CarePlan

Conformance Expectation: SHALL

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
    • Assement and Plan MAY be included as narrative text

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ category+ status+ date reference+token+token+date
SHOULD patient+ category+ date reference+token+date
SHOULD patient+ category+ status reference+token+token
SHALL patient+ category reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • category (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

CareTeam

Conformance Expectation: SHALL

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:

  1. US Core Practitioner Profile
  2. US Core PractitionerRole Profile
  3. US Core Patient Profile
  4. 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 supports only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider's location and contact information using only the Practitioner resource.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHOULD role token

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ role reference+token
SHALL patient+ status reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • role (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Condition

Conformance Expectation: SHALL

Resource Specific Documentation:

  • For Encounter Diagnosis use the US Core Condition Encounter Diagnosis Profile.
    • When Condition.category is "encounter-diagnosis" the encounter, SHOULD be referenced in Condition.encounter.
  • For Problems and Health Concerns use the US Core Condition Problems and Health Concerns Profile.
    • When Condition.category is a "problems-list-item", the `Condition.clinicalStatus SHOULD NOT be unknown.
  • There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, Condition.onsetDateTime, or Condition.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.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ asserted-date reference+date
SHOULD patient+ abatement-date reference+date
SHOULD patient+ onset-date reference+date
SHOULD patient+ code reference+token
SHOULD patient+ category+ clinical-status reference+token+token
SHOULD patient+ clinical-status reference+token
SHOULD patient+ category+ encounter reference+token+reference
SHOULD patient+ recorded-date reference+date
SHALL patient+ category reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • abatement-date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • asserted-date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • category (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • clinical-status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • code (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • encounter (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • onset-date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • recorded-date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

Coverage

Conformance Expectation: SHALL

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Requirements (When Used Alone or in Combination):

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

Device

Conformance Expectation: SHALL

Resource Specific Documentation:

  • Implantable medical devices that have UDI information SHALL represent the UDI code in Device.udiCarrier.carrierHRF.

    • All of the five UDI-PI elements that are present in the UDI code SHALL be represented in the corresponding US Core Implantable Device Profile element.

    UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they SHOULD be included to support historical reports of implantable medical devices as follows:

    manufacturer -> Device.manufacturer
    model -> Device.model

  • Servers SHOULD support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ status reference+token
SHOULD patient+ type reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • type (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

DiagnosticReport

Conformance Expectation: SHALL

Supported Profiles:

Reference Policy

Profile Interaction Summary:

create†

This conformance expectation applies only to the US Core DiagnosticReport Profile for Report and Note exchange profile. The conformance expectation for the US Core DiagnosticReport Profile for Laboratory Results Reporting is MAY.

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHALL patient+ category reference+token
SHOULD patient+ status reference+token
SHOULD patient+ code+ date reference+token+date
SHALL patient+ code reference+token
SHALL patient+ category+ date reference+token+date

Search Parameter Requirements (When Used Alone or in Combination):

  • category (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • code (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

DocumentReference

Conformance Expectation: SHALL

Resource Specific Documentation:

  • The DocumentReference.type binding SHALL support at a minimum the 5 Common Clinical Notes and may extend to the full US Core DocumentReference Type Value Set
  • 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.
    • 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.url may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.
      • If the endpoint is outside the FHIR base URL, it SHOULD NOT require additional authorization to access.
    • If there are multiple DocumentReference.content element 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
  • 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.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Operation Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL _id token
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ type+ period reference+token+date
SHALL patient+ category reference+token
SHOULD patient+ status reference+token
SHALL patient+ type reference+token
SHALL patient+ category+ date reference+token+date

Search Parameter Requirements (When Used Alone or in Combination):

  • category (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • period (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • type (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Encounter

Conformance Expectation: SHALL

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

    • 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.reasonReference references 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.location or indirectly through the Organization referenced by Encounter.serviceProvider.

    • Although both are marked as must support, the server systems are not required to support both Encounter.location.location and Encounter.serviceProvider, but they SHALL support at least one of these elements.
    • The client application SHALL support both elements.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL _id token
SHOULD identifier token
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD class+ patient token+reference
SHOULD patient+ type reference+token
SHOULD patient+ discharge-disposition reference+token
SHOULD patient+ status reference+token
SHOULD patient+ location reference+reference
SHALL date+ patient date+reference

Search Parameter Requirements (When Used Alone or in Combination):

  • class (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • discharge-disposition (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • identifier (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • location (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • type (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Endpoint

Conformance Expectation: SHALL

Resource Specific Documentation:

The Media Resource is a Must Suppot referenced resource when using the US Core PracitionerRole Profile.

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Goal

Conformance Expectation: SHALL

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

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ description reference+token
SHOULD patient+ target-date reference+date
SHOULD patient+ lifecycle-status reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • lifecycle-status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • target-date (date):

    A client SHALL provide a value precise to the day.

    A server SHALL support a value a value precise to the day.

HealthcareService

Conformance Expectation: MAY

Resource Specific Documentation:

The HealthcareService Resource is a referenced resource when using the US Core PracitionRole Profile and subject to constraint us-core-13: "SHALL have a practitioner, an organization, a healthcare service, or a location."

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Immunization

Conformance Expectation: SHALL

Resource Specific Documentation:

  • Based upon the ONC U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes SHOULD be supported as translations to them.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ status reference+token
SHOULD patient+ date reference+date

Search Parameter Requirements (When Used Alone or in Combination):

  • date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Location

Conformance Expectation: SHALL

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL address string
SHOULD address-city string
SHOULD address-postalcode string
SHOULD address-state string
SHALL name string

Media

Conformance Expectation: SHALL

Resource Specific Documentation:

The Media Resource is a Must Suppot referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Medication

Conformance Expectation: SHALL

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:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

MedicationDispense

Conformance Expectation: SHALL

Resource Specific Documentation:

  • The MedicationDispense resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include` parameter for searching this element. The client application must support all methods.

For example, A server SHALL be capable of returning dispense records for all medications for a patient using one of or both:

GET /MedicationDispense?patient=[id]

GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ status reference+token
SHOULD patient+ status+ type reference+token+token

Search Parameter Requirements (When Used Alone or in Combination):

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • type (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

MedicationRequest

Conformance Expectation: SHALL

Resource Specific Documentation:

  • The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include` parameter for searching this element. The client application must support all methods.

For example, A server SHALL be capable of returning all medications for a patient using one of or both:

GET /MedicationRequest?patient=[id]

GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication

  • 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.
    • 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.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ intent+ authoredon reference+token+date
SHOULD patient+ intent+ encounter reference+token+reference
SHALL patient+ intent+ status reference+token+token
SHALL patient+ intent reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • authoredon (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • encounter (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • intent (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Observation

Conformance Expectation: SHALL

Resource Specific 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).
  • 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.component without 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.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ category+ status reference+token+token
SHALL patient+ category reference+token
SHOULD patient+ code+ date reference+token+date
SHALL patient+ code reference+token
SHALL patient+ category+ date reference+token+date

Search Parameter Requirements (When Used Alone or in Combination):

  • category (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • code (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Organization

Conformance Expectation: SHALL

Resource Specific Documentation:

  • Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) identifiers for Organization.Identifier.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL address string
SHALL name string

Patient

Conformance Expectation: SHALL

Resource Specific Documentation:

  • For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.

    1. contact detail (e.g. a telephone number or an email address)
    2. a communication language
    3. a race
    4. an ethnicity
    5. a birth sex*
    6. previous name
      • Previous name is represented by providing an end date in the Patient.name.period element for a previous name.
    7. suffix
      • Suffix is represented using the Patient.name.suffix element.

  • The Patient's Social Security Numbers SHOULD NOT be used as a patient identifier in Patient.identifier.value.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL _id token
SHALL identifier token
SHALL name string

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD death-date+ family date+string
SHOULD family+ gender string+token
SHOULD birthdate+ family date+string
SHALL birthdate+ name date+string
SHALL gender+ name token+string

Search Parameter Requirements (When Used Alone or in Combination):

  • birthdate (date):

    A client SHALL provide a value precise to the day.

    A server SHALL support a value a value precise to the day.

  • death-date (date):

    A client SHALL provide a value precise to the day.

    A server SHALL support a value a value precise to the day.

  • family (string):

    A server SHALL support a value precise to the day.

  • gender (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • identifier (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Practitioner

Conformance Expectation: SHALL

Resource Specific Documentation:

Servers that support only US Core Practitioner Profile SHALL provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHOULD _id token
SHALL identifier token
SHALL name string

Search Parameter Requirements (When Used Alone or in Combination):

  • identifier (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

PractitionerRole

Conformance Expectation: SHALL

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:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL practitioner reference
SHALL specialty token

Search Parameter Requirements (When Used Alone or in Combination):

  • practitioner (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • specialty (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Procedure

Conformance Expectation: SHALL

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.focalDevice with a reference to the US Core Implantable Device Profile.

  • The Reason or justification for a referral or consultation is communicated through:

    1. ServiceRequest.reason or ServiceRequest.reason, and Procedure.basedOn that links the Procedure to the US Core ServiceRequest Profile.
      • ServiceRequest.reasonCode and 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.
      • As documented here, when using ServiceRequest.reasonReference, the referenced resources SHOULD be a US Core Profile.
    2. Procedure.reasonCode or Procedure.reasonReference when the Procedure does not have an associated ServiceRequest.
      • Although both Procedure.reasonCode and 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.
      • As documented here, when using Procedure.reasonReference, the referenced resources SHOULD be a US Core Profile.

    Certifying Servers and Clients SHALL support options 1 and 2 as Additional USCDI Requirements.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ status reference+token
SHOULD patient+ code+ date reference+token+date
SHALL patient+ date reference+date

Search Parameter Requirements (When Used Alone or in Combination):

  • code (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • date (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Provenance

Conformance Expectation: SHALL

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.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.
  • Systems that need to know the activity has occurred SHOULD populate the activity.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Questionnaire

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:

Profile Interaction Summary:

Fetch and Search Criteria:

QuestionnaireResponse

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:

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL _id token
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ status reference+token
SHOULD patient+ questionnaire reference+reference
SHOULD patient+ authored reference+date

Search Parameter Requirements (When Used Alone or in Combination):

  • authored (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • questionnaire (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

RelatedPerson

Conformance Expectation: SHALL

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL _id token
SHOULD name string
SHOULD patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ name reference+string

Search Parameter Requirements (When Used Alone or in Combination):

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

ServiceRequest

Conformance Expectation: SHALL

Resource Specific Documentation:

  • The Reason or justification for a referral or consultation is communicated through:

    1. ServiceRequest.reason or ServiceRequest.reason, and Procedure.basedOn that links the Procedure to the US Core ServiceRequest Profile.
      • ServiceRequest.reasonCode and 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.
      • As documented here, when using ServiceRequest.reasonReference, the referenced resources SHOULD be a US Core Profile.
    2. Procedure.reasonCode or Procedure.reasonReference when the Procedure does not have an associated ServiceRequest.
      • Although both Procedure.reasonCode and 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.
      • As documented here, when using Procedure.reasonReference, the referenced resources SHOULD be a US Core Profile.

    Certifying Servers and Clients SHALL support options 1 and 2 as Additional USCDI Requirements.

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL _id token
SHALL patient reference

Search Parameter Combination Summary:

Conformance Parameter Combination Types
SHOULD patient+ status reference+token
SHALL patient+ category+ authored reference+token+date
SHALL patient+ code reference+token
SHOULD patient+ code+ authored reference+token+date
SHALL patient+ category reference+token

Search Parameter Requirements (When Used Alone or in Combination):

  • authored (date):

    A client SHALL provide a value precise to the second + time offset.

    A server SHALL support a value precise to the second + time offset.

  • category (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • code (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

  • patient (reference):

    The client SHALL provide at least a id value and MAY provide both the Type and id values.

    The server SHALL support both.

  • status (token):

    The client SHALL provide at least a code value and MAY provide both the system and code values.

    The server SHALL support both.

Specimen

Conformance Expectation: SHALL

Supported Profiles:

Reference Policy

Profile Interaction Summary:

Fetch and Search Criteria:

Search Parameter Summary:

Conformance Parameter Type
SHALL _id token
SHOULD patient reference

ValueSet

Conformance Expectation: SHOULD

Operation Summary:

" - }, - "url": "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server", - "version": "7.0.0-ballot", - "name": "UsCoreServerCapabilityStatement", - "title": "US Core Server CapabilityStatement", - "status": "active", - "experimental": false, - "date": "2024-03-12T07:31:33.909558-08:00", - "publisher": "HL7 International - Cross-Group Projects", - "contact": [ - { - "telecom": [ - { - "system": "url", - "value": "http://www.hl7.org/Special/committees/cgp" - } - ] - } - ], - "description": "This Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and the ONC [U.S. Core Data for Interoperability (USCDI) Version 4 July 2023](https://www.healthit.gov/sites/isa/files/2023-07/Final-USCDI-Version-4-July-2023-Final.pdf). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.", - "jurisdiction": [ - { - "coding": [ - { - "system": "urn:iso:std:iso:3166", - "code": "US" - } - ] - } - ], - "kind": "requirements", - "instantiates": [ - "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server" - ], - "_instantiates": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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": "server", - "documentation": "The US Core Server **SHALL**:\n\n1. Support the US Core Patient resource profile AND at least one additional resource profile from the list of US Core Profiles AND and all Must Support US Core Profiles and resources it references.\n - The [Table below](#summary-of-must-support-references) summarizes the Must Support references to other US Core Profiles and FHIR resources for each US Core Profile:\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Follow the requirements documented in the [General Requirements](general-requirements.html) and [Must Support](must-support.html) pages\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scopes\n - (Status 404): unknown resource\n1. Support JSON source formats for all US Core interactions.\n\nThe US Core Server **SHOULD**:\n\n1. Follow the guidance documented in the [General Guidance](general-guidance.html) page\n1. Support XML source formats for all US Core interactions.\n1. Identify the US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n", - "security": { - "description": "1. See the [General Security Considerations](security.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` \"Unauthorized\", `HTTP 403` \"Forbidden\", or `HTTP 404` \"Not Found\"" - }, - "resource": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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-allergyintolerance-patient", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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" - }, - { - "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": "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" - } - ], - "type": "CarePlan", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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 - US Core Goal **SHOULD** be present in CarePlan.goal\n - US Core Condition **SHOULD** be present in CarePlan.addresses\n - Assement and Plan **MAY** be included as narrative text", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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" - }, - { - "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" - } - ], - "type": "CareTeam", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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 1. US Core Practitioner Profile\n 1. US Core PractitionerRole Profile\n 1. US Core Patient Profile\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 supports only *US Core Practitioner 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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ], - "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": "SHALL" - } - ] - } - ], - "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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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": "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": "code" - } - ], - "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": "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": "category" - }, - { - "url": "required", - "valueString": "encounter" - } - ], - "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": "SHALL" - }, - { - "url": "required", - "valueString": "patient" - }, - { - "url": "required", - "valueString": "category" - } - ], - "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|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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 NOT** be unknown.\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.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Coverage", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "type" - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" - } - ], - "type": "Device", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* Implantable medical devices that have UDI information **SHALL** represent the UDI code in `Device.udiCarrier.carrierHRF`.\n - All of the five UDI-PI elements that are present in the UDI code **SHALL** be represented in the corresponding US Core Implantable Device Profile element.\n \n UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they **SHOULD** be included to support historical reports of implantable medical devices as follows:\n\n manufacturer -> `Device.manufacturer` \n model -> `Device.model` \n\n* Servers **SHOULD** support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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": "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": "required", - "valueString": "date" - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" - } - ], - "type": "DiagnosticReport", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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": "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" - } - ], - "type": "DocumentReference", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* The `DocumentReference.type` binding **SHALL** support at a minimum the [5 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 * 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.\n * The client application **SHALL** support both elements.\n * The `content.url` may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.\n * If the endpoint is outside the FHIR base URL, it **SHOULD NOT** require additional authorization to access.\n * If there are multiple `DocumentReference.content` element 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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ], - "operation": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "name": "docref", - "definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref", - "documentation": "A server **SHALL** be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. **MAY** provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range. If no date range is supplied, then the server **SHALL** provide references to last or current document(s). **SHOULD** document what resources, if any, are returned as included resources\n\n`GET [base]/DocumentReference/$docref?patient=[id]`" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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": "discharge-disposition" - } - ], - "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": "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" - } - ], - "type": "Encounter", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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 * 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.\n * The client application **SHALL** support both elements.\n * if `Encounter.reasonReference` references 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)\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 * Although both are marked as must support, the server systems are not required to support both `Encounter.location.location` and `Encounter.serviceProvider`, but they **SHALL** support *at least one* of these elements.\n * The client application **SHALL** support both elements.\n", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Endpoint", - "documentation": "The Media Resource is a Must Suppot referenced resource when using the US Core PracitionerRole 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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *day*.\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 PracitionRole 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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "date" - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" - } - ], - "type": "Immunization", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* Based upon the ONC U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes **SHOULD** be supported as translations to them.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Location", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ], - "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", - "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", - "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", - "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", - "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", - "type": "string" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Media", - "documentation": "The Media Resource is a Must Suppot 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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Medication", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "status" - }, - { - "url": "required", - "valueString": "type" - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" - } - ], - "type": "MedicationDispense", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* The MedicationDispense resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.\n\n For example, A server **SHALL** be capable of returning dispense records for all medications for a patient using one of or both:\n\n `GET /MedicationDispense?patient=[id]`\n\n `GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication`\n", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ], - "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": "SHALL" - } - ] - } - ], - "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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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": "intent" - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" - } - ], - "type": "MedicationRequest", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.\n\n For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n\n `GET /MedicationRequest?patient=[id]`\n\n `GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`\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.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ], - "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": "SHALL" - } - ] - } - ], - "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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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": "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": "required", - "valueString": "date" - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" - } - ], - "type": "Observation", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-simple-observation|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-treatment-intervention-preference|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-care-experience-preference|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-screening-assessment|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-average-blood-pressure|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight|7.0.0-ballot", - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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\n\n", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Organization", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* Systems **SHALL** support National Provider Identifier (NPI) for organizations and **SHOULD** support Clinical Laboratory Improvement Amendments (CLIA) identifiers for `Organization.Identifier`.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ], - "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", - "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", - "type": "string" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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" - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - }, - { - "url": "required", - "valueString": "family" - }, - { - "url": "required", - "valueString": "gender" - } - ], - "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": "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": "SHALL" - }, - { - "url": "required", - "valueString": "gender" - }, - { - "url": "required", - "valueString": "name" - } - ], - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" - } - ], - "type": "Patient", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.\n\n 1. contact detail (e.g. a telephone number or an email address)\n 1. a communication language\n 1. a race\n 1. an ethnicity\n 1. a birth sex*\n 1. previous name\n - Previous name is represented by providing an end date in the `Patient.name.period` element for a previous name.\n 1. suffix\n - Suffix is represented using the `Patient.name.suffix` element.\n* The Patient's Social Security Numbers **SHOULD NOT** be used as a patient identifier in `Patient.identifier.value`.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *day*.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *day*.\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", - "type": "string", - "documentation": "A server **SHALL** support a value precise to the *day*." - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "MAY" - } - ], - "name": "gender", - "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - }, - { - "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", - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "string" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Practitioner", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "Servers that support only US Core Practitioner Profile **SHALL** provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.\n", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ], - "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", - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "string" - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "PractitionerRole", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ], - "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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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" - } - ], - "type": "Procedure", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.\n * Only LOINC concepts that reflect actual procedures **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* The Reason or justification for a referral or consultation is communicated through:\n 1. `ServiceRequest.reason` or `ServiceRequest.reason`, and `Procedure.basedOn` that links the Procedure to the US Core ServiceRequest Profile.\n - `ServiceRequest.reasonCode` and `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 - As documented [here](general-guidance.html#referencing-us-core-profiles), when using `ServiceRequest.reasonReference`, the referenced resources **SHOULD** be a US Core Profile.\n 1. `Procedure.reasonCode` or `Procedure.reasonReference` when the Procedure does not have an associated ServiceRequest.\n - Although both `Procedure.reasonCode` and `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 - As documented [here](general-guidance.html#referencing-us-core-profiles), when using `Procedure.reasonReference`, the referenced resources **SHOULD** be a US Core Profile.\n\n Certifying Servers and Clients **SHALL** support options 1 and 2 as Additional USCDI Requirements.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Provenance", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* The US Core Provenance resource **SHALL** be supported for these US Core resources:\n * AllergyIntolerance\n * CarePlan\n * CareTeam\n * Condition\n * Coverage\n * Device\n * DiagnosticReport\n * DocumentReference\n * Encounter\n * Goal\n * Immunization\n * MedicationDispense\n * MedicationRequest\n * Observation\n * Patient\n * Procedure\n * QuestionnaireResponse\n * RelatedPerson\n * ServiceRequest\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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHOULD" - } - ] - } - ] - }, - { - "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" - } - ] - } - ], - "documentation": "US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n- Observation: US Core Observation Screening Assessment Profile\n- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile\n\nUS 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": "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": "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" - } - ], - "type": "QuestionnaireResponse", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n- Observation: US Core Observation Screening Assessment Profile\n- Questionnaire/QuestionnaireResponse: SDC Base Questionnaire/US Core QuestionnaireResponse Profile\n\nUS 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", - "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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "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", - "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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - }, - { - "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": "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": "code" - } - ], - "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": "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" - } - ], - "type": "ServiceRequest", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "documentation": "* The Reason or justification for a referral or consultation is communicated through:\n 1. `ServiceRequest.reason` or `ServiceRequest.reason`, and `Procedure.basedOn` that links the Procedure to the US Core ServiceRequest Profile.\n - `ServiceRequest.reasonCode` and `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 - As documented [here](general-guidance.html#referencing-us-core-profiles), when using `ServiceRequest.reasonReference`, the referenced resources **SHOULD** be a US Core Profile.\n 1. `Procedure.reasonCode` or `Procedure.reasonReference` when the Procedure does not have an associated ServiceRequest.\n - Although both `Procedure.reasonCode` and `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 - As documented [here](general-guidance.html#referencing-us-core-profiles), when using `Procedure.reasonReference`, the referenced resources **SHOULD** be a US Core Profile.\n\n Certifying Servers and Clients **SHALL** support options 1 and 2 as Additional USCDI Requirements.", - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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": "SHALL" - } - ] - } - ], - "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", - "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", - "type": "date", - "documentation": "A client **SHALL** provide a value precise to the *second + time offset*.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\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", - "type": "reference", - "documentation": "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\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", - "type": "token", - "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both." - } - ] - }, - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ], - "type": "Specimen", - "supportedProfile": [ - "http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|7.0.0-ballot" - ], - "_supportedProfile": [ - { - "extension": [ - { - "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", - "valueCode": "SHALL" - } - ] - } - ], - "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" - } - ], - "referencePolicy": [ - "resolves" - ], - "_referencePolicy": [ - { - "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-specimen-id", - "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", - "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", - "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" - } - ] - } - ] -} \ No newline at end of file