Medplum

From 42f7ef13830d49bb845d859c248e59515493d3e7 Mon Sep 17 00:00:00 2001 From: Rahul Agarwal <rahul@medplum.com> Date: Mon, 29 Apr 2024 21:35:07 -0700 Subject: [PATCH] Add ONC Required text --- .../docs/api/fhir/resources/allergyintolerance.mdx | 2 +- packages/docs/docs/api/fhir/resources/careplan.mdx | 2 +- packages/docs/docs/api/fhir/resources/careteam.mdx | 2 +- packages/docs/docs/api/fhir/resources/condition.mdx | 2 +- packages/docs/docs/api/fhir/resources/device.mdx | 2 +- .../docs/api/fhir/resources/diagnosticreport.mdx | 2 +- .../docs/api/fhir/resources/documentreference.mdx | 2 +- packages/docs/docs/api/fhir/resources/encounter.mdx | 2 +- packages/docs/docs/api/fhir/resources/goal.mdx | 2 +- .../docs/docs/api/fhir/resources/immunization.mdx | 2 +- .../docs/docs/api/fhir/resources/medication.mdx | 2 +- .../docs/api/fhir/resources/medicationrequest.mdx | 2 +- .../docs/docs/api/fhir/resources/observation.mdx | 13 ++++++++++++- packages/docs/docs/api/fhir/resources/patient.mdx | 6 +++++- packages/docs/docs/api/fhir/resources/procedure.mdx | 2 +- .../docs/docs/api/fhir/resources/provenance.mdx | 2 ++ .../api/fhir/resources/questionnaireresponse.mdx | 2 +- 17 files changed, 33 insertions(+), 16 deletions(-) diff --git a/packages/docs/docs/api/fhir/resources/allergyintolerance.mdx b/packages/docs/docs/api/fhir/resources/allergyintolerance.mdx index 98b141a01..b17fc05ce 100644 --- a/packages/docs/docs/api/fhir/resources/allergyintolerance.mdx +++ b/packages/docs/docs/api/fhir/resources/allergyintolerance.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # AllergyIntolerance -Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. +Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. Refer to the [US Core AllergyIntolerance profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-allergyintolerance.html) details on representing specific substances, statuses and reaction types. <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/careplan.mdx b/packages/docs/docs/api/fhir/resources/careplan.mdx index 375a30a0c..0ab0f3ff8 100644 --- a/packages/docs/docs/api/fhir/resources/careplan.mdx +++ b/packages/docs/docs/api/fhir/resources/careplan.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # CarePlan -Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. +Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. Refer to the [US Core CarePlan profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-careplan.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/careteam.mdx b/packages/docs/docs/api/fhir/resources/careteam.mdx index 2c112cf32..43668dfd0 100644 --- a/packages/docs/docs/api/fhir/resources/careteam.mdx +++ b/packages/docs/docs/api/fhir/resources/careteam.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # CareTeam -The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient. +The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient. Refer to the [US Core CarePlan profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-careplan.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/condition.mdx b/packages/docs/docs/api/fhir/resources/condition.mdx index 50591bf72..a74d5c78f 100644 --- a/packages/docs/docs/api/fhir/resources/condition.mdx +++ b/packages/docs/docs/api/fhir/resources/condition.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Condition -A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. +A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. Refer to the [US Core Condition profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-condition.html) and the US Core [Condition Encounter](http://hl7.org/fhir/us/core/StructureDefinition-us-core-condition-encounter-diagnosis.html) profile. <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/device.mdx b/packages/docs/docs/api/fhir/resources/device.mdx index 939c0e76a..9a6a4eb65 100644 --- a/packages/docs/docs/api/fhir/resources/device.mdx +++ b/packages/docs/docs/api/fhir/resources/device.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Device -A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. +A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. For more on implantable devices, refer to [US Core Implantable Device Profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-implantable-device.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/diagnosticreport.mdx b/packages/docs/docs/api/fhir/resources/diagnosticreport.mdx index 3c059ebd5..963d18655 100644 --- a/packages/docs/docs/api/fhir/resources/diagnosticreport.mdx +++ b/packages/docs/docs/api/fhir/resources/diagnosticreport.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # DiagnosticReport -The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. +The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. Refer to the [US Core DiagnosticReport profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-diagnosticreport-note.html) for Report and Note exchange. <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/documentreference.mdx b/packages/docs/docs/api/fhir/resources/documentreference.mdx index 64530d78f..0036de135 100644 --- a/packages/docs/docs/api/fhir/resources/documentreference.mdx +++ b/packages/docs/docs/api/fhir/resources/documentreference.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # DocumentReference -A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. +A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text. Refer to the [US Core DocumentReference profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-documentreference.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/encounter.mdx b/packages/docs/docs/api/fhir/resources/encounter.mdx index 7842d62f4..e7afc035e 100644 --- a/packages/docs/docs/api/fhir/resources/encounter.mdx +++ b/packages/docs/docs/api/fhir/resources/encounter.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Encounter -An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. +An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. Refer to the US Core [Encounter](http://hl7.org/fhir/us/core/StructureDefinition-us-core-encounter.html) Profile and the US Core [Condition Encounter](http://hl7.org/fhir/us/core/StructureDefinition-us-core-condition-encounter-diagnosis.html) profile. <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/goal.mdx b/packages/docs/docs/api/fhir/resources/goal.mdx index ac3a79e3e..11a83f4d3 100644 --- a/packages/docs/docs/api/fhir/resources/goal.mdx +++ b/packages/docs/docs/api/fhir/resources/goal.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Goal -Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc. +Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc. Refer to the [US Core Goal profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-goal.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/immunization.mdx b/packages/docs/docs/api/fhir/resources/immunization.mdx index fc2fa735f..ecdb2f51a 100644 --- a/packages/docs/docs/api/fhir/resources/immunization.mdx +++ b/packages/docs/docs/api/fhir/resources/immunization.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Immunization -Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. +Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. Refer to the [US Core Immunizations profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-immunization.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/medication.mdx b/packages/docs/docs/api/fhir/resources/medication.mdx index b3bd93301..db125c58d 100644 --- a/packages/docs/docs/api/fhir/resources/medication.mdx +++ b/packages/docs/docs/api/fhir/resources/medication.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Medication -This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. +This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. Refer to the [US Core Medication profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-medication.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/medicationrequest.mdx b/packages/docs/docs/api/fhir/resources/medicationrequest.mdx index f056fa732..fd4386afe 100644 --- a/packages/docs/docs/api/fhir/resources/medicationrequest.mdx +++ b/packages/docs/docs/api/fhir/resources/medicationrequest.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # MedicationRequest -An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. +An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. Refer to the [US Core Medication Request profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-medicationrequest.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/observation.mdx b/packages/docs/docs/api/fhir/resources/observation.mdx index 209a4d957..0a0d0d0bd 100644 --- a/packages/docs/docs/api/fhir/resources/observation.mdx +++ b/packages/docs/docs/api/fhir/resources/observation.mdx @@ -11,7 +11,18 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Observation -Measurements and simple assertions made about a patient, device or other subject. +Measurements and simple assertions made about a patient, device or other subject. US Core Profiles related to Observations are as follows: + +- [US Core Laboratory Result profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-observation-lab.html) +- [US Core Smoking Status Observation profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-smokingstatus.html). +- [US Core Pulse Oximetry Profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-pulse-oximetry.html) +- [US Core Pediatric BMI for Age Profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-pediatric-bmi-for-age.html) +- [US Core Pediatric Weight for Height](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-pediatric-weight-for-height.html) +- [US Core Pediatric Head Circumference](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-head-occipital-frontal-circumference-percentile.html) +- [US Core Observation Survey](http://hl7.org/fhir/us/core/StructureDefinition-us-core-observation-survey.html) +- [US Core Observation Social History](http://hl7.org/fhir/us/core/StructureDefinition-us-core-observation-social-history.html) +- [US Core Clinical Test Result](http://hl7.org/fhir/us/core/StructureDefinition-us-core-observation-clinical-test.html) +- [US Core Observation Sexual Orientation](http://hl7.org/fhir/us/core/StructureDefinition-us-core-observation-sexual-orientation.html) <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/patient.mdx b/packages/docs/docs/api/fhir/resources/patient.mdx index a49f052a1..7e2740c7b 100644 --- a/packages/docs/docs/api/fhir/resources/patient.mdx +++ b/packages/docs/docs/api/fhir/resources/patient.mdx @@ -11,7 +11,11 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Patient -Demographics and other administrative information about an individual or animal receiving care or other health-related services. +Demographics and other administrative information about an individual or animal receiving care or other health-related services. Refer to the following profiles for information on representing specific details: + +- [US Core Patient profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-patient.html). +- [US Core Gender Identity Extension](http://hl7.org/fhir/us/core/StructureDefinition-us-core-genderIdentity.html). +- [US Core Birth Sex Extension](http://hl7.org/fhir/us/core/StructureDefinition-us-core-birthsex.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/procedure.mdx b/packages/docs/docs/api/fhir/resources/procedure.mdx index fc6cabd0b..2fadb604c 100644 --- a/packages/docs/docs/api/fhir/resources/procedure.mdx +++ b/packages/docs/docs/api/fhir/resources/procedure.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # Procedure -An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy. +An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy. Refer to the [US Core Procedure profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-procedure.html). <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/provenance.mdx b/packages/docs/docs/api/fhir/resources/provenance.mdx index 230e091c3..46bf6b67a 100644 --- a/packages/docs/docs/api/fhir/resources/provenance.mdx +++ b/packages/docs/docs/api/fhir/resources/provenance.mdx @@ -13,6 +13,8 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. <Link to="/docs/api/fhir/resources/provenance">Provenance</Link> provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. <Link to="/docs/api/fhir/resources/provenance">Provenance</Link> assertions are a form of contextual metadata and can themselves become important records with their own provenance. <Link to="/docs/api/fhir/resources/provenance">Provenance</Link> statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. +Refer to the [US Core Provenance profile](https://hl7.org/fhir/us/core/stu3.1.1/StructureDefinition-us-core-provenance.html). + <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> diff --git a/packages/docs/docs/api/fhir/resources/questionnaireresponse.mdx b/packages/docs/docs/api/fhir/resources/questionnaireresponse.mdx index 4dbc2e961..98d5da628 100644 --- a/packages/docs/docs/api/fhir/resources/questionnaireresponse.mdx +++ b/packages/docs/docs/api/fhir/resources/questionnaireresponse.mdx @@ -11,7 +11,7 @@ import { ResourcePropertiesTable, SearchParamsTable } from '@site/src/components # QuestionnaireResponse -A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to. +A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to. Read related on [US Core QuestionnaireResponse](http://hl7.org/fhir/us/core/StructureDefinition-us-core-questionnaireresponse.html) profile. <Tabs queryString="section"> <TabItem value="schema" label="Schema" default> -- 2.39.3 (Apple Git-146)