diff --git a/schemas/graph/Annotation.yaml b/schemas/graph/Annotation.yaml index e109bdc..07c6336 100644 --- a/schemas/graph/Annotation.yaml +++ b/schemas/graph/Annotation.yaml @@ -3,6 +3,36 @@ additionalProperties: false description: Text node with attribution. A text note which also contains information about who made the statement and when. [See https://hl7.org/fhir/R5/Annotation.html] links: +- href: Practitioner/{id} + rel: authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /authorReference/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /authorReference/reference + templateRequired: + - id - href: Patient/{id} rel: authorReference_Patient targetHints: @@ -18,6 +48,21 @@ links: id: /authorReference/reference templateRequired: - id +- href: Organization/{id} + rel: authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /authorReference/reference + templateRequired: + - id properties: _authorString: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/BodyStructure.yaml b/schemas/graph/BodyStructure.yaml index 4e4686c..76f6278 100644 --- a/schemas/graph/BodyStructure.yaml +++ b/schemas/graph/BodyStructure.yaml @@ -3,6 +3,22 @@ additionalProperties: false description: Specific and identified anatomical structure. Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case. [See https://hl7.org/fhir/R5/BodyStructure.html] +links: +- href: Patient/{id} + rel: patient + targetHints: + backref: + - body_structure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /patient/reference + templateRequired: + - id properties: _active: $ref: FHIRPrimitiveExtension.yaml @@ -115,6 +131,10 @@ properties: pattern: ^[^\s]+(\s[^\s]+)*$ title: Language of the resource content type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array meta: $ref: Meta.yaml description: The metadata about the resource. This is content that is maintained diff --git a/schemas/graph/BodyStructureIncludedStructure.yaml b/schemas/graph/BodyStructureIncludedStructure.yaml index bfcaf37..02d12b4 100644 --- a/schemas/graph/BodyStructureIncludedStructure.yaml +++ b/schemas/graph/BodyStructureIncludedStructure.yaml @@ -2,6 +2,7 @@ $id: BodyStructureIncludedStructure additionalProperties: false description: Included anatomic location(s). The anatomical location(s) or region(s) of the specimen, lesion, or body structure. [See https://hl7.org/fhir/R5/BodyStructureIncludedStructure.html] +links: [] properties: bodyLandmarkOrientation: description: Body locations in relation to a specific body landmark (tatoo, scar, @@ -45,6 +46,10 @@ properties: binding_version: null element_property: true title: Code that represents the included structure laterality + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientation.yaml b/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientation.yaml index 30330cf..f8a3899 100644 --- a/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientation.yaml +++ b/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientation.yaml @@ -2,6 +2,7 @@ $id: BodyStructureIncludedStructureBodyLandmarkOrientation additionalProperties: false description: Landmark relative location. Body locations in relation to a specific body landmark (tatoo, scar, other body structure). [See https://hl7.org/fhir/R5/BodyStructureIncludedStructureBodyLandmarkOrientation.html] +links: [] properties: clockFacePosition: binding_description: Select SNOMED CT codes. A set of codes that describe a things @@ -63,6 +64,10 @@ properties: $ref: CodeableConcept.yaml title: Body ]andmark description type: array + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark.yaml b/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark.yaml index b231e79..1381be9 100644 --- a/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark.yaml +++ b/schemas/graph/BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark.yaml @@ -2,6 +2,7 @@ $id: BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark additionalProperties: false description: Landmark relative location. The distance in centimeters a certain observation is made from a body landmark. [See https://hl7.org/fhir/R5/BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark.html] +links: [] properties: device: backref: device_body_structure_included_structure_body_landmark_orientation_distance_from_landmark @@ -43,6 +44,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/Condition.yaml b/schemas/graph/Condition.yaml index ea72d94..e202466 100644 --- a/schemas/graph/Condition.yaml +++ b/schemas/graph/Condition.yaml @@ -4,6 +4,21 @@ description: Detailed information about conditions, problems or diagnoses. A cli condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. [See https://hl7.org/fhir/R5/Condition.html] links: +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - condition + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id - href: Patient/{id} rel: subject_Patient targetHints: @@ -19,6 +34,38 @@ links: id: /subject/reference templateRequired: - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -35,6 +82,54 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From ConditionParticipant/participant + href: Practitioner/{id} + rel: participant_actor_Practitioner + targetHints: + backref: + - condition_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id +- $comment: From ConditionParticipant/participant + href: PractitionerRole/{id} + rel: participant_actor_PractitionerRole + targetHints: + backref: + - condition_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id - $comment: From ConditionParticipant/participant href: Patient/{id} rel: participant_actor_Patient @@ -51,6 +146,38 @@ links: id: /participant/-/actor/reference templateRequired: - id +- $comment: From ConditionParticipant/participant + href: Organization/{id} + rel: participant_actor_Organization + targetHints: + backref: + - condition_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id +- $comment: From ConditionStage/stage + href: DiagnosticReport/{id} + rel: stage_assessment_DiagnosticReport + targetHints: + backref: + - assessment_condition_stage + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: DiagnosticReport.yaml + templatePointers: + id: /stage/-/assessment/-/reference + templateRequired: + - id - $comment: From ConditionStage/stage href: Observation/{id} rel: stage_assessment_Observation diff --git a/schemas/graph/ConditionParticipant.yaml b/schemas/graph/ConditionParticipant.yaml index b867d0b..13967d1 100644 --- a/schemas/graph/ConditionParticipant.yaml +++ b/schemas/graph/ConditionParticipant.yaml @@ -4,6 +4,36 @@ description: Who or what participated in the activities related to the condition how they were involved. Indicates who or what participated in the activities related to the condition and how they were involved. [See https://hl7.org/fhir/R5/ConditionParticipant.html] links: +- href: Practitioner/{id} + rel: actor_Practitioner + targetHints: + backref: + - condition_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: actor_PractitionerRole + targetHints: + backref: + - condition_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id - href: Patient/{id} rel: actor_Patient targetHints: @@ -19,6 +49,21 @@ links: id: /actor/reference templateRequired: - id +- href: Organization/{id} + rel: actor_Organization + targetHints: + backref: + - condition_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id properties: actor: $ref: Reference.yaml diff --git a/schemas/graph/ConditionStage.yaml b/schemas/graph/ConditionStage.yaml index 216a495..15f1b47 100644 --- a/schemas/graph/ConditionStage.yaml +++ b/schemas/graph/ConditionStage.yaml @@ -5,6 +5,21 @@ description: Stage/grade, usually assessed formally. A simple summary of the sta such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease. [See https://hl7.org/fhir/R5/ConditionStage.html] links: +- href: DiagnosticReport/{id} + rel: assessment_DiagnosticReport + targetHints: + backref: + - assessment_condition_stage + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: DiagnosticReport.yaml + templatePointers: + id: /assessment/-/reference + templateRequired: + - id - href: Observation/{id} rel: assessment_Observation targetHints: diff --git a/schemas/graph/DiagnosticReport.yaml b/schemas/graph/DiagnosticReport.yaml index 81ffcc6..56d32d0 100644 --- a/schemas/graph/DiagnosticReport.yaml +++ b/schemas/graph/DiagnosticReport.yaml @@ -8,6 +8,360 @@ description: A Diagnostic report - a combination of request information, atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. [See https://hl7.org/fhir/R5/DiagnosticReport.html] +links: +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - diagnostic_report + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: performer_Practitioner + targetHints: + backref: + - performer_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /performer/-/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: performer_PractitionerRole + targetHints: + backref: + - performer_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /performer/-/reference + templateRequired: + - id +- href: Organization/{id} + rel: performer_Organization + targetHints: + backref: + - performer_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /performer/-/reference + templateRequired: + - id +- href: Observation/{id} + rel: result + targetHints: + backref: + - result_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Observation.yaml + templatePointers: + id: /result/-/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: resultsInterpreter_Practitioner + targetHints: + backref: + - resultsInterpreter_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /resultsInterpreter/-/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: resultsInterpreter_PractitionerRole + targetHints: + backref: + - resultsInterpreter_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /resultsInterpreter/-/reference + templateRequired: + - id +- href: Organization/{id} + rel: resultsInterpreter_Organization + targetHints: + backref: + - resultsInterpreter_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /resultsInterpreter/-/reference + templateRequired: + - id +- href: Specimen/{id} + rel: specimen + targetHints: + backref: + - specimen_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Specimen.yaml + templatePointers: + id: /specimen/-/reference + templateRequired: + - id +- href: ImagingStudy/{id} + rel: study_ImagingStudy + targetHints: + backref: + - study_diagnostic_report + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: ImagingStudy.yaml + templatePointers: + id: /study/-/reference + templateRequired: + - id +- href: Patient/{id} + rel: subject_Patient + targetHints: + backref: + - subject_diagnostic_report + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Organization/{id} + rel: subject_Organization + targetHints: + backref: + - subject_diagnostic_report + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: subject_Practitioner + targetHints: + backref: + - subject_diagnostic_report + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Medication/{id} + rel: subject_Medication + targetHints: + backref: + - subject_diagnostic_report + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Medication.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Substance/{id} + rel: subject_Substance + targetHints: + backref: + - subject_diagnostic_report + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Substance.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- $comment: From DiagnosticReportMedia/media + href: DocumentReference/{id} + rel: media_link + targetHints: + backref: + - diagnostic_report_media + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: DocumentReference.yaml + templatePointers: + id: /media/-/link/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Patient/{id} + rel: note_authorReference_Patient + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From DiagnosticReportSupportingInfo/supportingInfo + href: Procedure/{id} + rel: supportingInfo_reference_Procedure + targetHints: + backref: + - diagnostic_report_supporting_info + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /supportingInfo/-/reference/reference + templateRequired: + - id +- $comment: From DiagnosticReportSupportingInfo/supportingInfo + href: Observation/{id} + rel: supportingInfo_reference_Observation + targetHints: + backref: + - diagnostic_report_supporting_info + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Observation.yaml + templatePointers: + id: /supportingInfo/-/reference/reference + templateRequired: + - id +- $comment: From DiagnosticReportSupportingInfo/supportingInfo + href: DiagnosticReport/{id} + rel: supportingInfo_reference_DiagnosticReport + targetHints: + backref: + - diagnostic_report_supporting_info + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: DiagnosticReport.yaml + templatePointers: + id: /supportingInfo/-/reference/reference + templateRequired: + - id properties: _conclusion: $ref: FHIRPrimitiveExtension.yaml @@ -193,6 +547,10 @@ properties: pattern: ^[^\s]+(\s[^\s]+)*$ title: Language of the resource content type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array media: description: A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly diff --git a/schemas/graph/DiagnosticReportMedia.yaml b/schemas/graph/DiagnosticReportMedia.yaml index a48a830..84ada38 100644 --- a/schemas/graph/DiagnosticReportMedia.yaml +++ b/schemas/graph/DiagnosticReportMedia.yaml @@ -4,6 +4,22 @@ description: Key images or data associated with this report. A list of key image or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). [See https://hl7.org/fhir/R5/DiagnosticReportMedia.html] +links: +- href: DocumentReference/{id} + rel: link + targetHints: + backref: + - diagnostic_report_media + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: DocumentReference.yaml + templatePointers: + id: /link/reference + templateRequired: + - id properties: _comment: $ref: FHIRPrimitiveExtension.yaml @@ -49,6 +65,10 @@ properties: enum_reference_types: - DocumentReference title: Reference to the image or data source + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/DiagnosticReportSupportingInfo.yaml b/schemas/graph/DiagnosticReportSupportingInfo.yaml index 2b9d70e..3fa149e 100644 --- a/schemas/graph/DiagnosticReportSupportingInfo.yaml +++ b/schemas/graph/DiagnosticReportSupportingInfo.yaml @@ -3,6 +3,52 @@ additionalProperties: false description: Additional information supporting the diagnostic report. This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. [See https://hl7.org/fhir/R5/DiagnosticReportSupportingInfo.html] +links: +- href: Procedure/{id} + rel: reference_Procedure + targetHints: + backref: + - diagnostic_report_supporting_info + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /reference/reference + templateRequired: + - id +- href: Observation/{id} + rel: reference_Observation + targetHints: + backref: + - diagnostic_report_supporting_info + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Observation.yaml + templatePointers: + id: /reference/reference + templateRequired: + - id +- href: DiagnosticReport/{id} + rel: reference_DiagnosticReport + targetHints: + backref: + - diagnostic_report_supporting_info + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: DiagnosticReport.yaml + templatePointers: + id: /reference/reference + templateRequired: + - id properties: extension: description: May be used to represent additional information that is not part @@ -30,6 +76,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/DocumentReference.yaml b/schemas/graph/DocumentReference.yaml index 84f16fe..51ab5a0 100644 --- a/schemas/graph/DocumentReference.yaml +++ b/schemas/graph/DocumentReference.yaml @@ -10,6 +10,51 @@ description: "A reference to a document. A reference to a document of any kind f \ and managed. The actual content may be inline base64 encoded data or provided\ \ by direct reference. [See https://hl7.org/fhir/R5/DocumentReference.html]" links: +- href: Practitioner/{id} + rel: author_Practitioner + targetHints: + backref: + - author_document_reference + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /author/-/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: author_PractitionerRole + targetHints: + backref: + - author_document_reference + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /author/-/reference + templateRequired: + - id +- href: Organization/{id} + rel: author_Organization + targetHints: + backref: + - author_document_reference + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /author/-/reference + templateRequired: + - id - href: Patient/{id} rel: author_Patient targetHints: @@ -25,19 +70,34 @@ links: id: /author/-/reference templateRequired: - id -- href: MedicationRequest/{id} - rel: basedOn_MedicationRequest +- href: Encounter/{id} + rel: context_Encounter targetHints: backref: - - basedOn_document_reference + - context_document_reference direction: - outbound multiplicity: - has_many targetSchema: - $ref: MedicationRequest.yaml + $ref: Encounter.yaml templatePointers: - id: /basedOn/-/reference + id: /context/-/reference + templateRequired: + - id +- href: Organization/{id} + rel: custodian + targetHints: + backref: + - custodian_document_reference + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /custodian/reference templateRequired: - id - href: Resource/{id} @@ -71,6 +131,54 @@ links: id: /attester/-/party/reference templateRequired: - id +- $comment: From DocumentReferenceAttester/attester + href: Practitioner/{id} + rel: attester_party_Practitioner + targetHints: + backref: + - document_reference_attester + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /attester/-/party/reference + templateRequired: + - id +- $comment: From DocumentReferenceAttester/attester + href: PractitionerRole/{id} + rel: attester_party_PractitionerRole + targetHints: + backref: + - document_reference_attester + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /attester/-/party/reference + templateRequired: + - id +- $comment: From DocumentReferenceAttester/attester + href: Organization/{id} + rel: attester_party_Organization + targetHints: + backref: + - document_reference_attester + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /attester/-/party/reference + templateRequired: + - id - $comment: From DocumentReferenceRelatesTo/relatesTo href: DocumentReference/{id} rel: relatesTo_target diff --git a/schemas/graph/DocumentReferenceAttester.yaml b/schemas/graph/DocumentReferenceAttester.yaml index 457821e..cd24e8d 100644 --- a/schemas/graph/DocumentReferenceAttester.yaml +++ b/schemas/graph/DocumentReferenceAttester.yaml @@ -18,6 +18,51 @@ links: id: /party/reference templateRequired: - id +- href: Practitioner/{id} + rel: party_Practitioner + targetHints: + backref: + - document_reference_attester + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /party/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: party_PractitionerRole + targetHints: + backref: + - document_reference_attester + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /party/reference + templateRequired: + - id +- href: Organization/{id} + rel: party_Organization + targetHints: + backref: + - document_reference_attester + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /party/reference + templateRequired: + - id properties: _time: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/Encounter.yaml b/schemas/graph/Encounter.yaml index ba3864e..cac63c2 100644 --- a/schemas/graph/Encounter.yaml +++ b/schemas/graph/Encounter.yaml @@ -5,6 +5,132 @@ description: An interaction during which services are provided to the patient. A healthcare service(s) or assessing the health status of a patient. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities. [See https://hl7.org/fhir/R5/Encounter.html] +links: +- href: Encounter/{id} + rel: partOf + targetHints: + backref: + - encounter + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /partOf/reference + templateRequired: + - id +- href: Organization/{id} + rel: serviceProvider + targetHints: + backref: + - encounter + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /serviceProvider/reference + templateRequired: + - id +- href: Patient/{id} + rel: subject_Patient + targetHints: + backref: + - encounter + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- $comment: From EncounterAdmission/admission + href: Organization/{id} + rel: admission_destination_Organization + targetHints: + backref: + - destination_encounter_admission + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /admission/destination/reference + templateRequired: + - id +- $comment: From EncounterAdmission/admission + href: Organization/{id} + rel: admission_origin_Organization + targetHints: + backref: + - origin_encounter_admission + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /admission/origin/reference + templateRequired: + - id +- $comment: From EncounterParticipant/participant + href: Patient/{id} + rel: participant_actor_Patient + targetHints: + backref: + - encounter_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id +- $comment: From EncounterParticipant/participant + href: Practitioner/{id} + rel: participant_actor_Practitioner + targetHints: + backref: + - encounter_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id +- $comment: From EncounterParticipant/participant + href: PractitionerRole/{id} + rel: participant_actor_PractitionerRole + targetHints: + backref: + - encounter_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id properties: _implicitRules: $ref: FHIRPrimitiveExtension.yaml @@ -193,6 +319,10 @@ properties: and end values. element_property: true title: Actual quantity of time the encounter lasted (less time absent) + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array location: description: List of locations where the patient has been during this encounter. element_property: true diff --git a/schemas/graph/EncounterAdmission.yaml b/schemas/graph/EncounterAdmission.yaml index c5b5dd4..f3eb9c0 100644 --- a/schemas/graph/EncounterAdmission.yaml +++ b/schemas/graph/EncounterAdmission.yaml @@ -4,6 +4,37 @@ description: Details about the admission to a healthcare service. Details about stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge. [See https://hl7.org/fhir/R5/EncounterAdmission.html] +links: +- href: Organization/{id} + rel: destination_Organization + targetHints: + backref: + - destination_encounter_admission + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /destination/reference + templateRequired: + - id +- href: Organization/{id} + rel: origin_Organization + targetHints: + backref: + - origin_encounter_admission + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /origin/reference + templateRequired: + - id properties: admitSource: $ref: CodeableConcept.yaml @@ -55,6 +86,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/EncounterDiagnosis.yaml b/schemas/graph/EncounterDiagnosis.yaml index e87f7a7..48af075 100644 --- a/schemas/graph/EncounterDiagnosis.yaml +++ b/schemas/graph/EncounterDiagnosis.yaml @@ -1,6 +1,7 @@ $id: EncounterDiagnosis additionalProperties: false description: The list of diagnosis relevant to this encounter. [See https://hl7.org/fhir/R5/EncounterDiagnosis.html] +links: [] properties: condition: backref: condition_encounter_diagnosis @@ -44,6 +45,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/EncounterLocation.yaml b/schemas/graph/EncounterLocation.yaml index b31428b..bd9e964 100644 --- a/schemas/graph/EncounterLocation.yaml +++ b/schemas/graph/EncounterLocation.yaml @@ -2,6 +2,7 @@ $id: EncounterLocation additionalProperties: false description: List of locations where the patient has been. List of locations where the patient has been during this encounter. [See https://hl7.org/fhir/R5/EncounterLocation.html] +links: [] properties: _status: $ref: FHIRPrimitiveExtension.yaml @@ -43,6 +44,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array location: $ref: Reference.yaml backref: encounter_location diff --git a/schemas/graph/EncounterParticipant.yaml b/schemas/graph/EncounterParticipant.yaml index 82be1b6..954077f 100644 --- a/schemas/graph/EncounterParticipant.yaml +++ b/schemas/graph/EncounterParticipant.yaml @@ -2,6 +2,52 @@ $id: EncounterParticipant additionalProperties: false description: List of participants involved in the encounter. The list of people responsible for providing the service. [See https://hl7.org/fhir/R5/EncounterParticipant.html] +links: +- href: Patient/{id} + rel: actor_Patient + targetHints: + backref: + - encounter_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: actor_Practitioner + targetHints: + backref: + - encounter_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: actor_PractitionerRole + targetHints: + backref: + - encounter_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id properties: actor: $ref: Reference.yaml @@ -46,6 +92,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/EncounterReason.yaml b/schemas/graph/EncounterReason.yaml index 3c08190..c134b86 100644 --- a/schemas/graph/EncounterReason.yaml +++ b/schemas/graph/EncounterReason.yaml @@ -2,6 +2,7 @@ $id: EncounterReason additionalProperties: false description: The list of medical reasons that are expected to be addressed during the episode of care. [See https://hl7.org/fhir/R5/EncounterReason.html] +links: [] properties: extension: description: May be used to represent additional information that is not part @@ -29,6 +30,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/ExtendedContactDetail.yaml b/schemas/graph/ExtendedContactDetail.yaml index d64117f..6d8c091 100644 --- a/schemas/graph/ExtendedContactDetail.yaml +++ b/schemas/graph/ExtendedContactDetail.yaml @@ -3,7 +3,22 @@ additionalProperties: false description: Contact information. Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization. [See https://hl7.org/fhir/R5/ExtendedContactDetail.html] -links: [] +links: +- href: Organization/{id} + rel: organization + targetHints: + backref: + - extended_contact_detail + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /organization/reference + templateRequired: + - id properties: address: $ref: Address.yaml diff --git a/schemas/graph/Extension.yaml b/schemas/graph/Extension.yaml index 95a43f3..6066fe0 100644 --- a/schemas/graph/Extension.yaml +++ b/schemas/graph/Extension.yaml @@ -3,6 +3,38 @@ additionalProperties: false description: Optional Extensions Element. Optional Extension Element - found in all resources. [See https://hl7.org/fhir/R5/Extension.html] links: +- $comment: From Annotation/valueAnnotation + href: Practitioner/{id} + rel: valueAnnotation_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/valueAnnotation + href: PractitionerRole/{id} + rel: valueAnnotation_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id - $comment: From Annotation/valueAnnotation href: Patient/{id} rel: valueAnnotation_authorReference_Patient @@ -19,6 +51,38 @@ links: id: /valueAnnotation/authorReference/reference templateRequired: - id +- $comment: From Annotation/valueAnnotation + href: Organization/{id} + rel: valueAnnotation_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id +- $comment: From ExtendedContactDetail/valueExtendedContactDetail + href: Organization/{id} + rel: valueExtendedContactDetail_organization + targetHints: + backref: + - extended_contact_detail + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueExtendedContactDetail/organization/reference + templateRequired: + - id - $comment: From RelatedArtifact/valueRelatedArtifact href: Resource/{id} rel: valueRelatedArtifact_resourceReference @@ -35,6 +99,38 @@ links: id: /valueRelatedArtifact/resourceReference/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Practitioner/{id} + rel: valueSignature_onBehalfOf_Practitioner + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: PractitionerRole/{id} + rel: valueSignature_onBehalfOf_PractitionerRole + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id - $comment: From Signature/valueSignature href: Patient/{id} rel: valueSignature_onBehalfOf_Patient @@ -51,6 +147,54 @@ links: id: /valueSignature/onBehalfOf/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Organization/{id} + rel: valueSignature_onBehalfOf_Organization + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: Practitioner/{id} + rel: valueSignature_who_Practitioner + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: PractitionerRole/{id} + rel: valueSignature_who_PractitionerRole + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id - $comment: From Signature/valueSignature href: Patient/{id} rel: valueSignature_who_Patient @@ -67,6 +211,22 @@ links: id: /valueSignature/who/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Organization/{id} + rel: valueSignature_who_Organization + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id - $comment: From UsageContext/valueUsageContext href: ResearchStudy/{id} rel: valueUsageContext_valueReference_ResearchStudy @@ -83,6 +243,22 @@ links: id: /valueUsageContext/valueReference/reference templateRequired: - id +- $comment: From UsageContext/valueUsageContext + href: Organization/{id} + rel: valueUsageContext_valueReference_Organization + targetHints: + backref: + - usage_context + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueUsageContext/valueReference/reference + templateRequired: + - id properties: extension: description: May be used to represent additional information that is not part diff --git a/schemas/graph/FamilyMemberHistory.yaml b/schemas/graph/FamilyMemberHistory.yaml index 99fb41d..19e2c37 100644 --- a/schemas/graph/FamilyMemberHistory.yaml +++ b/schemas/graph/FamilyMemberHistory.yaml @@ -19,6 +19,38 @@ links: id: /patient/reference templateRequired: - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -35,6 +67,54 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From FamilyMemberHistoryParticipant/participant + href: Practitioner/{id} + rel: participant_actor_Practitioner + targetHints: + backref: + - family_member_history_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id +- $comment: From FamilyMemberHistoryParticipant/participant + href: PractitionerRole/{id} + rel: participant_actor_PractitionerRole + targetHints: + backref: + - family_member_history_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id - $comment: From FamilyMemberHistoryParticipant/participant href: Patient/{id} rel: participant_actor_Patient @@ -51,6 +131,22 @@ links: id: /participant/-/actor/reference templateRequired: - id +- $comment: From FamilyMemberHistoryParticipant/participant + href: Organization/{id} + rel: participant_actor_Organization + targetHints: + backref: + - family_member_history_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /participant/-/actor/reference + templateRequired: + - id properties: _ageString: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/FamilyMemberHistoryCondition.yaml b/schemas/graph/FamilyMemberHistoryCondition.yaml index 1bb7dd3..00dbe85 100644 --- a/schemas/graph/FamilyMemberHistoryCondition.yaml +++ b/schemas/graph/FamilyMemberHistoryCondition.yaml @@ -5,6 +5,38 @@ description: Condition that the related person had. The significant Conditions ( to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. [See https://hl7.org/fhir/R5/FamilyMemberHistoryCondition.html] links: +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -21,6 +53,22 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id properties: _contributedToDeath: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/FamilyMemberHistoryParticipant.yaml b/schemas/graph/FamilyMemberHistoryParticipant.yaml index fab6496..cdb63ce 100644 --- a/schemas/graph/FamilyMemberHistoryParticipant.yaml +++ b/schemas/graph/FamilyMemberHistoryParticipant.yaml @@ -4,6 +4,36 @@ description: Who or what participated in the activities related to the family me history and how they were involved. Indicates who or what participated in the activities related to the family member history and how they were involved. [See https://hl7.org/fhir/R5/FamilyMemberHistoryParticipant.html] links: +- href: Practitioner/{id} + rel: actor_Practitioner + targetHints: + backref: + - family_member_history_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: actor_PractitionerRole + targetHints: + backref: + - family_member_history_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id - href: Patient/{id} rel: actor_Patient targetHints: @@ -19,6 +49,21 @@ links: id: /actor/reference templateRequired: - id +- href: Organization/{id} + rel: actor_Organization + targetHints: + backref: + - family_member_history_participant + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id properties: actor: $ref: Reference.yaml diff --git a/schemas/graph/FamilyMemberHistoryProcedure.yaml b/schemas/graph/FamilyMemberHistoryProcedure.yaml index 9f4b312..aa08bdd 100644 --- a/schemas/graph/FamilyMemberHistoryProcedure.yaml +++ b/schemas/graph/FamilyMemberHistoryProcedure.yaml @@ -5,6 +5,38 @@ description: Procedures that the related person had. The significant Procedures to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure. [See https://hl7.org/fhir/R5/FamilyMemberHistoryProcedure.html] links: +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -21,6 +53,22 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id properties: _contributedToDeath: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/Identifier.yaml b/schemas/graph/Identifier.yaml index 8d9eff1..9f97557 100644 --- a/schemas/graph/Identifier.yaml +++ b/schemas/graph/Identifier.yaml @@ -3,7 +3,22 @@ additionalProperties: false description: An identifier intended for computation. An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. [See https://hl7.org/fhir/R5/Identifier.html] -links: [] +links: +- href: Organization/{id} + rel: assigner + targetHints: + backref: + - identifier + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /assigner/reference + templateRequired: + - id properties: _system: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/ImagingStudy.yaml b/schemas/graph/ImagingStudy.yaml new file mode 100644 index 0000000..f134de2 --- /dev/null +++ b/schemas/graph/ImagingStudy.yaml @@ -0,0 +1,502 @@ +$id: ImagingStudy +additionalProperties: false +description: A set of images produced in single study (one or more series of references + images). Representation of the content produced in a DICOM imaging study. A study + comprises a set of series, each of which includes a set of Service-Object Pair Instances + (SOP Instances - images or other data) acquired or produced in a common context. A + series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may + have multiple series of different modalities. [See https://hl7.org/fhir/R5/ImagingStudy.html] +links: +- href: Task/{id} + rel: basedOn_Task + targetHints: + backref: + - basedOn_imaging_study + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Task.yaml + templatePointers: + id: /basedOn/-/reference + templateRequired: + - id +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - imaging_study + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id +- href: Procedure/{id} + rel: partOf + targetHints: + backref: + - partOf_imaging_study + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /partOf/-/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: referrer_Practitioner + targetHints: + backref: + - imaging_study + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /referrer/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: referrer_PractitionerRole + targetHints: + backref: + - imaging_study + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /referrer/reference + templateRequired: + - id +- href: Patient/{id} + rel: subject_Patient + targetHints: + backref: + - imaging_study + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Patient/{id} + rel: note_authorReference_Patient + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From ImagingStudySeries/series + href: Specimen/{id} + rel: series_specimen + targetHints: + backref: + - specimen_imaging_study_series + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Specimen.yaml + templatePointers: + id: /series/-/specimen/-/reference + templateRequired: + - id +properties: + _description: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``description``. + _implicitRules: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``implicitRules``. + _language: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``language``. + _numberOfInstances: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``numberOfInstances``. + _numberOfSeries: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``numberOfSeries``. + _started: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``started``. + _status: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``status``. + basedOn: + backref: basedOn_imaging_study + description: A list of the diagnostic requests that resulted in this imaging study + being performed. + element_property: true + enum_reference_types: + - CarePlan + - ServiceRequest + - Appointment + - AppointmentResponse + - Task + items: + $ref: Reference.yaml + title: Request fulfilled + type: array + contained: + description: These resources do not have an independent existence apart from the + resource that contains them - they cannot be identified independently, nor can + they have their own independent transaction scope. This is allowed to be a Parameters + resource if and only if it is referenced by a resource that provides context/meaning. + element_property: true + items: + $ref: Resource.yaml + title: Contained, inline Resources + type: array + description: + description: The Imaging Manager description of the study. Institution-generated + description or classification of the Study (component) performed. + element_property: true + pattern: '[ \r\n\t\S]+' + title: Institution-generated description + type: string + encounter: + $ref: Reference.yaml + backref: imaging_study + description: The healthcare event (e.g. a patient and healthcare provider interaction) + during which this ImagingStudy is made. + element_property: true + enum_reference_types: + - Encounter + title: Encounter with which this imaging study is associated + endpoint: + backref: endpoint_imaging_study + description: The network service providing access (e.g., query, view, or retrieval) + for the study. See implementation notes for information about using DICOM endpoints. + A study-level endpoint applies to each series in the study, unless overridden + by a series-level endpoint with the same Endpoint.connectionType. + element_property: true + enum_reference_types: + - Endpoint + items: + $ref: Reference.yaml + title: Study access endpoint + type: array + extension: + description: May be used to represent additional information that is not part + of the basic definition of the resource. To make the use of extensions safe + and managable, there is a strict set of governance applied to the definition + and use of extensions. Though any implementer can define an extension, there + is a set of requirements that SHALL be met as part of the definition of the + extension. + element_property: true + items: + $ref: Extension.yaml + title: Additional content defined by implementations + type: array + fhir_comments: + anyOf: + - type: string + - items: + type: string + type: array + element_property: false + title: Fhir Comments + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: Identifiers for the ImagingStudy such as DICOM Study Instance UID. + element_property: true + items: + $ref: Identifier.yaml + title: Identifiers for the whole study + type: array + implicitRules: + description: A reference to a set of rules that were followed when the resource + was constructed, and which must be understood when processing the content. Often, + this is a reference to an implementation guide that defines the special rules + along with other profiles etc. + element_property: true + pattern: \S* + title: A set of rules under which this content was created + type: string + language: + binding_description: IETF language tag for a human language + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/all-languages + binding_version: 5.0.0 + description: The base language in which the resource is written. + element_property: true + pattern: ^[^\s]+(\s[^\s]+)*$ + title: Language of the resource content + type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array + location: + $ref: Reference.yaml + backref: imaging_study + description: The principal physical location where the ImagingStudy was performed. + element_property: true + enum_reference_types: + - Location + title: Where ImagingStudy occurred + meta: + $ref: Meta.yaml + description: The metadata about the resource. This is content that is maintained + by the infrastructure. Changes to the content might not always be associated + with version changes to the resource. + element_property: true + title: Metadata about the resource + modality: + binding_description: Type of acquired data in the instance. + binding_strength: extensible + binding_uri: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + binding_version: null + description: A list of all the distinct values of series.modality. This may include + both acquisition and non-acquisition modalities. + element_property: true + items: + $ref: CodeableConcept.yaml + title: All of the distinct values for series' modalities + type: array + modifierExtension: + description: May be used to represent additional information that is not part + of the basic definition of the resource and that modifies the understanding + of the element that contains it and/or the understanding of the containing element's + descendants. Usually modifier elements provide negation or qualification. To + make the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer is allowed + to define an extension, there is a set of requirements that SHALL be met as + part of the definition of the extension. Applications processing a resource + are required to check for modifier extensions. Modifier extensions SHALL NOT + change the meaning of any elements on Resource or DomainResource (including + cannot change the meaning of modifierExtension itself). + element_property: true + items: + $ref: Extension.yaml + title: Extensions that cannot be ignored + type: array + note: + description: Per the recommended DICOM mapping, this element is derived from the + Study Description attribute (0008,1030). Observations or findings about the + imaging study should be recorded in another resource, e.g. Observation, and + not in this element. + element_property: true + items: + $ref: Annotation.yaml + title: User-defined comments + type: array + numberOfInstances: + description: Number of SOP Instances in Study. This value given may be larger + than the number of instance elements this resource contains due to resource + availability, security, or other factors. This element should be present if + any instance elements are present. + element_property: true + minimum: 0 + title: Number of Study Related Instances + type: integer + numberOfSeries: + description: Number of Series in the Study. This value given may be larger than + the number of series elements this Resource contains due to resource availability, + security, or other factors. This element should be present if any series elements + are present. + element_property: true + minimum: 0 + title: Number of Study Related Series + type: integer + partOf: + backref: partOf_imaging_study + description: A larger event of which this particular ImagingStudy is a component + or step. For example, an ImagingStudy as part of a procedure. + element_property: true + enum_reference_types: + - Procedure + items: + $ref: Reference.yaml + title: Part of referenced event + type: array + procedure: + backref: procedure_imaging_study + binding_description: Use of RadLex is preferred + binding_strength: preferred + binding_uri: http://loinc.org/vs/loinc-rsna-radiology-playbook + binding_version: null + description: This field corresponds to the DICOM Procedure Code Sequence (0008,1032). + This is different from the FHIR Procedure resource that may include the ImagingStudy. + element_property: true + enum_reference_types: + - PlanDefinition + - ActivityDefinition + items: + $ref: CodeableReference.yaml + title: The performed procedure or code + type: array + reason: + backref: reason_imaging_study + binding_description: The reason for the study. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-reason + binding_version: null + description: Description of clinical condition indicating why the ImagingStudy + was requested, and/or Indicates another resource whose existence justifies this + Study. + element_property: true + enum_reference_types: + - Condition + - Observation + - DiagnosticReport + - DocumentReference + items: + $ref: CodeableReference.yaml + title: Why the study was requested / performed + type: array + referrer: + $ref: Reference.yaml + backref: imaging_study + description: The requesting/referring physician. + element_property: true + enum_reference_types: + - Practitioner + - PractitionerRole + title: Referring physician + resourceType: + const: ImagingStudy + default: ImagingStudy + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + series: + description: Each study has one or more series of images or other content. + element_property: true + items: + $ref: ImagingStudySeries.yaml + title: Each study has one or more series of instances + type: array + started: + description: Date and time the study started. + element_property: true + format: date-time + title: When the study was started + type: string + status: + binding_description: The status of the ImagingStudy. + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/imagingstudy-status + binding_version: 5.0.0 + description: The current state of the ImagingStudy resource. This is not the status + of any ServiceRequest or Task resources associated with the ImagingStudy. + element_property: true + element_required: true + enum_values: + - registered + - available + - cancelled + - entered-in-error + - unknown + pattern: ^[^\s]+(\s[^\s]+)*$ + title: registered | available | cancelled | entered-in-error | unknown + type: string + subject: + $ref: Reference.yaml + backref: imaging_study + description: The subject, typically a patient, of the imaging study. + element_property: true + enum_reference_types: + - Patient + - Device + - Group + title: Who or what is the subject of the study + text: + $ref: Narrative.yaml + description: A human-readable narrative that contains a summary of the resource + and can be used to represent the content of the resource to a human. The narrative + need not encode all the structured data, but is required to contain sufficient + detail to make it "clinically safe" for a human to just read the narrative. + Resource definitions may define what content should be represented in the narrative + to ensure clinical safety. + element_property: true + title: Text summary of the resource, for human interpretation +required: +- subject +title: ImagingStudy +type: object diff --git a/schemas/graph/ImagingStudySeries.yaml b/schemas/graph/ImagingStudySeries.yaml new file mode 100644 index 0000000..dea87bc --- /dev/null +++ b/schemas/graph/ImagingStudySeries.yaml @@ -0,0 +1,266 @@ +$id: ImagingStudySeries +additionalProperties: false +description: Each study has one or more series of instances. Each study has one or + more series of images or other content. [See https://hl7.org/fhir/R5/ImagingStudySeries.html] +links: +- href: Specimen/{id} + rel: specimen + targetHints: + backref: + - specimen_imaging_study_series + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Specimen.yaml + templatePointers: + id: /specimen/-/reference + templateRequired: + - id +- $comment: From ImagingStudySeriesPerformer/performer + href: Practitioner/{id} + rel: performer_actor_Practitioner + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From ImagingStudySeriesPerformer/performer + href: PractitionerRole/{id} + rel: performer_actor_PractitionerRole + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From ImagingStudySeriesPerformer/performer + href: Organization/{id} + rel: performer_actor_Organization + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From ImagingStudySeriesPerformer/performer + href: Patient/{id} + rel: performer_actor_Patient + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +properties: + _description: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``description``. + _number: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``number``. + _numberOfInstances: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``numberOfInstances``. + _started: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``started``. + _uid: + $ref: FHIRPrimitiveExtension.yaml + title: Extension field for ``uid``. + bodySite: + $ref: CodeableReference.yaml + backref: imaging_study_series + binding_description: SNOMED CT Body site concepts + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/body-site + binding_version: null + description: The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) + for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of + body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. + element_property: true + enum_reference_types: + - BodyStructure + title: Body part examined + description: + description: A description of the series. + element_property: true + pattern: '[ \r\n\t\S]+' + title: A short human readable summary of the series + type: string + endpoint: + backref: endpoint_imaging_study_series + description: The network service providing access (e.g., query, view, or retrieval) + for this series. See implementation notes for information about using DICOM + endpoints. A series-level endpoint, if present, has precedence over a study-level + endpoint with the same Endpoint.connectionType. + element_property: true + enum_reference_types: + - Endpoint + items: + $ref: Reference.yaml + title: Series access endpoint + type: array + extension: + description: May be used to represent additional information that is not part + of the basic definition of the element. To make the use of extensions safe and + managable, there is a strict set of governance applied to the definition and + use of extensions. Though any implementer can define an extension, there is + a set of requirements that SHALL be met as part of the definition of the extension. + element_property: true + items: + $ref: Extension.yaml + title: Additional content defined by implementations + type: array + fhir_comments: + anyOf: + - type: string + - items: + type: string + type: array + element_property: false + title: Fhir Comments + id: + description: Unique id for the element within a resource (for internal references). + This may be any string value that does not contain spaces. + element_property: true + pattern: '[ \r\n\t\S]+' + title: Unique id for inter-element referencing + type: string + instance: + description: A single SOP instance within the series, e.g. an image, or presentation + state. + element_property: true + items: + $ref: ImagingStudySeriesInstance.yaml + title: A single SOP instance from the series + type: array + laterality: + $ref: CodeableConcept.yaml + binding_description: Codes describing body site laterality (left, right, etc.). + binding_strength: example + binding_uri: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html + binding_version: null + description: The laterality of the (possibly paired) anatomic structures examined. + E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent + with any laterality information indicated in ImagingStudy.series.bodySite. + element_property: true + title: Body part laterality + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array + modality: + $ref: CodeableConcept.yaml + binding_description: Type of acquired data in the instance. + binding_strength: extensible + binding_uri: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + binding_version: null + description: The distinct modality for this series. This may include both acquisition + and non-acquisition modalities. + element_property: true + title: The modality used for this series + modifierExtension: + description: May be used to represent additional information that is not part + of the basic definition of the element and that modifies the understanding of + the element in which it is contained and/or the understanding of the containing + element's descendants. Usually modifier elements provide negation or qualification. + To make the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension. Applications processing a resource are required + to check for modifier extensions. Modifier extensions SHALL NOT change the + meaning of any elements on Resource or DomainResource (including cannot change + the meaning of modifierExtension itself). + element_property: true + items: + $ref: Extension.yaml + title: Extensions that cannot be ignored even if unrecognized + type: array + number: + description: The numeric identifier of this series in the study. + element_property: true + minimum: 0 + title: Numeric identifier of this series + type: integer + numberOfInstances: + description: Number of SOP Instances in the Study. The value given may be larger + than the number of instance elements this resource contains due to resource + availability, security, or other factors. This element should be present if + any instance elements are present. + element_property: true + minimum: 0 + title: Number of Series Related Instances + type: integer + performer: + description: Indicates who or what performed the series and how they were involved. + element_property: true + items: + $ref: ImagingStudySeriesPerformer.yaml + title: Who performed the series + type: array + resourceType: + const: ImagingStudySeries + default: ImagingStudySeries + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + specimen: + backref: specimen_imaging_study_series + description: The specimen imaged, e.g., for whole slide imaging of a biopsy. + element_property: true + enum_reference_types: + - Specimen + items: + $ref: Reference.yaml + title: Specimen imaged + type: array + started: + description: The date and time the series was started. + element_property: true + format: date-time + title: When the series started + type: string + uid: + description: The DICOM Series Instance UID for the series. + element_property: true + element_required: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: DICOM Series Instance UID for the series + type: string +required: +- modality +title: ImagingStudySeries +type: object diff --git a/schemas/graph/LocationPosition.yaml b/schemas/graph/ImagingStudySeriesInstance.yaml similarity index 62% rename from schemas/graph/LocationPosition.yaml rename to schemas/graph/ImagingStudySeriesInstance.yaml index a3af2f6..3f1ec58 100644 --- a/schemas/graph/LocationPosition.yaml +++ b/schemas/graph/ImagingStudySeriesInstance.yaml @@ -1,24 +1,18 @@ -$id: LocationPosition +$id: ImagingStudySeriesInstance additionalProperties: false -description: The absolute geographic location. The absolute geographic location of - the Location, expressed using the WGS84 datum (This is the same co-ordinate system - used in KML). [See https://hl7.org/fhir/R5/LocationPosition.html] +description: A single SOP instance from the series. A single SOP instance within the + series, e.g. an image, or presentation state. [See https://hl7.org/fhir/R5/ImagingStudySeriesInstance.html] +links: [] properties: - _altitude: + _number: $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``altitude``. - _latitude: + title: Extension field for ``number``. + _title: $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``latitude``. - _longitude: + title: Extension field for ``title``. + _uid: $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``longitude``. - altitude: - description: Altitude. The value domain and the interpretation are the same as - for the text of the altitude element in KML (see notes on Location main page). - element_property: true - title: Altitude with WGS84 datum - type: number + title: Extension field for ``uid``. extension: description: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and @@ -45,20 +39,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string - latitude: - description: Latitude. The value domain and the interpretation are the same as - for the text of the latitude element in KML (see notes on Location main page). - element_property: true - element_required: true - title: Latitude with WGS84 datum - type: number - longitude: - description: Longitude. The value domain and the interpretation are the same as - for the text of the longitude element in KML (see notes on Location main page). - element_property: true - element_required: true - title: Longitude with WGS84 datum - type: number + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of @@ -76,11 +60,43 @@ properties: $ref: Extension.yaml title: Extensions that cannot be ignored even if unrecognized type: array + number: + description: The number of instance in the series. + element_property: true + minimum: 0 + title: The number of this instance in the series + type: integer resourceType: - const: LocationPosition - default: LocationPosition + const: ImagingStudySeriesInstance + default: ImagingStudySeriesInstance description: One of the resource types defined as part of FHIR title: Resource Type type: string -title: LocationPosition + sopClass: + $ref: Coding.yaml + binding_description: The sopClass for the instance. + binding_strength: extensible + binding_uri: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 + binding_version: null + description: DICOM instance type. + element_property: true + title: DICOM class type + title: + description: The description of the instance. + element_property: true + pattern: '[ \r\n\t\S]+' + title: Description of instance + type: string + uid: + description: The DICOM SOP Instance UID for this image or other DICOM content. + element_property: true + element_required: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: DICOM SOP Instance UID + type: string +required: +- sopClass +title: ImagingStudySeriesInstance type: object diff --git a/schemas/graph/ImmunizationPerformer.yaml b/schemas/graph/ImagingStudySeriesPerformer.yaml similarity index 55% rename from schemas/graph/ImmunizationPerformer.yaml rename to schemas/graph/ImagingStudySeriesPerformer.yaml index 4bbcda7..cc5022e 100644 --- a/schemas/graph/ImmunizationPerformer.yaml +++ b/schemas/graph/ImagingStudySeriesPerformer.yaml @@ -1,20 +1,84 @@ -$id: ImmunizationPerformer +$id: ImagingStudySeriesPerformer additionalProperties: false -description: Who performed event. Indicates who performed the immunization event. - [See https://hl7.org/fhir/R5/ImmunizationPerformer.html] +description: Who performed the series. Indicates who or what performed the series + and how they were involved. [See https://hl7.org/fhir/R5/ImagingStudySeriesPerformer.html] +links: +- href: Practitioner/{id} + rel: actor_Practitioner + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: actor_PractitionerRole + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: Organization/{id} + rel: actor_Organization + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: Patient/{id} + rel: actor_Patient + targetHints: + backref: + - imaging_study_series_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id properties: actor: $ref: Reference.yaml - backref: immunization_performer - description: The practitioner or organization who performed the action. + backref: imaging_study_series_performer + description: Indicates who or what performed the series. element_property: true enum_reference_types: - Practitioner - PractitionerRole - Organization + - CareTeam - Patient + - Device - RelatedPerson - title: Individual or organization who was performing + - HealthcareService + title: Who performed the series extension: description: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and @@ -36,14 +100,13 @@ properties: title: Fhir Comments function: $ref: CodeableConcept.yaml - binding_description: x + binding_description: The type of involvement of the performer. binding_strength: extensible - binding_uri: http://hl7.org/fhir/ValueSet/immunization-function + binding_uri: http://hl7.org/fhir/ValueSet/series-performer-function binding_version: null - description: Describes the type of performance (e.g. ordering provider, administering - provider, etc.). + description: Distinguishes the type of involvement of the performer in the series. element_property: true - title: What type of performance was done + title: Type of performance id: description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. @@ -51,6 +114,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of @@ -69,12 +136,12 @@ properties: title: Extensions that cannot be ignored even if unrecognized type: array resourceType: - const: ImmunizationPerformer - default: ImmunizationPerformer + const: ImagingStudySeriesPerformer + default: ImagingStudySeriesPerformer description: One of the resource types defined as part of FHIR title: Resource Type type: string required: - actor -title: ImmunizationPerformer +title: ImagingStudySeriesPerformer type: object diff --git a/schemas/graph/Immunization.yaml b/schemas/graph/Immunization.yaml deleted file mode 100644 index a4f847b..0000000 --- a/schemas/graph/Immunization.yaml +++ /dev/null @@ -1,411 +0,0 @@ -$id: Immunization -additionalProperties: false -description: Immunization event information. 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. [See https://hl7.org/fhir/R5/Immunization.html] -properties: - _expirationDate: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``expirationDate``. - _implicitRules: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``implicitRules``. - _isSubpotent: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``isSubpotent``. - _language: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``language``. - _lotNumber: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``lotNumber``. - _occurrenceDateTime: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``occurrenceDateTime``. - _occurrenceString: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``occurrenceString``. - _primarySource: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``primarySource``. - _status: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``status``. - administeredProduct: - $ref: CodeableReference.yaml - backref: immunization - description: An indication of which product was administered to the patient. This - is typically a more detailed representation of the concept conveyed by the vaccineCode - data element. If a Medication resource is referenced, it may be to a stand-alone - resource or a contained resource within the Immunization resource. - element_property: true - enum_reference_types: - - Medication - title: Product that was administered - basedOn: - backref: basedOn_immunization - description: A plan, order or recommendation fulfilled in whole or in part by - this immunization. - element_property: true - enum_reference_types: - - CarePlan - - MedicationRequest - - ServiceRequest - - ImmunizationRecommendation - items: - $ref: Reference.yaml - title: Authority that the immunization event is based on - type: array - contained: - description: These resources do not have an independent existence apart from the - resource that contains them - they cannot be identified independently, nor can - they have their own independent transaction scope. This is allowed to be a Parameters - resource if and only if it is referenced by a resource that provides context/meaning. - element_property: true - items: - $ref: Resource.yaml - title: Contained, inline Resources - type: array - doseQuantity: - $ref: Quantity.yaml - description: The quantity of vaccine product that was administered. - element_property: true - title: Amount of vaccine administered - encounter: - $ref: Reference.yaml - backref: immunization - description: The visit or admission or other contact between patient and health - care provider the immunization was performed as part of. - element_property: true - enum_reference_types: - - Encounter - title: Encounter immunization was part of - expirationDate: - description: Date vaccine batch expires. - element_property: true - format: date - title: Vaccine expiration date - type: string - extension: - description: May be used to represent additional information that is not part - of the basic definition of the resource. To make the use of extensions safe - and managable, there is a strict set of governance applied to the definition - and use of extensions. Though any implementer can define an extension, there - is a set of requirements that SHALL be met as part of the definition of the - extension. - element_property: true - items: - $ref: Extension.yaml - title: Additional content defined by implementations - type: array - fhir_comments: - anyOf: - - type: string - - items: - type: string - type: array - element_property: false - title: Fhir Comments - fundingSource: - $ref: CodeableConcept.yaml - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-funding-source - binding_version: null - description: Indicates the source of the vaccine actually administered. This may - be different than the patient eligibility (e.g. the patient may be eligible - for a publically purchased vaccine but due to inventory issues, vaccine purchased - with private funds was actually administered). - element_property: true - title: Funding source for the vaccine - id: - description: The logical id of the resource, as used in the URL for the resource. - Once assigned, this value never changes. - element_property: true - maxLength: 64 - minLength: 1 - pattern: ^[A-Za-z0-9\-.]+$ - title: Logical id of this artifact - type: string - identifier: - description: A unique identifier assigned to this immunization record. - element_property: true - items: - $ref: Identifier.yaml - title: Business identifier - type: array - implicitRules: - description: A reference to a set of rules that were followed when the resource - was constructed, and which must be understood when processing the content. Often, - this is a reference to an implementation guide that defines the special rules - along with other profiles etc. - element_property: true - pattern: \S* - title: A set of rules under which this content was created - type: string - informationSource: - $ref: CodeableReference.yaml - backref: informationSource_immunization - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-origin - binding_version: null - description: Typically the source of the data when the report of the immunization - event is not based on information from the person who administered the vaccine. - element_property: true - enum_reference_types: - - Patient - - Practitioner - - PractitionerRole - - RelatedPerson - - Organization - title: Indicates the source of a reported record - isSubpotent: - description: Indication if a dose is considered to be subpotent. By default, a - dose should be considered to be potent. - element_property: true - title: Dose potency - type: boolean - language: - binding_description: IETF language tag for a human language - binding_strength: required - binding_uri: http://hl7.org/fhir/ValueSet/all-languages - binding_version: 5.0.0 - description: The base language in which the resource is written. - element_property: true - pattern: ^[^\s]+(\s[^\s]+)*$ - title: Language of the resource content - type: string - location: - $ref: Reference.yaml - backref: immunization - description: The service delivery location where the vaccine administration occurred. - element_property: true - enum_reference_types: - - Location - title: Where immunization occurred - lotNumber: - description: Lot number of the vaccine product. - element_property: true - pattern: '[ \r\n\t\S]+' - title: Vaccine lot number - type: string - manufacturer: - $ref: CodeableReference.yaml - backref: manufacturer_immunization - description: Name of vaccine manufacturer. - element_property: true - enum_reference_types: - - Organization - title: Vaccine manufacturer - meta: - $ref: Meta.yaml - description: The metadata about the resource. This is content that is maintained - by the infrastructure. Changes to the content might not always be associated - with version changes to the resource. - element_property: true - title: Metadata about the resource - modifierExtension: - description: May be used to represent additional information that is not part - of the basic definition of the resource and that modifies the understanding - of the element that contains it and/or the understanding of the containing element's - descendants. Usually modifier elements provide negation or qualification. To - make the use of extensions safe and managable, there is a strict set of governance - applied to the definition and use of extensions. Though any implementer is allowed - to define an extension, there is a set of requirements that SHALL be met as - part of the definition of the extension. Applications processing a resource - are required to check for modifier extensions. Modifier extensions SHALL NOT - change the meaning of any elements on Resource or DomainResource (including - cannot change the meaning of modifierExtension itself). - element_property: true - items: - $ref: Extension.yaml - title: Extensions that cannot be ignored - type: array - note: - description: Extra information about the immunization that is not conveyed by - the other attributes. - element_property: true - items: - $ref: Annotation.yaml - title: Additional immunization notes - type: array - occurrenceDateTime: - description: Date vaccine administered or was to be administered. - element_property: true - format: date-time - one_of_many: occurrence - one_of_many_required: true - title: Vaccine administration date - type: string - occurrenceString: - description: Date vaccine administered or was to be administered. - element_property: true - one_of_many: occurrence - one_of_many_required: true - pattern: '[ \r\n\t\S]+' - title: Vaccine administration date - type: string - patient: - $ref: Reference.yaml - backref: patient_immunization - description: The patient who either received or did not receive the immunization. - element_property: true - enum_reference_types: - - Patient - title: Who was immunized - performer: - description: Indicates who performed the immunization event. - element_property: true - items: - $ref: ImmunizationPerformer.yaml - title: Who performed event - type: array - primarySource: - description: Indicates whether the data contained in the resource was captured - by the individual/organization which was responsible for the administration - of the vaccine rather than as 'secondary reported' data documented by a third - party. A value of 'true' means this data originated with the individual/organization - which was responsible for the administration of the vaccine. - element_property: true - title: Indicates context the data was captured in - type: boolean - programEligibility: - description: Indicates a patient's eligibility for a funding program. - element_property: true - items: - $ref: ImmunizationProgramEligibility.yaml - title: Patient eligibility for a specific vaccination program - type: array - protocolApplied: - description: The protocol (set of recommendations) being followed by the provider - who administered the dose. - element_property: true - items: - $ref: ImmunizationProtocolApplied.yaml - title: Protocol followed by the provider - type: array - reaction: - description: Categorical data indicating that an adverse event is associated in - time to an immunization. - element_property: true - items: - $ref: ImmunizationReaction.yaml - title: Details of a reaction that follows immunization - type: array - reason: - backref: reason_immunization - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-reason - binding_version: null - description: Describes why the immunization occurred in coded or textual form, - or Indicates another resource (Condition, Observation or DiagnosticReport) whose - existence justifies this immunization. - element_property: true - enum_reference_types: - - Condition - - Observation - - DiagnosticReport - items: - $ref: CodeableReference.yaml - title: Why immunization occurred - type: array - resourceType: - const: Immunization - default: Immunization - description: One of the resource types defined as part of FHIR - title: Resource Type - type: string - route: - $ref: CodeableConcept.yaml - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-route - binding_version: null - description: The path by which the vaccine product is taken into the body. - element_property: true - title: How vaccine entered body - site: - $ref: CodeableConcept.yaml - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-site - binding_version: null - description: Body site where vaccine was administered. - element_property: true - title: Body site vaccine was administered - status: - binding_description: x - binding_strength: required - binding_uri: http://hl7.org/fhir/ValueSet/immunization-status - binding_version: 5.0.0 - description: Indicates the current status of the immunization event. - element_property: true - element_required: true - enum_values: - - completed - - entered-in-error - - not-done - pattern: ^[^\s]+(\s[^\s]+)*$ - title: completed | entered-in-error | not-done - type: string - statusReason: - $ref: CodeableConcept.yaml - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-status-reason - binding_version: null - description: Indicates the reason the immunization event was not performed. - element_property: true - title: Reason for current status - subpotentReason: - binding_description: The reason why a dose is considered to be subpotent. - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-subpotent-reason - binding_version: null - description: Reason why a dose is considered to be subpotent. - element_property: true - items: - $ref: CodeableConcept.yaml - title: Reason for being subpotent - type: array - supportingInformation: - backref: supportingInformation_immunization - description: Additional information that is relevant to the immunization (e.g. - for a vaccine recipient who is pregnant, the gestational age of the fetus). - The reason why a vaccine was given (e.g. occupation, underlying medical condition) - should be conveyed in Immunization.reason, not as supporting information. The - reason why a vaccine was not given (e.g. contraindication) should be conveyed - in Immunization.statusReason, not as supporting information. - element_property: true - enum_reference_types: - - Resource - items: - $ref: Reference.yaml - title: Additional information in support of the immunization - type: array - text: - $ref: Narrative.yaml - description: A human-readable narrative that contains a summary of the resource - and can be used to represent the content of the resource to a human. The narrative - need not encode all the structured data, but is required to contain sufficient - detail to make it "clinically safe" for a human to just read the narrative. - Resource definitions may define what content should be represented in the narrative - to ensure clinical safety. - element_property: true - title: Text summary of the resource, for human interpretation - vaccineCode: - $ref: CodeableConcept.yaml - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/vaccine-code - binding_version: null - description: Vaccine that was administered or was to be administered. - element_property: true - title: Vaccine administered -required: -- patient -- vaccineCode -title: Immunization -type: object diff --git a/schemas/graph/ImmunizationProgramEligibility.yaml b/schemas/graph/ImmunizationProgramEligibility.yaml deleted file mode 100644 index a96f5d7..0000000 --- a/schemas/graph/ImmunizationProgramEligibility.yaml +++ /dev/null @@ -1,79 +0,0 @@ -$id: ImmunizationProgramEligibility -additionalProperties: false -description: Patient eligibility for a specific vaccination program. Indicates a patient's - eligibility for a funding program. [See https://hl7.org/fhir/R5/ImmunizationProgramEligibility.html] -properties: - extension: - description: May be used to represent additional information that is not part - of the basic definition of the element. To make the use of extensions safe and - managable, there is a strict set of governance applied to the definition and - use of extensions. Though any implementer can define an extension, there is - a set of requirements that SHALL be met as part of the definition of the extension. - element_property: true - items: - $ref: Extension.yaml - title: Additional content defined by implementations - type: array - fhir_comments: - anyOf: - - type: string - - items: - type: string - type: array - element_property: false - title: Fhir Comments - id: - description: Unique id for the element within a resource (for internal references). - This may be any string value that does not contain spaces. - element_property: true - pattern: '[ \r\n\t\S]+' - title: Unique id for inter-element referencing - type: string - modifierExtension: - description: May be used to represent additional information that is not part - of the basic definition of the element and that modifies the understanding of - the element in which it is contained and/or the understanding of the containing - element's descendants. Usually modifier elements provide negation or qualification. - To make the use of extensions safe and managable, there is a strict set of governance - applied to the definition and use of extensions. Though any implementer can - define an extension, there is a set of requirements that SHALL be met as part - of the definition of the extension. Applications processing a resource are required - to check for modifier extensions. Modifier extensions SHALL NOT change the - meaning of any elements on Resource or DomainResource (including cannot change - the meaning of modifierExtension itself). - element_property: true - items: - $ref: Extension.yaml - title: Extensions that cannot be ignored even if unrecognized - type: array - program: - $ref: CodeableConcept.yaml - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program - binding_version: null - description: Indicates which program the patient had their eligility evaluated - for. - element_property: true - title: The program that eligibility is declared for - programStatus: - $ref: CodeableConcept.yaml - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-program-eligibility - binding_version: null - description: Indicates the patient's eligility status for for a specific payment - program. - element_property: true - title: The patient's eligibility status for the program - resourceType: - const: ImmunizationProgramEligibility - default: ImmunizationProgramEligibility - description: One of the resource types defined as part of FHIR - title: Resource Type - type: string -required: -- program -- programStatus -title: ImmunizationProgramEligibility -type: object diff --git a/schemas/graph/ImmunizationProtocolApplied.yaml b/schemas/graph/ImmunizationProtocolApplied.yaml deleted file mode 100644 index f3006a1..0000000 --- a/schemas/graph/ImmunizationProtocolApplied.yaml +++ /dev/null @@ -1,107 +0,0 @@ -$id: ImmunizationProtocolApplied -additionalProperties: false -description: Protocol followed by the provider. The protocol (set of recommendations) - being followed by the provider who administered the dose. [See https://hl7.org/fhir/R5/ImmunizationProtocolApplied.html] -properties: - _doseNumber: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``doseNumber``. - _series: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``series``. - _seriesDoses: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``seriesDoses``. - authority: - $ref: Reference.yaml - backref: immunization_protocol_applied - description: Indicates the authority who published the protocol (e.g. ACIP) that - is being followed. - element_property: true - enum_reference_types: - - Organization - title: Who is responsible for publishing the recommendations - doseNumber: - description: Nominal position in a series as intended by the practitioner administering - the dose. - element_property: true - element_required: true - pattern: '[ \r\n\t\S]+' - title: Dose number within series - type: string - extension: - description: May be used to represent additional information that is not part - of the basic definition of the element. To make the use of extensions safe and - managable, there is a strict set of governance applied to the definition and - use of extensions. Though any implementer can define an extension, there is - a set of requirements that SHALL be met as part of the definition of the extension. - element_property: true - items: - $ref: Extension.yaml - title: Additional content defined by implementations - type: array - fhir_comments: - anyOf: - - type: string - - items: - type: string - type: array - element_property: false - title: Fhir Comments - id: - description: Unique id for the element within a resource (for internal references). - This may be any string value that does not contain spaces. - element_property: true - pattern: '[ \r\n\t\S]+' - title: Unique id for inter-element referencing - type: string - modifierExtension: - description: May be used to represent additional information that is not part - of the basic definition of the element and that modifies the understanding of - the element in which it is contained and/or the understanding of the containing - element's descendants. Usually modifier elements provide negation or qualification. - To make the use of extensions safe and managable, there is a strict set of governance - applied to the definition and use of extensions. Though any implementer can - define an extension, there is a set of requirements that SHALL be met as part - of the definition of the extension. Applications processing a resource are required - to check for modifier extensions. Modifier extensions SHALL NOT change the - meaning of any elements on Resource or DomainResource (including cannot change - the meaning of modifierExtension itself). - element_property: true - items: - $ref: Extension.yaml - title: Extensions that cannot be ignored even if unrecognized - type: array - resourceType: - const: ImmunizationProtocolApplied - default: ImmunizationProtocolApplied - description: One of the resource types defined as part of FHIR - title: Resource Type - type: string - series: - description: One possible path to achieve presumed immunity against a disease - - within the context of an authority. - element_property: true - pattern: '[ \r\n\t\S]+' - title: Name of vaccine series - type: string - seriesDoses: - description: The recommended number of doses to achieve immunity as intended by - the practitioner administering the dose. - element_property: true - pattern: '[ \r\n\t\S]+' - title: Recommended number of doses for immunity - type: string - targetDisease: - binding_description: x - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/immunization-target-disease - binding_version: null - description: The vaccine preventable disease the dose is being administered against. - element_property: true - items: - $ref: CodeableConcept.yaml - title: Vaccine preventatable disease being targeted - type: array -title: ImmunizationProtocolApplied -type: object diff --git a/schemas/graph/ImmunizationReaction.yaml b/schemas/graph/ImmunizationReaction.yaml deleted file mode 100644 index 48c8472..0000000 --- a/schemas/graph/ImmunizationReaction.yaml +++ /dev/null @@ -1,81 +0,0 @@ -$id: ImmunizationReaction -additionalProperties: false -description: Details of a reaction that follows immunization. Categorical data indicating - that an adverse event is associated in time to an immunization. [See https://hl7.org/fhir/R5/ImmunizationReaction.html] -properties: - _date: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``date``. - _reported: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``reported``. - date: - description: Date of reaction to the immunization. - element_property: true - format: date-time - title: When reaction started - type: string - extension: - description: May be used to represent additional information that is not part - of the basic definition of the element. To make the use of extensions safe and - managable, there is a strict set of governance applied to the definition and - use of extensions. Though any implementer can define an extension, there is - a set of requirements that SHALL be met as part of the definition of the extension. - element_property: true - items: - $ref: Extension.yaml - title: Additional content defined by implementations - type: array - fhir_comments: - anyOf: - - type: string - - items: - type: string - type: array - element_property: false - title: Fhir Comments - id: - description: Unique id for the element within a resource (for internal references). - This may be any string value that does not contain spaces. - element_property: true - pattern: '[ \r\n\t\S]+' - title: Unique id for inter-element referencing - type: string - manifestation: - $ref: CodeableReference.yaml - backref: immunization_reaction - description: Details of the reaction. - element_property: true - enum_reference_types: - - Observation - title: Additional information on reaction - modifierExtension: - description: May be used to represent additional information that is not part - of the basic definition of the element and that modifies the understanding of - the element in which it is contained and/or the understanding of the containing - element's descendants. Usually modifier elements provide negation or qualification. - To make the use of extensions safe and managable, there is a strict set of governance - applied to the definition and use of extensions. Though any implementer can - define an extension, there is a set of requirements that SHALL be met as part - of the definition of the extension. Applications processing a resource are required - to check for modifier extensions. Modifier extensions SHALL NOT change the - meaning of any elements on Resource or DomainResource (including cannot change - the meaning of modifierExtension itself). - element_property: true - items: - $ref: Extension.yaml - title: Extensions that cannot be ignored even if unrecognized - type: array - reported: - description: Self-reported indicator. - element_property: true - title: Indicates self-reported reaction - type: boolean - resourceType: - const: ImmunizationReaction - default: ImmunizationReaction - description: One of the resource types defined as part of FHIR - title: Resource Type - type: string -title: ImmunizationReaction -type: object diff --git a/schemas/graph/Location.yaml b/schemas/graph/Location.yaml deleted file mode 100644 index e0b2559..0000000 --- a/schemas/graph/Location.yaml +++ /dev/null @@ -1,295 +0,0 @@ -$id: Location -additionalProperties: false -description: Details and position information for a place. Details and position information - for a place where services are provided and resources and participants may be stored, - found, contained, or accommodated. [See https://hl7.org/fhir/R5/Location.html] -properties: - _alias: - items: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``alias``. - type: array - _description: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``description``. - _implicitRules: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``implicitRules``. - _language: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``language``. - _mode: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``mode``. - _name: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``name``. - _status: - $ref: FHIRPrimitiveExtension.yaml - title: Extension field for ``status``. - address: - $ref: Address.yaml - element_property: true - title: Physical location - alias: - element_property: true - items: - pattern: '[ \r\n\t\S]+' - type: string - title: A list of alternate names that the location is known as, or was known as, - in the past - type: array - characteristic: - binding_description: A custom attribute that could be provided at a service (e.g. - Wheelchair accessibiliy). - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/location-characteristic - binding_version: null - element_property: true - items: - $ref: CodeableConcept.yaml - title: Collection of characteristics (attributes) - type: array - contact: - description: The contact details of communication devices available at the location. - This can include addresses, phone numbers, fax numbers, mobile numbers, email - addresses and web sites. - element_property: true - items: - $ref: ExtendedContactDetail.yaml - title: Official contact details for the location - type: array - contained: - description: These resources do not have an independent existence apart from the - resource that contains them - they cannot be identified independently, nor can - they have their own independent transaction scope. This is allowed to be a Parameters - resource if and only if it is referenced by a resource that provides context/meaning. - element_property: true - items: - $ref: Resource.yaml - title: Contained, inline Resources - type: array - description: - description: Description of the Location, which helps in finding or referencing - the place. - element_property: true - pattern: \s*(\S|\s)* - title: Additional details about the location that could be displayed as further - information to identify the location beyond its name - type: string - endpoint: - backref: endpoint_location - element_property: true - enum_reference_types: - - Endpoint - items: - $ref: Reference.yaml - title: Technical endpoints providing access to services operated for the location - type: array - extension: - description: May be used to represent additional information that is not part - of the basic definition of the resource. To make the use of extensions safe - and managable, there is a strict set of governance applied to the definition - and use of extensions. Though any implementer can define an extension, there - is a set of requirements that SHALL be met as part of the definition of the - extension. - element_property: true - items: - $ref: Extension.yaml - title: Additional content defined by implementations - type: array - fhir_comments: - anyOf: - - type: string - - items: - type: string - type: array - element_property: false - title: Fhir Comments - form: - $ref: CodeableConcept.yaml - binding_description: Physical form of the location. - binding_strength: example - binding_uri: http://hl7.org/fhir/ValueSet/location-form - binding_version: null - description: Physical form of the location, e.g. building, room, vehicle, road, - virtual. - element_property: true - title: Physical form of the location - hoursOfOperation: - description: What days/times during a week is this location usually open, and - any exceptions where the location is not available. - element_property: true - items: - $ref: Availability.yaml - title: What days/times during a week is this location usually open (including - exceptions) - type: array - id: - description: The logical id of the resource, as used in the URL for the resource. - Once assigned, this value never changes. - element_property: true - maxLength: 64 - minLength: 1 - pattern: ^[A-Za-z0-9\-.]+$ - title: Logical id of this artifact - type: string - identifier: - element_property: true - items: - $ref: Identifier.yaml - title: Unique code or number identifying the location to its users - type: array - implicitRules: - description: A reference to a set of rules that were followed when the resource - was constructed, and which must be understood when processing the content. Often, - this is a reference to an implementation guide that defines the special rules - along with other profiles etc. - element_property: true - pattern: \S* - title: A set of rules under which this content was created - type: string - language: - binding_description: IETF language tag for a human language - binding_strength: required - binding_uri: http://hl7.org/fhir/ValueSet/all-languages - binding_version: 5.0.0 - description: The base language in which the resource is written. - element_property: true - pattern: ^[^\s]+(\s[^\s]+)*$ - title: Language of the resource content - type: string - managingOrganization: - $ref: Reference.yaml - backref: location - description: The organization responsible for the provisioning and upkeep of the - location. - element_property: true - enum_reference_types: - - Organization - title: Organization responsible for provisioning and upkeep - meta: - $ref: Meta.yaml - description: The metadata about the resource. This is content that is maintained - by the infrastructure. Changes to the content might not always be associated - with version changes to the resource. - element_property: true - title: Metadata about the resource - mode: - binding_description: Indicates whether a resource instance represents a specific - location or a class of locations. - binding_strength: required - binding_uri: http://hl7.org/fhir/ValueSet/location-mode - binding_version: 5.0.0 - description: Indicates whether a resource instance represents a specific location - or a class of locations. - element_property: true - enum_values: - - instance - - kind - pattern: ^[^\s]+(\s[^\s]+)*$ - title: instance | kind - type: string - modifierExtension: - description: May be used to represent additional information that is not part - of the basic definition of the resource and that modifies the understanding - of the element that contains it and/or the understanding of the containing element's - descendants. Usually modifier elements provide negation or qualification. To - make the use of extensions safe and managable, there is a strict set of governance - applied to the definition and use of extensions. Though any implementer is allowed - to define an extension, there is a set of requirements that SHALL be met as - part of the definition of the extension. Applications processing a resource - are required to check for modifier extensions. Modifier extensions SHALL NOT - change the meaning of any elements on Resource or DomainResource (including - cannot change the meaning of modifierExtension itself). - element_property: true - items: - $ref: Extension.yaml - title: Extensions that cannot be ignored - type: array - name: - description: Name of the location as used by humans. Does not need to be unique. - element_property: true - pattern: '[ \r\n\t\S]+' - title: Name of the location as used by humans - type: string - operationalStatus: - $ref: Coding.yaml - binding_description: The operational status if the location (where typically a - bed/room). - binding_strength: preferred - binding_uri: http://terminology.hl7.org/ValueSet/v2-0116 - binding_version: null - description: The operational status covers operation values most relevant to beds - (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis - chair). This typically covers concepts such as contamination, housekeeping, - and other activities like maintenance. - element_property: true - title: The operational status of the location (typically only for a bed/room) - partOf: - $ref: Reference.yaml - backref: location - description: Another Location of which this Location is physically a part of. - element_property: true - enum_reference_types: - - Location - title: Another Location this one is physically a part of - position: - $ref: LocationPosition.yaml - description: The absolute geographic location of the Location, expressed using - the WGS84 datum (This is the same co-ordinate system used in KML). - element_property: true - title: The absolute geographic location - resourceType: - const: Location - default: Location - description: One of the resource types defined as part of FHIR - title: Resource Type - type: string - status: - binding_description: Indicates whether the location is still in use. - binding_strength: required - binding_uri: http://hl7.org/fhir/ValueSet/location-status - binding_version: 5.0.0 - description: The status property covers the general availability of the resource, - not the current value which may be covered by the operationStatus, or by a schedule/slots - if they are configured for the location. - element_property: true - enum_values: - - active - - suspended - - inactive - pattern: ^[^\s]+(\s[^\s]+)*$ - title: active | suspended | inactive - type: string - text: - $ref: Narrative.yaml - description: A human-readable narrative that contains a summary of the resource - and can be used to represent the content of the resource to a human. The narrative - need not encode all the structured data, but is required to contain sufficient - detail to make it "clinically safe" for a human to just read the narrative. - Resource definitions may define what content should be represented in the narrative - to ensure clinical safety. - element_property: true - title: Text summary of the resource, for human interpretation - type: - binding_description: Indicates the type of function performed at the location. - binding_strength: extensible - binding_uri: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType - binding_version: null - description: Indicates the type of function performed at the location. - element_property: true - items: - $ref: CodeableConcept.yaml - title: Type of function performed - type: array - virtualService: - description: Connection details of a virtual service (e.g. shared conference call - facility with dedicated number/details). - element_property: true - items: - $ref: VirtualServiceDetail.yaml - title: Connection details of a virtual service (e.g. conference call) - type: array -title: Location -type: object diff --git a/schemas/graph/Medication.yaml b/schemas/graph/Medication.yaml index b74ef6c..1116e01 100644 --- a/schemas/graph/Medication.yaml +++ b/schemas/graph/Medication.yaml @@ -4,7 +4,22 @@ description: Definition of a Medication. This resource is primarily used for the and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. [See https://hl7.org/fhir/R5/Medication.html] -links: [] +links: +- href: Organization/{id} + rel: marketingAuthorizationHolder + targetHints: + backref: + - medication + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /marketingAuthorizationHolder/reference + templateRequired: + - id properties: _implicitRules: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/MedicationAdministration.yaml b/schemas/graph/MedicationAdministration.yaml index 51d732d..b2460aa 100644 --- a/schemas/graph/MedicationAdministration.yaml +++ b/schemas/graph/MedicationAdministration.yaml @@ -6,6 +6,21 @@ description: Administration of medication to a patient. Describes the event of a this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. [See https://hl7.org/fhir/R5/MedicationAdministration.html] links: +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - medication_administration + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id - href: MedicationAdministration/{id} rel: partOf_MedicationAdministration targetHints: @@ -21,19 +36,19 @@ links: id: /partOf/-/reference templateRequired: - id -- href: MedicationRequest/{id} - rel: request +- href: Procedure/{id} + rel: partOf_Procedure targetHints: backref: - - medication_administration + - partOf_medication_administration direction: - outbound multiplicity: - - has_one + - has_many targetSchema: - $ref: MedicationRequest.yaml + $ref: Procedure.yaml templatePointers: - id: /request/reference + id: /partOf/-/reference templateRequired: - id - href: Patient/{id} @@ -66,6 +81,38 @@ links: id: /supportingInformation/-/reference templateRequired: - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -82,6 +129,22 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id properties: _implicitRules: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/MedicationRequest.yaml b/schemas/graph/MedicationRequest.yaml index d90cc8d..e1afa2f 100644 --- a/schemas/graph/MedicationRequest.yaml +++ b/schemas/graph/MedicationRequest.yaml @@ -21,6 +21,21 @@ links: id: /basedOn/-/reference templateRequired: - id +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - medication_request + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id - href: Patient/{id} rel: informationSource_Patient targetHints: diff --git a/schemas/graph/MedicationStatement.yaml b/schemas/graph/MedicationStatement.yaml index d97b655..16d62c5 100644 --- a/schemas/graph/MedicationStatement.yaml +++ b/schemas/graph/MedicationStatement.yaml @@ -37,6 +37,21 @@ links: id: /derivedFrom/-/reference templateRequired: - id +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - medication_statement + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id - href: Patient/{id} rel: informationSource_Patient targetHints: @@ -52,6 +67,21 @@ links: id: /informationSource/-/reference templateRequired: - id +- href: Procedure/{id} + rel: partOf_Procedure + targetHints: + backref: + - partOf_medication_statement + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /partOf/-/reference + templateRequired: + - id - href: MedicationStatement/{id} rel: partOf_MedicationStatement targetHints: diff --git a/schemas/graph/Observation.yaml b/schemas/graph/Observation.yaml index 23a3bab..1e20dda 100644 --- a/schemas/graph/Observation.yaml +++ b/schemas/graph/Observation.yaml @@ -3,19 +3,19 @@ additionalProperties: false description: Measurements and simple assertions. Measurements and simple assertions made about a patient, device or other subject. [See https://hl7.org/fhir/R5/Observation.html] links: -- href: MedicationRequest/{id} - rel: basedOn_MedicationRequest +- href: BodyStructure/{id} + rel: bodyStructure targetHints: backref: - - basedOn_observation + - observation direction: - outbound multiplicity: - - has_many + - has_one targetSchema: - $ref: MedicationRequest.yaml + $ref: BodyStructure.yaml templatePointers: - id: /basedOn/-/reference + id: /bodyStructure/reference templateRequired: - id - href: DocumentReference/{id} @@ -33,6 +33,21 @@ links: id: /derivedFrom/-/reference templateRequired: - id +- href: ImagingStudy/{id} + rel: derivedFrom_ImagingStudy + targetHints: + backref: + - derivedFrom_observation + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: ImagingStudy.yaml + templatePointers: + id: /derivedFrom/-/reference + templateRequired: + - id - href: Observation/{id} rel: derivedFrom_Observation targetHints: @@ -48,6 +63,21 @@ links: id: /derivedFrom/-/reference templateRequired: - id +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - observation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id - href: Resource/{id} rel: focus targetHints: @@ -93,8 +123,23 @@ links: id: /partOf/-/reference templateRequired: - id -- href: MedicationStatement/{id} - rel: partOf_MedicationStatement +- href: Procedure/{id} + rel: partOf_Procedure + targetHints: + backref: + - partOf_observation + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /partOf/-/reference + templateRequired: + - id +- href: ImagingStudy/{id} + rel: partOf_ImagingStudy targetHints: backref: - partOf_observation @@ -103,11 +148,56 @@ links: multiplicity: - has_many targetSchema: - $ref: MedicationStatement.yaml + $ref: ImagingStudy.yaml templatePointers: id: /partOf/-/reference templateRequired: - id +- href: Practitioner/{id} + rel: performer_Practitioner + targetHints: + backref: + - performer_observation + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /performer/-/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: performer_PractitionerRole + targetHints: + backref: + - performer_observation + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /performer/-/reference + templateRequired: + - id +- href: Organization/{id} + rel: performer_Organization + targetHints: + backref: + - performer_observation + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /performer/-/reference + templateRequired: + - id - href: Patient/{id} rel: performer_Patient targetHints: @@ -153,6 +243,51 @@ links: id: /subject/reference templateRequired: - id +- href: Organization/{id} + rel: subject_Organization + targetHints: + backref: + - subject_observation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Procedure/{id} + rel: subject_Procedure + targetHints: + backref: + - subject_observation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: subject_Practitioner + targetHints: + backref: + - subject_observation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id - href: Medication/{id} rel: subject_Medication targetHints: @@ -183,6 +318,38 @@ links: id: /subject/reference templateRequired: - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -199,6 +366,22 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From ObservationTriggeredBy/triggeredBy href: Observation/{id} rel: triggeredBy_observation diff --git a/schemas/graph/Organization.yaml b/schemas/graph/Organization.yaml index 23f33b8..fa8066f 100644 --- a/schemas/graph/Organization.yaml +++ b/schemas/graph/Organization.yaml @@ -5,6 +5,54 @@ description: A grouping of people or organizations with a common purpose. A form of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. [See https://hl7.org/fhir/R5/Organization.html] +links: +- href: Organization/{id} + rel: partOf + targetHints: + backref: + - organization + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /partOf/reference + templateRequired: + - id +- $comment: From ExtendedContactDetail/contact + href: Organization/{id} + rel: contact_organization + targetHints: + backref: + - extended_contact_detail + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /contact/-/organization/reference + templateRequired: + - id +- $comment: From OrganizationQualification/qualification + href: Organization/{id} + rel: qualification_issuer + targetHints: + backref: + - organization_qualification + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /qualification/-/issuer/reference + templateRequired: + - id properties: _active: $ref: FHIRPrimitiveExtension.yaml @@ -130,6 +178,10 @@ properties: pattern: ^[^\s]+(\s[^\s]+)*$ title: Language of the resource content type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array meta: $ref: Meta.yaml description: The metadata about the resource. This is content that is maintained diff --git a/schemas/graph/OrganizationQualification.yaml b/schemas/graph/OrganizationQualification.yaml index 6991141..6e03454 100644 --- a/schemas/graph/OrganizationQualification.yaml +++ b/schemas/graph/OrganizationQualification.yaml @@ -6,6 +6,22 @@ description: Qualifications, certifications, accreditations, licenses, training, provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization. [See https://hl7.org/fhir/R5/OrganizationQualification.html] +links: +- href: Organization/{id} + rel: issuer + targetHints: + backref: + - organization_qualification + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /issuer/reference + templateRequired: + - id properties: code: $ref: CodeableConcept.yaml @@ -51,6 +67,10 @@ properties: enum_reference_types: - Organization title: Organization that regulates and issues the qualification + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/Patient.yaml b/schemas/graph/Patient.yaml index 6c65fa4..8dc933a 100644 --- a/schemas/graph/Patient.yaml +++ b/schemas/graph/Patient.yaml @@ -4,6 +4,82 @@ description: Information about an individual or animal receiving health care ser Demographics and other administrative information about an individual or animal receiving care or other health-related services. [See https://hl7.org/fhir/R5/Patient.html] links: +- href: Organization/{id} + rel: generalPractitioner_Organization + targetHints: + backref: + - generalPractitioner_patient + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /generalPractitioner/-/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: generalPractitioner_Practitioner + targetHints: + backref: + - generalPractitioner_patient + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /generalPractitioner/-/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: generalPractitioner_PractitionerRole + targetHints: + backref: + - generalPractitioner_patient + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /generalPractitioner/-/reference + templateRequired: + - id +- href: Organization/{id} + rel: managingOrganization + targetHints: + backref: + - managingOrganization_patient + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /managingOrganization/reference + templateRequired: + - id +- $comment: From PatientContact/contact + href: Organization/{id} + rel: contact_organization + targetHints: + backref: + - patient_contact + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /contact/-/organization/reference + templateRequired: + - id - $comment: From PatientLink/link href: Patient/{id} rel: link_other_Patient diff --git a/schemas/graph/PatientContact.yaml b/schemas/graph/PatientContact.yaml index 3317221..504ed98 100644 --- a/schemas/graph/PatientContact.yaml +++ b/schemas/graph/PatientContact.yaml @@ -2,7 +2,22 @@ $id: PatientContact additionalProperties: false description: A contact party (e.g. guardian, partner, friend) for the patient. [See https://hl7.org/fhir/R5/PatientContact.html] -links: [] +links: +- href: Organization/{id} + rel: organization + targetHints: + backref: + - patient_contact + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /organization/reference + templateRequired: + - id properties: _gender: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/Practitioner.yaml b/schemas/graph/Practitioner.yaml index 8c89c2d..c6c5b40 100644 --- a/schemas/graph/Practitioner.yaml +++ b/schemas/graph/Practitioner.yaml @@ -3,6 +3,23 @@ additionalProperties: false description: A person with a formal responsibility in the provisioning of healthcare or related services. A person who is directly or indirectly involved in the provisioning of healthcare or related services. [See https://hl7.org/fhir/R5/Practitioner.html] +links: +- $comment: From PractitionerQualification/qualification + href: Organization/{id} + rel: qualification_issuer + targetHints: + backref: + - practitioner_qualification + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /qualification/-/issuer/reference + templateRequired: + - id properties: _active: $ref: FHIRPrimitiveExtension.yaml @@ -149,6 +166,10 @@ properties: pattern: ^[^\s]+(\s[^\s]+)*$ title: Language of the resource content type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array meta: $ref: Meta.yaml description: The metadata about the resource. This is content that is maintained diff --git a/schemas/graph/PractitionerCommunication.yaml b/schemas/graph/PractitionerCommunication.yaml index 9d8a6cd..2815b1c 100644 --- a/schemas/graph/PractitionerCommunication.yaml +++ b/schemas/graph/PractitionerCommunication.yaml @@ -5,6 +5,7 @@ description: A language which may be used to communicate with the practitioner. purposes. The `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis). [See https://hl7.org/fhir/R5/PractitionerCommunication.html] +links: [] properties: _preferred: $ref: FHIRPrimitiveExtension.yaml @@ -47,6 +48,10 @@ properties: for Australian English. element_property: true title: The language code used to communicate with the practitioner + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/PractitionerQualification.yaml b/schemas/graph/PractitionerQualification.yaml index 1142033..53f24fe 100644 --- a/schemas/graph/PractitionerQualification.yaml +++ b/schemas/graph/PractitionerQualification.yaml @@ -6,6 +6,22 @@ description: Qualifications, certifications, accreditations, licenses, training, that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality. [See https://hl7.org/fhir/R5/PractitionerQualification.html] +links: +- href: Organization/{id} + rel: issuer + targetHints: + backref: + - practitioner_qualification + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /issuer/reference + templateRequired: + - id properties: code: $ref: CodeableConcept.yaml @@ -56,6 +72,10 @@ properties: enum_reference_types: - Organization title: Organization that regulates and issues the qualification + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/PractitionerRole.yaml b/schemas/graph/PractitionerRole.yaml index d9d9f90..79bb03a 100644 --- a/schemas/graph/PractitionerRole.yaml +++ b/schemas/graph/PractitionerRole.yaml @@ -3,6 +3,53 @@ additionalProperties: false description: Roles/organizations the practitioner is associated with. A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. [See https://hl7.org/fhir/R5/PractitionerRole.html] +links: +- href: Organization/{id} + rel: organization + targetHints: + backref: + - practitioner_role + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /organization/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: practitioner + targetHints: + backref: + - practitioner_role + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /practitioner/reference + templateRequired: + - id +- $comment: From ExtendedContactDetail/contact + href: Organization/{id} + rel: contact_organization + targetHints: + backref: + - extended_contact_detail + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /contact/-/organization/reference + templateRequired: + - id properties: _active: $ref: FHIRPrimitiveExtension.yaml @@ -162,6 +209,10 @@ properties: pattern: ^[^\s]+(\s[^\s]+)*$ title: Language of the resource content type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array location: backref: location_practitioner_role description: The location(s) at which this practitioner provides care. diff --git a/schemas/graph/Procedure.yaml b/schemas/graph/Procedure.yaml index 29790e0..b1cd91b 100644 --- a/schemas/graph/Procedure.yaml +++ b/schemas/graph/Procedure.yaml @@ -6,6 +6,481 @@ description: An action that is being or was performed on an individual or entity an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing. [See https://hl7.org/fhir/R5/Procedure.html] +links: +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id +- href: Patient/{id} + rel: focus_Patient + targetHints: + backref: + - focus_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /focus/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: focus_Practitioner + targetHints: + backref: + - focus_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /focus/reference + templateRequired: + - id +- href: Organization/{id} + rel: focus_Organization + targetHints: + backref: + - focus_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /focus/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: focus_PractitionerRole + targetHints: + backref: + - focus_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /focus/reference + templateRequired: + - id +- href: Specimen/{id} + rel: focus_Specimen + targetHints: + backref: + - focus_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Specimen.yaml + templatePointers: + id: /focus/reference + templateRequired: + - id +- href: Procedure/{id} + rel: partOf_Procedure + targetHints: + backref: + - partOf_procedure + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /partOf/-/reference + templateRequired: + - id +- href: Observation/{id} + rel: partOf_Observation + targetHints: + backref: + - partOf_procedure + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Observation.yaml + templatePointers: + id: /partOf/-/reference + templateRequired: + - id +- href: MedicationAdministration/{id} + rel: partOf_MedicationAdministration + targetHints: + backref: + - partOf_procedure + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: MedicationAdministration.yaml + templatePointers: + id: /partOf/-/reference + templateRequired: + - id +- href: Patient/{id} + rel: recorder_Patient + targetHints: + backref: + - recorder_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /recorder/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: recorder_Practitioner + targetHints: + backref: + - recorder_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /recorder/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: recorder_PractitionerRole + targetHints: + backref: + - recorder_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /recorder/reference + templateRequired: + - id +- href: DiagnosticReport/{id} + rel: report_DiagnosticReport + targetHints: + backref: + - report_procedure + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: DiagnosticReport.yaml + templatePointers: + id: /report/-/reference + templateRequired: + - id +- href: DocumentReference/{id} + rel: report_DocumentReference + targetHints: + backref: + - report_procedure + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: DocumentReference.yaml + templatePointers: + id: /report/-/reference + templateRequired: + - id +- href: Patient/{id} + rel: reportedReference_Patient + targetHints: + backref: + - reportedReference_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /reportedReference/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: reportedReference_Practitioner + targetHints: + backref: + - reportedReference_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /reportedReference/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: reportedReference_PractitionerRole + targetHints: + backref: + - reportedReference_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /reportedReference/reference + templateRequired: + - id +- href: Organization/{id} + rel: reportedReference_Organization + targetHints: + backref: + - reportedReference_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /reportedReference/reference + templateRequired: + - id +- href: Patient/{id} + rel: subject_Patient + targetHints: + backref: + - subject_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: subject_Practitioner + targetHints: + backref: + - subject_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Organization/{id} + rel: subject_Organization + targetHints: + backref: + - subject_procedure + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /subject/reference + templateRequired: + - id +- href: Resource/{id} + rel: supportingInfo + targetHints: + backref: + - supportingInfo_procedure + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Resource.yaml + templatePointers: + id: /supportingInfo/-/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Patient/{id} + rel: note_authorReference_Patient + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From ProcedurePerformer/performer + href: Practitioner/{id} + rel: performer_actor_Practitioner + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From ProcedurePerformer/performer + href: PractitionerRole/{id} + rel: performer_actor_PractitionerRole + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From ProcedurePerformer/performer + href: Organization/{id} + rel: performer_actor_Organization + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From ProcedurePerformer/performer + href: Patient/{id} + rel: performer_actor_Patient + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From ProcedurePerformer/performer + href: Organization/{id} + rel: performer_onBehalfOf + targetHints: + backref: + - onBehalfOf_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /performer/-/onBehalfOf/reference + templateRequired: + - id properties: _implicitRules: $ref: FHIRPrimitiveExtension.yaml @@ -250,6 +725,10 @@ properties: pattern: ^[^\s]+(\s[^\s]+)*$ title: Language of the resource content type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array location: $ref: Reference.yaml backref: location_procedure diff --git a/schemas/graph/ProcedureFocalDevice.yaml b/schemas/graph/ProcedureFocalDevice.yaml index 3908a05..24290b2 100644 --- a/schemas/graph/ProcedureFocalDevice.yaml +++ b/schemas/graph/ProcedureFocalDevice.yaml @@ -3,6 +3,7 @@ additionalProperties: false description: Manipulated, implanted, or removed device. A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure. [See https://hl7.org/fhir/R5/ProcedureFocalDevice.html] +links: [] properties: action: $ref: CodeableConcept.yaml @@ -39,6 +40,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array manipulated: $ref: Reference.yaml backref: procedure_focal_device diff --git a/schemas/graph/ProcedurePerformer.yaml b/schemas/graph/ProcedurePerformer.yaml index f0e10ba..e42a8c4 100644 --- a/schemas/graph/ProcedurePerformer.yaml +++ b/schemas/graph/ProcedurePerformer.yaml @@ -2,6 +2,82 @@ $id: ProcedurePerformer additionalProperties: false description: Who performed the procedure and what they did. Indicates who or what performed the procedure and how they were involved. [See https://hl7.org/fhir/R5/ProcedurePerformer.html] +links: +- href: Practitioner/{id} + rel: actor_Practitioner + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: actor_PractitionerRole + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: Organization/{id} + rel: actor_Organization + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: Patient/{id} + rel: actor_Patient + targetHints: + backref: + - actor_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Patient.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: Organization/{id} + rel: onBehalfOf + targetHints: + backref: + - onBehalfOf_procedure_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /onBehalfOf/reference + templateRequired: + - id properties: actor: $ref: Reference.yaml @@ -54,6 +130,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array modifierExtension: description: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of diff --git a/schemas/graph/ResearchStudy.yaml b/schemas/graph/ResearchStudy.yaml index fceabdd..a9c12a2 100644 --- a/schemas/graph/ResearchStudy.yaml +++ b/schemas/graph/ResearchStudy.yaml @@ -22,6 +22,21 @@ links: id: /partOf/-/reference templateRequired: - id +- href: DiagnosticReport/{id} + rel: result_DiagnosticReport + targetHints: + backref: + - result_research_study + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: DiagnosticReport.yaml + templatePointers: + id: /result/-/reference + templateRequired: + - id - href: ResearchStudy/{id} rel: site_ResearchStudy targetHints: @@ -37,6 +52,101 @@ links: id: /site/-/reference templateRequired: - id +- href: Organization/{id} + rel: site_Organization + targetHints: + backref: + - site_research_study + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /site/-/reference + templateRequired: + - id +- $comment: From ResearchStudyAssociatedParty/associatedParty + href: Practitioner/{id} + rel: associatedParty_party_Practitioner + targetHints: + backref: + - research_study_associated_party + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /associatedParty/-/party/reference + templateRequired: + - id +- $comment: From ResearchStudyAssociatedParty/associatedParty + href: PractitionerRole/{id} + rel: associatedParty_party_PractitionerRole + targetHints: + backref: + - research_study_associated_party + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /associatedParty/-/party/reference + templateRequired: + - id +- $comment: From ResearchStudyAssociatedParty/associatedParty + href: Organization/{id} + rel: associatedParty_party_Organization + targetHints: + backref: + - research_study_associated_party + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /associatedParty/-/party/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -53,6 +163,22 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From RelatedArtifact/relatedArtifact href: Resource/{id} rel: relatedArtifact_resourceReference diff --git a/schemas/graph/ResearchStudyAssociatedParty.yaml b/schemas/graph/ResearchStudyAssociatedParty.yaml index 2c53f55..8ada652 100644 --- a/schemas/graph/ResearchStudyAssociatedParty.yaml +++ b/schemas/graph/ResearchStudyAssociatedParty.yaml @@ -1,7 +1,52 @@ $id: ResearchStudyAssociatedParty additionalProperties: false description: Sponsors, collaborators, and other parties. [See https://hl7.org/fhir/R5/ResearchStudyAssociatedParty.html] -links: [] +links: +- href: Practitioner/{id} + rel: party_Practitioner + targetHints: + backref: + - research_study_associated_party + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /party/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: party_PractitionerRole + targetHints: + backref: + - research_study_associated_party + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /party/reference + templateRequired: + - id +- href: Organization/{id} + rel: party_Organization + targetHints: + backref: + - research_study_associated_party + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /party/reference + templateRequired: + - id properties: _name: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/Signature.yaml b/schemas/graph/Signature.yaml index 9359a54..72351e5 100644 --- a/schemas/graph/Signature.yaml +++ b/schemas/graph/Signature.yaml @@ -7,6 +7,36 @@ description: A Signature - XML DigSig, JWS, Graphical image of signature, etc.. signature, or a signature ceremony Different signature approaches have different utilities. [See https://hl7.org/fhir/R5/Signature.html] links: +- href: Practitioner/{id} + rel: onBehalfOf_Practitioner + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /onBehalfOf/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: onBehalfOf_PractitionerRole + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /onBehalfOf/reference + templateRequired: + - id - href: Patient/{id} rel: onBehalfOf_Patient targetHints: @@ -22,6 +52,51 @@ links: id: /onBehalfOf/reference templateRequired: - id +- href: Organization/{id} + rel: onBehalfOf_Organization + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /onBehalfOf/reference + templateRequired: + - id +- href: Practitioner/{id} + rel: who_Practitioner + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /who/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: who_PractitionerRole + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /who/reference + templateRequired: + - id - href: Patient/{id} rel: who_Patient targetHints: @@ -37,6 +112,21 @@ links: id: /who/reference templateRequired: - id +- href: Organization/{id} + rel: who_Organization + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /who/reference + templateRequired: + - id properties: _data: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/Specimen.yaml b/schemas/graph/Specimen.yaml index bece215..58e0b90 100644 --- a/schemas/graph/Specimen.yaml +++ b/schemas/graph/Specimen.yaml @@ -47,6 +47,38 @@ links: id: /subject/reference templateRequired: - id +- $comment: From SpecimenCollection/collection + href: Practitioner/{id} + rel: collection_collector_Practitioner + targetHints: + backref: + - specimen_collection + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /collection/collector/reference + templateRequired: + - id +- $comment: From SpecimenCollection/collection + href: PractitionerRole/{id} + rel: collection_collector_PractitionerRole + targetHints: + backref: + - specimen_collection + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /collection/collector/reference + templateRequired: + - id - $comment: From SpecimenCollection/collection href: Patient/{id} rel: collection_collector_Patient @@ -63,6 +95,54 @@ links: id: /collection/collector/reference templateRequired: - id +- $comment: From SpecimenCollection/collection + href: Procedure/{id} + rel: collection_procedure + targetHints: + backref: + - specimen_collection + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /collection/procedure/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -79,6 +159,22 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From SpecimenProcessing/processing href: Substance/{id} rel: processing_additive diff --git a/schemas/graph/SpecimenCollection.yaml b/schemas/graph/SpecimenCollection.yaml index fa19eb2..9f54192 100644 --- a/schemas/graph/SpecimenCollection.yaml +++ b/schemas/graph/SpecimenCollection.yaml @@ -3,6 +3,36 @@ additionalProperties: false description: Collection details. Details concerning the specimen collection. [See https://hl7.org/fhir/R5/SpecimenCollection.html] links: +- href: Practitioner/{id} + rel: collector_Practitioner + targetHints: + backref: + - specimen_collection + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /collector/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: collector_PractitionerRole + targetHints: + backref: + - specimen_collection + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /collector/reference + templateRequired: + - id - href: Patient/{id} rel: collector_Patient targetHints: @@ -18,6 +48,21 @@ links: id: /collector/reference templateRequired: - id +- href: Procedure/{id} + rel: procedure + targetHints: + backref: + - specimen_collection + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Procedure.yaml + templatePointers: + id: /procedure/reference + templateRequired: + - id properties: _collectedDateTime: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/Task.yaml b/schemas/graph/Task.yaml index a8e735a..c351840 100644 --- a/schemas/graph/Task.yaml +++ b/schemas/graph/Task.yaml @@ -17,6 +17,21 @@ links: id: /basedOn/-/reference templateRequired: - id +- href: Encounter/{id} + rel: encounter + targetHints: + backref: + - task + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Encounter.yaml + templatePointers: + id: /encounter/reference + templateRequired: + - id - href: Resource/{id} rel: focus targetHints: @@ -47,6 +62,51 @@ links: id: /for_fhir/reference templateRequired: - id +- href: Practitioner/{id} + rel: owner_Practitioner + targetHints: + backref: + - owner_task + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /owner/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: owner_PractitionerRole + targetHints: + backref: + - owner_task + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /owner/reference + templateRequired: + - id +- href: Organization/{id} + rel: owner_Organization + targetHints: + backref: + - owner_task + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /owner/reference + templateRequired: + - id - href: Patient/{id} rel: owner_Patient targetHints: @@ -77,6 +137,21 @@ links: id: /partOf/-/reference templateRequired: - id +- href: Organization/{id} + rel: requester_Organization + targetHints: + backref: + - requester_task + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /requester/reference + templateRequired: + - id - href: Patient/{id} rel: requester_Patient targetHints: @@ -92,6 +167,68 @@ links: id: /requester/reference templateRequired: - id +- href: Practitioner/{id} + rel: requester_Practitioner + targetHints: + backref: + - requester_task + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /requester/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: requester_PractitionerRole + targetHints: + backref: + - requester_task + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /requester/reference + templateRequired: + - id +- $comment: From Annotation/note + href: Practitioner/{id} + rel: note_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/note + href: PractitionerRole/{id} + rel: note_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id - $comment: From Annotation/note href: Patient/{id} rel: note_authorReference_Patient @@ -108,6 +245,70 @@ links: id: /note/-/authorReference/reference templateRequired: - id +- $comment: From Annotation/note + href: Organization/{id} + rel: note_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /note/-/authorReference/reference + templateRequired: + - id +- $comment: From TaskPerformer/performer + href: Practitioner/{id} + rel: performer_actor_Practitioner + targetHints: + backref: + - task_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From TaskPerformer/performer + href: PractitionerRole/{id} + rel: performer_actor_PractitionerRole + targetHints: + backref: + - task_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id +- $comment: From TaskPerformer/performer + href: Organization/{id} + rel: performer_actor_Organization + targetHints: + backref: + - task_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /performer/-/actor/reference + templateRequired: + - id - $comment: From TaskPerformer/performer href: Patient/{id} rel: performer_actor_Patient @@ -140,6 +341,54 @@ links: id: /restriction/recipient/-/reference templateRequired: - id +- $comment: From TaskRestriction/restriction + href: Practitioner/{id} + rel: restriction_recipient_Practitioner + targetHints: + backref: + - recipient_task_restriction + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /restriction/recipient/-/reference + templateRequired: + - id +- $comment: From TaskRestriction/restriction + href: PractitionerRole/{id} + rel: restriction_recipient_PractitionerRole + targetHints: + backref: + - recipient_task_restriction + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /restriction/recipient/-/reference + templateRequired: + - id +- $comment: From TaskRestriction/restriction + href: Organization/{id} + rel: restriction_recipient_Organization + targetHints: + backref: + - recipient_task_restriction + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /restriction/recipient/-/reference + templateRequired: + - id properties: _authoredOn: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/TaskInput.yaml b/schemas/graph/TaskInput.yaml index 9f0ec3c..f24b94b 100644 --- a/schemas/graph/TaskInput.yaml +++ b/schemas/graph/TaskInput.yaml @@ -3,6 +3,38 @@ additionalProperties: false description: Information used to perform task. Additional information that may be needed in the execution of the task. [See https://hl7.org/fhir/R5/TaskInput.html] links: +- $comment: From Annotation/valueAnnotation + href: Practitioner/{id} + rel: valueAnnotation_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/valueAnnotation + href: PractitionerRole/{id} + rel: valueAnnotation_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id - $comment: From Annotation/valueAnnotation href: Patient/{id} rel: valueAnnotation_authorReference_Patient @@ -19,6 +51,38 @@ links: id: /valueAnnotation/authorReference/reference templateRequired: - id +- $comment: From Annotation/valueAnnotation + href: Organization/{id} + rel: valueAnnotation_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id +- $comment: From ExtendedContactDetail/valueExtendedContactDetail + href: Organization/{id} + rel: valueExtendedContactDetail_organization + targetHints: + backref: + - extended_contact_detail + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueExtendedContactDetail/organization/reference + templateRequired: + - id - $comment: From RelatedArtifact/valueRelatedArtifact href: Resource/{id} rel: valueRelatedArtifact_resourceReference @@ -35,6 +99,38 @@ links: id: /valueRelatedArtifact/resourceReference/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Practitioner/{id} + rel: valueSignature_onBehalfOf_Practitioner + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: PractitionerRole/{id} + rel: valueSignature_onBehalfOf_PractitionerRole + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id - $comment: From Signature/valueSignature href: Patient/{id} rel: valueSignature_onBehalfOf_Patient @@ -51,6 +147,54 @@ links: id: /valueSignature/onBehalfOf/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Organization/{id} + rel: valueSignature_onBehalfOf_Organization + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: Practitioner/{id} + rel: valueSignature_who_Practitioner + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: PractitionerRole/{id} + rel: valueSignature_who_PractitionerRole + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id - $comment: From Signature/valueSignature href: Patient/{id} rel: valueSignature_who_Patient @@ -67,6 +211,22 @@ links: id: /valueSignature/who/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Organization/{id} + rel: valueSignature_who_Organization + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id - $comment: From UsageContext/valueUsageContext href: ResearchStudy/{id} rel: valueUsageContext_valueReference_ResearchStudy @@ -83,6 +243,22 @@ links: id: /valueUsageContext/valueReference/reference templateRequired: - id +- $comment: From UsageContext/valueUsageContext + href: Organization/{id} + rel: valueUsageContext_valueReference_Organization + targetHints: + backref: + - usage_context + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueUsageContext/valueReference/reference + templateRequired: + - id properties: _valueBase64Binary: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/TaskOutput.yaml b/schemas/graph/TaskOutput.yaml index 67836ed..7714058 100644 --- a/schemas/graph/TaskOutput.yaml +++ b/schemas/graph/TaskOutput.yaml @@ -3,6 +3,38 @@ additionalProperties: false description: Information produced as part of task. Outputs produced by the Task. [See https://hl7.org/fhir/R5/TaskOutput.html] links: +- $comment: From Annotation/valueAnnotation + href: Practitioner/{id} + rel: valueAnnotation_authorReference_Practitioner + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id +- $comment: From Annotation/valueAnnotation + href: PractitionerRole/{id} + rel: valueAnnotation_authorReference_PractitionerRole + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id - $comment: From Annotation/valueAnnotation href: Patient/{id} rel: valueAnnotation_authorReference_Patient @@ -19,6 +51,38 @@ links: id: /valueAnnotation/authorReference/reference templateRequired: - id +- $comment: From Annotation/valueAnnotation + href: Organization/{id} + rel: valueAnnotation_authorReference_Organization + targetHints: + backref: + - annotation + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueAnnotation/authorReference/reference + templateRequired: + - id +- $comment: From ExtendedContactDetail/valueExtendedContactDetail + href: Organization/{id} + rel: valueExtendedContactDetail_organization + targetHints: + backref: + - extended_contact_detail + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueExtendedContactDetail/organization/reference + templateRequired: + - id - $comment: From RelatedArtifact/valueRelatedArtifact href: Resource/{id} rel: valueRelatedArtifact_resourceReference @@ -35,6 +99,38 @@ links: id: /valueRelatedArtifact/resourceReference/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Practitioner/{id} + rel: valueSignature_onBehalfOf_Practitioner + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: PractitionerRole/{id} + rel: valueSignature_onBehalfOf_PractitionerRole + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id - $comment: From Signature/valueSignature href: Patient/{id} rel: valueSignature_onBehalfOf_Patient @@ -51,6 +147,54 @@ links: id: /valueSignature/onBehalfOf/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Organization/{id} + rel: valueSignature_onBehalfOf_Organization + targetHints: + backref: + - onBehalfOf_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueSignature/onBehalfOf/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: Practitioner/{id} + rel: valueSignature_who_Practitioner + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id +- $comment: From Signature/valueSignature + href: PractitionerRole/{id} + rel: valueSignature_who_PractitionerRole + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id - $comment: From Signature/valueSignature href: Patient/{id} rel: valueSignature_who_Patient @@ -67,6 +211,22 @@ links: id: /valueSignature/who/reference templateRequired: - id +- $comment: From Signature/valueSignature + href: Organization/{id} + rel: valueSignature_who_Organization + targetHints: + backref: + - who_signature + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueSignature/who/reference + templateRequired: + - id - $comment: From UsageContext/valueUsageContext href: ResearchStudy/{id} rel: valueUsageContext_valueReference_ResearchStudy @@ -83,6 +243,22 @@ links: id: /valueUsageContext/valueReference/reference templateRequired: - id +- $comment: From UsageContext/valueUsageContext + href: Organization/{id} + rel: valueUsageContext_valueReference_Organization + targetHints: + backref: + - usage_context + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueUsageContext/valueReference/reference + templateRequired: + - id properties: _valueBase64Binary: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/TaskPerformer.yaml b/schemas/graph/TaskPerformer.yaml index 25bf339..3520ecf 100644 --- a/schemas/graph/TaskPerformer.yaml +++ b/schemas/graph/TaskPerformer.yaml @@ -3,6 +3,51 @@ additionalProperties: false description: Who or what performed the task. The entity who performed the requested task. [See https://hl7.org/fhir/R5/TaskPerformer.html] links: +- href: Practitioner/{id} + rel: actor_Practitioner + targetHints: + backref: + - task_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: actor_PractitionerRole + targetHints: + backref: + - task_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id +- href: Organization/{id} + rel: actor_Organization + targetHints: + backref: + - task_performer + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /actor/reference + templateRequired: + - id - href: Patient/{id} rel: actor_Patient targetHints: diff --git a/schemas/graph/TaskRestriction.yaml b/schemas/graph/TaskRestriction.yaml index d362600..2655ec8 100644 --- a/schemas/graph/TaskRestriction.yaml +++ b/schemas/graph/TaskRestriction.yaml @@ -20,6 +20,51 @@ links: id: /recipient/-/reference templateRequired: - id +- href: Practitioner/{id} + rel: recipient_Practitioner + targetHints: + backref: + - recipient_task_restriction + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Practitioner.yaml + templatePointers: + id: /recipient/-/reference + templateRequired: + - id +- href: PractitionerRole/{id} + rel: recipient_PractitionerRole + targetHints: + backref: + - recipient_task_restriction + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: PractitionerRole.yaml + templatePointers: + id: /recipient/-/reference + templateRequired: + - id +- href: Organization/{id} + rel: recipient_Organization + targetHints: + backref: + - recipient_task_restriction + direction: + - outbound + multiplicity: + - has_many + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /recipient/-/reference + templateRequired: + - id properties: _repetitions: $ref: FHIRPrimitiveExtension.yaml diff --git a/schemas/graph/UsageContext.yaml b/schemas/graph/UsageContext.yaml index 671218b..5a8c2fd 100644 --- a/schemas/graph/UsageContext.yaml +++ b/schemas/graph/UsageContext.yaml @@ -21,6 +21,21 @@ links: id: /valueReference/reference templateRequired: - id +- href: Organization/{id} + rel: valueReference_Organization + targetHints: + backref: + - usage_context + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /valueReference/reference + templateRequired: + - id properties: code: $ref: Coding.yaml diff --git a/schemas/graph/VirtualServiceDetail.yaml b/schemas/graph/VirtualServiceDetail.yaml index a28d2e6..ca89c89 100644 --- a/schemas/graph/VirtualServiceDetail.yaml +++ b/schemas/graph/VirtualServiceDetail.yaml @@ -1,6 +1,23 @@ $id: VirtualServiceDetail additionalProperties: false description: Virtual Service Contact Details. [See https://hl7.org/fhir/R5/VirtualServiceDetail.html] +links: +- $comment: From ExtendedContactDetail/addressExtendedContactDetail + href: Organization/{id} + rel: addressExtendedContactDetail_organization + targetHints: + backref: + - extended_contact_detail + direction: + - outbound + multiplicity: + - has_one + targetSchema: + $ref: Organization.yaml + templatePointers: + id: /addressExtendedContactDetail/organization/reference + templateRequired: + - id properties: _additionalInfo: items: @@ -105,6 +122,10 @@ properties: pattern: '[ \r\n\t\S]+' title: Unique id for inter-element referencing type: string + links: + items: + $ref: https://json-schema.org/draft/2020-12/links + type: array maxParticipants: element_property: true exclusiveMinimum: 0 diff --git a/schemas/graph/graph-fhir.json b/schemas/graph/graph-fhir.json index 6263339..84bc9f2 100644 --- a/schemas/graph/graph-fhir.json +++ b/schemas/graph/graph-fhir.json @@ -7,6 +7,30 @@ "additionalProperties": false, "description": "Administration of medication to a patient. Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. [See https://hl7.org/fhir/R5/MedicationAdministration.html]", "links": [ + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "medication_administration" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" + }, + "templatePointers": { + "id": "/encounter/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "MedicationAdministration/{id}", "rel": "partOf_MedicationAdministration", @@ -32,24 +56,24 @@ ] }, { - "href": "MedicationRequest/{id}", - "rel": "request", + "href": "Procedure/{id}", + "rel": "partOf_Procedure", "targetHints": { "backref": [ - "medication_administration" + "partOf_medication_administration" ], "direction": [ "outbound" ], "multiplicity": [ - "has_one" + "has_many" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationRequest" + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" }, "templatePointers": { - "id": "/request/reference" + "id": "/partOf/-/reference" }, "templateRequired": [ "id" @@ -103,6 +127,56 @@ "id" ] }, + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From Annotation/note", "href": "Patient/{id}", @@ -127,6 +201,31 @@ "templateRequired": [ "id" ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] } ], "properties": { @@ -523,6 +622,78 @@ "additionalProperties": false, "description": "A reference to a document. A reference to a document of any kind for any purpose. While the term \u201cdocument\u201d implies a more narrow focus, for this resource this \"document\" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference. [See https://hl7.org/fhir/R5/DocumentReference.html]", "links": [ + { + "href": "Practitioner/{id}", + "rel": "author_Practitioner", + "targetHints": { + "backref": [ + "author_document_reference" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/author/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "author_PractitionerRole", + "targetHints": { + "backref": [ + "author_document_reference" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/author/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "author_Organization", + "targetHints": { + "backref": [ + "author_document_reference" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/author/-/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Patient/{id}", "rel": "author_Patient", @@ -548,11 +719,11 @@ ] }, { - "href": "MedicationRequest/{id}", - "rel": "basedOn_MedicationRequest", + "href": "Encounter/{id}", + "rel": "context_Encounter", "targetHints": { "backref": [ - "basedOn_document_reference" + "context_document_reference" ], "direction": [ "outbound" @@ -562,10 +733,34 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationRequest" + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" }, "templatePointers": { - "id": "/basedOn/-/reference" + "id": "/context/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "custodian", + "targetHints": { + "backref": [ + "custodian_document_reference" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/custodian/reference" }, "templateRequired": [ "id" @@ -620,6 +815,81 @@ "id" ] }, + { + "$comment": "From DocumentReferenceAttester/attester", + "href": "Practitioner/{id}", + "rel": "attester_party_Practitioner", + "targetHints": { + "backref": [ + "document_reference_attester" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/attester/-/party/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From DocumentReferenceAttester/attester", + "href": "PractitionerRole/{id}", + "rel": "attester_party_PractitionerRole", + "targetHints": { + "backref": [ + "document_reference_attester" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/attester/-/party/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From DocumentReferenceAttester/attester", + "href": "Organization/{id}", + "rel": "attester_party_Organization", + "targetHints": { + "backref": [ + "document_reference_attester" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/attester/-/party/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From DocumentReferenceRelatesTo/relatesTo", "href": "DocumentReference/{id}", @@ -1061,17 +1331,17 @@ "title": "DocumentReference", "type": "object" }, - "TaskPerformer": { - "$id": "http://graph-fhir.io/schema/0.0.2/TaskPerformer", + "ImagingStudySeriesPerformer": { + "$id": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeriesPerformer", "additionalProperties": false, - "description": "Who or what performed the task. The entity who performed the requested task. [See https://hl7.org/fhir/R5/TaskPerformer.html]", + "description": "Who performed the series. Indicates who or what performed the series and how they were involved. [See https://hl7.org/fhir/R5/ImagingStudySeriesPerformer.html]", "links": [ { - "href": "Patient/{id}", - "rel": "actor_Patient", + "href": "Practitioner/{id}", + "rel": "actor_Practitioner", "targetHints": { "backref": [ - "task_performer" + "imaging_study_series_performer" ], "direction": [ "outbound" @@ -1081,7 +1351,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { "id": "/actor/reference" @@ -1089,10 +1359,272 @@ "templateRequired": [ "id" ] - } - ], - "properties": { - "actor": { + }, + { + "href": "PractitionerRole/{id}", + "rel": "actor_PractitionerRole", + "targetHints": { + "backref": [ + "imaging_study_series_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "actor_Organization", + "targetHints": { + "backref": [ + "imaging_study_series_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "actor_Patient", + "targetHints": { + "backref": [ + "imaging_study_series_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "actor": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "imaging_study_series_performer", + "description": "Indicates who or what performed the series.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam", + "Patient", + "Device", + "RelatedPerson", + "HealthcareService" + ], + "title": "Who performed the series" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "function": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "The type of involvement of the performer.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/series-performer-function", + "binding_version": null, + "description": "Distinguishes the type of involvement of the performer in the series.", + "element_property": true, + "title": "Type of performance" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "resourceType": { + "const": "ImagingStudySeriesPerformer", + "default": "ImagingStudySeriesPerformer", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "required": [ + "actor" + ], + "title": "ImagingStudySeriesPerformer", + "type": "object" + }, + "TaskPerformer": { + "$id": "http://graph-fhir.io/schema/0.0.2/TaskPerformer", + "additionalProperties": false, + "description": "Who or what performed the task. The entity who performed the requested task. [See https://hl7.org/fhir/R5/TaskPerformer.html]", + "links": [ + { + "href": "Practitioner/{id}", + "rel": "actor_Practitioner", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "actor_PractitionerRole", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "actor_Organization", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "actor_Patient", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "actor": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", "backref": "task_performer", "description": "The actor or entity who performed the task.", @@ -1596,8 +2128,8 @@ }, { "$comment": "From Annotation/note", - "href": "Patient/{id}", - "rel": "note_authorReference_Patient", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", "targetHints": { "backref": [ "annotation" @@ -1610,7 +2142,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { "id": "/note/-/authorReference/reference" @@ -1620,12 +2152,12 @@ ] }, { - "$comment": "From FamilyMemberHistoryParticipant/participant", - "href": "Patient/{id}", - "rel": "participant_actor_Patient", + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", "targetHints": { "backref": [ - "family_member_history_participant" + "annotation" ], "direction": [ "outbound" @@ -1635,19 +2167,169 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/participant/-/actor/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" ] - } - ], - "properties": { - "_ageString": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + }, + { + "$comment": "From Annotation/note", + "href": "Patient/{id}", + "rel": "note_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From FamilyMemberHistoryParticipant/participant", + "href": "Practitioner/{id}", + "rel": "participant_actor_Practitioner", + "targetHints": { + "backref": [ + "family_member_history_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From FamilyMemberHistoryParticipant/participant", + "href": "PractitionerRole/{id}", + "rel": "participant_actor_PractitionerRole", + "targetHints": { + "backref": [ + "family_member_history_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From FamilyMemberHistoryParticipant/participant", + "href": "Patient/{id}", + "rel": "participant_actor_Patient", + "targetHints": { + "backref": [ + "family_member_history_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From FamilyMemberHistoryParticipant/participant", + "href": "Organization/{id}", + "rel": "participant_actor_Organization", + "targetHints": { + "backref": [ + "family_member_history_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_ageString": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``ageString``." }, "_bornDate": { @@ -2322,24 +3004,24 @@ "description": "Measurements and simple assertions. Measurements and simple assertions made about a patient, device or other subject. [See https://hl7.org/fhir/R5/Observation.html]", "links": [ { - "href": "MedicationRequest/{id}", - "rel": "basedOn_MedicationRequest", + "href": "BodyStructure/{id}", + "rel": "bodyStructure", "targetHints": { "backref": [ - "basedOn_observation" + "observation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationRequest" + "$ref": "http://graph-fhir.io/schema/0.0.2/BodyStructure" }, "templatePointers": { - "id": "/basedOn/-/reference" + "id": "/bodyStructure/reference" }, "templateRequired": [ "id" @@ -2369,6 +3051,30 @@ "id" ] }, + { + "href": "ImagingStudy/{id}", + "rel": "derivedFrom_ImagingStudy", + "targetHints": { + "backref": [ + "derivedFrom_observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudy" + }, + "templatePointers": { + "id": "/derivedFrom/-/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Observation/{id}", "rel": "derivedFrom_Observation", @@ -2393,6 +3099,30 @@ "id" ] }, + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" + }, + "templatePointers": { + "id": "/encounter/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Resource/{id}", "rel": "focus", @@ -2466,8 +3196,8 @@ ] }, { - "href": "MedicationStatement/{id}", - "rel": "partOf_MedicationStatement", + "href": "Procedure/{id}", + "rel": "partOf_Procedure", "targetHints": { "backref": [ "partOf_observation" @@ -2480,7 +3210,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationStatement" + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" }, "templatePointers": { "id": "/partOf/-/reference" @@ -2490,11 +3220,11 @@ ] }, { - "href": "Patient/{id}", - "rel": "performer_Patient", + "href": "ImagingStudy/{id}", + "rel": "partOf_ImagingStudy", "targetHints": { "backref": [ - "performer_observation" + "partOf_observation" ], "direction": [ "outbound" @@ -2504,118 +3234,117 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudy" }, "templatePointers": { - "id": "/performer/-/reference" + "id": "/partOf/-/reference" }, "templateRequired": [ "id" ] }, { - "href": "Specimen/{id}", - "rel": "specimen_Specimen", + "href": "Practitioner/{id}", + "rel": "performer_Practitioner", "targetHints": { "backref": [ - "specimen_observation" + "performer_observation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_one" + "has_many" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/specimen/reference" + "id": "/performer/-/reference" }, "templateRequired": [ "id" ] }, { - "href": "Patient/{id}", - "rel": "subject_Patient", + "href": "PractitionerRole/{id}", + "rel": "performer_PractitionerRole", "targetHints": { "backref": [ - "subject_observation" + "performer_observation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_one" + "has_many" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/subject/reference" + "id": "/performer/-/reference" }, "templateRequired": [ "id" ] }, { - "href": "Medication/{id}", - "rel": "subject_Medication", + "href": "Organization/{id}", + "rel": "performer_Organization", "targetHints": { "backref": [ - "subject_observation" + "performer_observation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_one" + "has_many" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Medication" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { - "id": "/subject/reference" + "id": "/performer/-/reference" }, "templateRequired": [ "id" ] }, { - "href": "Substance/{id}", - "rel": "subject_Substance", + "href": "Patient/{id}", + "rel": "performer_Patient", "targetHints": { "backref": [ - "subject_observation" + "performer_observation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_one" + "has_many" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Substance" + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/subject/reference" + "id": "/performer/-/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From Annotation/note", - "href": "Patient/{id}", - "rel": "note_authorReference_Patient", + "href": "Specimen/{id}", + "rel": "specimen_Specimen", "targetHints": { "backref": [ - "annotation" + "specimen_observation" ], "direction": [ "outbound" @@ -2625,22 +3354,266 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" }, "templatePointers": { - "id": "/note/-/authorReference/reference" + "id": "/specimen/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From ObservationTriggeredBy/triggeredBy", - "href": "Observation/{id}", - "rel": "triggeredBy_observation", + "href": "Patient/{id}", + "rel": "subject_Patient", "targetHints": { "backref": [ - "observation_triggered_by" + "subject_observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "subject_Organization", + "targetHints": { + "backref": [ + "subject_observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Procedure/{id}", + "rel": "subject_Procedure", + "targetHints": { + "backref": [ + "subject_observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Practitioner/{id}", + "rel": "subject_Practitioner", + "targetHints": { + "backref": [ + "subject_observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Medication/{id}", + "rel": "subject_Medication", + "targetHints": { + "backref": [ + "subject_observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Medication" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Substance/{id}", + "rel": "subject_Substance", + "targetHints": { + "backref": [ + "subject_observation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Substance" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Patient/{id}", + "rel": "note_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ObservationTriggeredBy/triggeredBy", + "href": "Observation/{id}", + "rel": "triggeredBy_observation", + "targetHints": { + "backref": [ + "observation_triggered_by" ], "direction": [ "outbound" @@ -3517,8 +4490,8 @@ "description": "Who or what participated in the activities related to the family member history and how they were involved. Indicates who or what participated in the activities related to the family member history and how they were involved. [See https://hl7.org/fhir/R5/FamilyMemberHistoryParticipant.html]", "links": [ { - "href": "Patient/{id}", - "rel": "actor_Patient", + "href": "Practitioner/{id}", + "rel": "actor_Practitioner", "targetHints": { "backref": [ "family_member_history_participant" @@ -3531,7 +4504,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { "id": "/actor/reference" @@ -3539,33 +4512,105 @@ "templateRequired": [ "id" ] - } - ], - "properties": { - "actor": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "family_member_history_participant", - "description": "Indicates who or what participated in the activities related to the family member history.", - "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Patient", - "RelatedPerson", - "Device", - "Organization", - "CareTeam" - ], - "title": "Who or what participated in the activities related to the family member history" }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" + { + "href": "PractitionerRole/{id}", + "rel": "actor_PractitionerRole", + "targetHints": { + "backref": [ + "family_member_history_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "actor_Patient", + "targetHints": { + "backref": [ + "family_member_history_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "actor_Organization", + "targetHints": { + "backref": [ + "family_member_history_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "actor": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "family_member_history_participant", + "description": "Indicates who or what participated in the activities related to the family member history.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Patient", + "RelatedPerson", + "Device", + "Organization", + "CareTeam" + ], + "title": "Who or what participated in the activities related to the family member history" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" }, "fhir_comments": { "anyOf": [ @@ -3757,6 +4802,56 @@ "additionalProperties": false, "description": "Information produced as part of task. Outputs produced by the Task. [See https://hl7.org/fhir/R5/TaskOutput.html]", "links": [ + { + "$comment": "From Annotation/valueAnnotation", + "href": "Practitioner/{id}", + "rel": "valueAnnotation_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/valueAnnotation", + "href": "PractitionerRole/{id}", + "rel": "valueAnnotation_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From Annotation/valueAnnotation", "href": "Patient/{id}", @@ -3782,6 +4877,56 @@ "id" ] }, + { + "$comment": "From Annotation/valueAnnotation", + "href": "Organization/{id}", + "rel": "valueAnnotation_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ExtendedContactDetail/valueExtendedContactDetail", + "href": "Organization/{id}", + "rel": "valueExtendedContactDetail_organization", + "targetHints": { + "backref": [ + "extended_contact_detail" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueExtendedContactDetail/organization/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From RelatedArtifact/valueRelatedArtifact", "href": "Resource/{id}", @@ -3807,6 +4952,56 @@ "id" ] }, + { + "$comment": "From Signature/valueSignature", + "href": "Practitioner/{id}", + "rel": "valueSignature_onBehalfOf_Practitioner", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/valueSignature/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "PractitionerRole/{id}", + "rel": "valueSignature_onBehalfOf_PractitionerRole", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/valueSignature/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From Signature/valueSignature", "href": "Patient/{id}", @@ -3834,8 +5029,33 @@ }, { "$comment": "From Signature/valueSignature", - "href": "Patient/{id}", - "rel": "valueSignature_who_Patient", + "href": "Organization/{id}", + "rel": "valueSignature_onBehalfOf_Organization", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueSignature/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "Practitioner/{id}", + "rel": "valueSignature_who_Practitioner", "targetHints": { "backref": [ "who_signature" @@ -3848,7 +5068,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { "id": "/valueSignature/who/reference" @@ -3858,12 +5078,12 @@ ] }, { - "$comment": "From UsageContext/valueUsageContext", - "href": "ResearchStudy/{id}", - "rel": "valueUsageContext_valueReference_ResearchStudy", + "$comment": "From Signature/valueSignature", + "href": "PractitionerRole/{id}", + "rel": "valueSignature_who_PractitionerRole", "targetHints": { "backref": [ - "usage_context" + "who_signature" ], "direction": [ "outbound" @@ -3873,15 +5093,115 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudy" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/valueUsageContext/valueReference/reference" + "id": "/valueSignature/who/reference" }, "templateRequired": [ "id" ] - } + }, + { + "$comment": "From Signature/valueSignature", + "href": "Patient/{id}", + "rel": "valueSignature_who_Patient", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/valueSignature/who/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "Organization/{id}", + "rel": "valueSignature_who_Organization", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueSignature/who/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From UsageContext/valueUsageContext", + "href": "ResearchStudy/{id}", + "rel": "valueUsageContext_valueReference_ResearchStudy", + "targetHints": { + "backref": [ + "usage_context" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudy" + }, + "templatePointers": { + "id": "/valueUsageContext/valueReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From UsageContext/valueUsageContext", + "href": "Organization/{id}", + "rel": "valueUsageContext_valueReference_Organization", + "targetHints": { + "backref": [ + "usage_context" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueUsageContext/valueReference/reference" + }, + "templateRequired": [ + "id" + ] + } ], "properties": { "_valueBase64Binary": { @@ -4492,6 +5812,127 @@ "additionalProperties": false, "description": "Information about an individual or animal receiving health care services. Demographics and other administrative information about an individual or animal receiving care or other health-related services. [See https://hl7.org/fhir/R5/Patient.html]", "links": [ + { + "href": "Organization/{id}", + "rel": "generalPractitioner_Organization", + "targetHints": { + "backref": [ + "generalPractitioner_patient" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/generalPractitioner/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Practitioner/{id}", + "rel": "generalPractitioner_Practitioner", + "targetHints": { + "backref": [ + "generalPractitioner_patient" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/generalPractitioner/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "generalPractitioner_PractitionerRole", + "targetHints": { + "backref": [ + "generalPractitioner_patient" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/generalPractitioner/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "managingOrganization", + "targetHints": { + "backref": [ + "managingOrganization_patient" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/managingOrganization/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From PatientContact/contact", + "href": "Organization/{id}", + "rel": "contact_organization", + "targetHints": { + "backref": [ + "patient_contact" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/contact/-/organization/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From PatientLink/link", "href": "Patient/{id}", @@ -4817,6 +6258,33 @@ "$id": "http://graph-fhir.io/schema/0.0.2/Practitioner", "additionalProperties": false, "description": "A person with a formal responsibility in the provisioning of healthcare or related services. A person who is directly or indirectly involved in the provisioning of healthcare or related services. [See https://hl7.org/fhir/R5/Practitioner.html]", + "links": [ + { + "$comment": "From PractitionerQualification/qualification", + "href": "Organization/{id}", + "rel": "qualification_issuer", + "targetHints": { + "backref": [ + "practitioner_qualification" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/qualification/-/issuer/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "_active": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -4977,6 +6445,12 @@ "title": "Language of the resource content", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "meta": { "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", @@ -5049,8 +6523,8 @@ "description": "Text node with attribution. A text note which also contains information about who made the statement and when. [See https://hl7.org/fhir/R5/Annotation.html]", "links": [ { - "href": "Patient/{id}", - "rel": "authorReference_Patient", + "href": "Practitioner/{id}", + "rel": "authorReference_Practitioner", "targetHints": { "backref": [ "annotation" @@ -5063,7 +6537,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { "id": "/authorReference/reference" @@ -5071,24 +6545,96 @@ "templateRequired": [ "id" ] - } - ], - "properties": { - "_authorString": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``authorString``." - }, - "_text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``text``." }, - "_time": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``time``." + { + "href": "PractitionerRole/{id}", + "rel": "authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/authorReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "authorReference": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "annotation", + { + "href": "Patient/{id}", + "rel": "authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_authorString": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``authorString``." + }, + "_text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``text``." + }, + "_time": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``time``." + }, + "authorReference": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "annotation", "description": "The individual responsible for making the annotation.", "element_property": true, "enum_reference_types": [ @@ -5447,6 +6993,30 @@ "templateRequired": [ "id" ] + }, + { + "href": "Organization/{id}", + "rel": "valueReference_Organization", + "targetHints": { + "backref": [ + "usage_context" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueReference/reference" + }, + "templateRequired": [ + "id" + ] } ], "properties": { @@ -5627,6 +7197,80 @@ "$id": "http://graph-fhir.io/schema/0.0.2/DiagnosticReportSupportingInfo", "additionalProperties": false, "description": "Additional information supporting the diagnostic report. This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. [See https://hl7.org/fhir/R5/DiagnosticReportSupportingInfo.html]", + "links": [ + { + "href": "Procedure/{id}", + "rel": "reference_Procedure", + "targetHints": { + "backref": [ + "diagnostic_report_supporting_info" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" + }, + "templatePointers": { + "id": "/reference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Observation/{id}", + "rel": "reference_Observation", + "targetHints": { + "backref": [ + "diagnostic_report_supporting_info" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + }, + "templatePointers": { + "id": "/reference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "DiagnosticReport/{id}", + "rel": "reference_DiagnosticReport", + "targetHints": { + "backref": [ + "diagnostic_report_supporting_info" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReport" + }, + "templatePointers": { + "id": "/reference/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -5659,6 +7303,12 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -5735,6 +7385,30 @@ "id" ] }, + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "medication_request" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" + }, + "templatePointers": { + "id": "/encounter/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Patient/{id}", "rel": "informationSource_Patient", @@ -6434,6 +8108,7 @@ "$id": "http://graph-fhir.io/schema/0.0.2/PractitionerCommunication", "additionalProperties": false, "description": "A language which may be used to communicate with the practitioner. A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes. The `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis). [See https://hl7.org/fhir/R5/PractitionerCommunication.html]", + "links": [], "properties": { "_preferred": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -6480,6 +8155,12 @@ "element_property": true, "title": "The language code used to communicate with the practitioner" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -6748,6 +8429,80 @@ "$id": "http://graph-fhir.io/schema/0.0.2/EncounterParticipant", "additionalProperties": false, "description": "List of participants involved in the encounter. The list of people responsible for providing the service. [See https://hl7.org/fhir/R5/EncounterParticipant.html]", + "links": [ + { + "href": "Patient/{id}", + "rel": "actor_Patient", + "targetHints": { + "backref": [ + "encounter_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Practitioner/{id}", + "rel": "actor_Practitioner", + "targetHints": { + "backref": [ + "encounter_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "actor_PractitionerRole", + "targetHints": { + "backref": [ + "encounter_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "actor": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", @@ -6796,6 +8551,12 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -6838,15 +8599,41 @@ "$id": "http://graph-fhir.io/schema/0.0.2/PractitionerQualification", "additionalProperties": false, "description": "Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care. The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality. [See https://hl7.org/fhir/R5/PractitionerQualification.html]", - "properties": { - "code": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Specific qualification the practitioner has to provide a service.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0360", - "binding_version": null, - "element_property": true, - "title": "Coded representation of the qualification" + "links": [ + { + "href": "Organization/{id}", + "rel": "issuer", + "targetHints": { + "backref": [ + "practitioner_qualification" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/issuer/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "code": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Specific qualification the practitioner has to provide a service.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0360", + "binding_version": null, + "element_property": true, + "title": "Coded representation of the qualification" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -6897,6 +8684,12 @@ ], "title": "Organization that regulates and issues the qualification" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -6998,6 +8791,7 @@ "$id": "http://graph-fhir.io/schema/0.0.2/BodyStructureIncludedStructureBodyLandmarkOrientation", "additionalProperties": false, "description": "Landmark relative location. Body locations in relation to a specific body landmark (tatoo, scar, other body structure). [See https://hl7.org/fhir/R5/BodyStructureIncludedStructureBodyLandmarkOrientation.html]", + "links": [], "properties": { "clockFacePosition": { "binding_description": "Select SNOMED CT codes. A set of codes that describe a things orientation based on a hourly positions of a clock face.", @@ -7065,6 +8859,12 @@ "title": "Body ]andmark description", "type": "array" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -7103,6 +8903,54 @@ "additionalProperties": false, "description": "Who or what participated in the activities related to the condition and how they were involved. Indicates who or what participated in the activities related to the condition and how they were involved. [See https://hl7.org/fhir/R5/ConditionParticipant.html]", "links": [ + { + "href": "Practitioner/{id}", + "rel": "actor_Practitioner", + "targetHints": { + "backref": [ + "condition_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "actor_PractitionerRole", + "targetHints": { + "backref": [ + "condition_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Patient/{id}", "rel": "actor_Patient", @@ -7126,6 +8974,30 @@ "templateRequired": [ "id" ] + }, + { + "href": "Organization/{id}", + "rel": "actor_Organization", + "targetHints": { + "backref": [ + "condition_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] } ], "properties": { @@ -7215,107 +9087,98 @@ "title": "ConditionParticipant", "type": "object" }, - "Immunization": { - "$id": "http://graph-fhir.io/schema/0.0.2/Immunization", + "FHIRPrimitiveExtension": { + "$id": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "additionalProperties": false, - "description": "Immunization event information. 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. [See https://hl7.org/fhir/R5/Immunization.html]", + "description": " [See https://hl7.org/fhir/R5/FHIRPrimitiveExtension.html]", + "links": [], "properties": { - "_expirationDate": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``expirationDate``." - }, - "_implicitRules": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." - }, - "_isSubpotent": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``isSubpotent``." - }, - "_language": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``language``." - }, - "_lotNumber": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``lotNumber``." - }, - "_occurrenceDateTime": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``occurrenceDateTime``." - }, - "_occurrenceString": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``occurrenceString``." - }, - "_primarySource": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``primarySource``." - }, - "_status": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``status``." - }, - "administeredProduct": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", - "backref": "immunization", - "description": "An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.", - "element_property": true, - "enum_reference_types": [ - "Medication" - ], - "title": "Product that was administered" - }, - "basedOn": { - "backref": "basedOn_immunization", - "description": "A plan, order or recommendation fulfilled in whole or in part by this immunization.", + "extension": { + "description": "Additional content defined by implementations", "element_property": true, - "enum_reference_types": [ - "CarePlan", - "MedicationRequest", - "ServiceRequest", - "ImmunizationRecommendation" - ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Authority that the immunization event is based on", + "title": "List of `Extension` items (represented as `dict` in JSON)", "type": "array" }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", - "element_property": true, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for inter-element referencing", + "element_property": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Type `String`", + "type": "string" + }, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Contained, inline Resources", "type": "array" }, - "doseQuantity": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The quantity of vaccine product that was administered.", - "element_property": true, - "title": "Amount of vaccine administered" - }, - "encounter": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "immunization", - "description": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.", - "element_property": true, - "enum_reference_types": [ - "Encounter" - ], - "title": "Encounter immunization was part of" - }, - "expirationDate": { - "description": "Date vaccine batch expires.", - "element_property": true, - "format": "date", - "title": "Vaccine expiration date", + "resourceType": { + "const": "FHIRPrimitiveExtension", + "default": "FHIRPrimitiveExtension", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" + } + }, + "title": "FHIRPrimitiveExtension", + "type": "object" + }, + "ExtendedContactDetail": { + "$id": "http://graph-fhir.io/schema/0.0.2/ExtendedContactDetail", + "additionalProperties": false, + "description": "Contact information. Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization. [See https://hl7.org/fhir/R5/ExtendedContactDetail.html]", + "links": [ + { + "href": "Organization/{id}", + "rel": "organization", + "targetHints": { + "backref": [ + "extended_contact_detail" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/organization/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "address": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Address", + "element_property": true, + "title": "Address for the contact" }, "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" @@ -7338,525 +9201,122 @@ "element_property": false, "title": "Fhir Comments" }, - "fundingSource": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-funding-source", - "binding_version": null, - "description": "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).", - "element_property": true, - "title": "Funding source for the vaccine" - }, "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", - "type": "string" - }, - "identifier": { - "description": "A unique identifier assigned to this immunization record.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" - }, - "title": "Business identifier", - "type": "array" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "element_property": true, - "pattern": "\\S*", - "title": "A set of rules under which this content was created", - "type": "string" - }, - "informationSource": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", - "backref": "informationSource_immunization", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-origin", - "binding_version": null, - "description": "Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.", - "element_property": true, - "enum_reference_types": [ - "Patient", - "Practitioner", - "PractitionerRole", - "RelatedPerson", - "Organization" - ], - "title": "Indicates the source of a reported record" - }, - "isSubpotent": { - "description": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.", - "element_property": true, - "title": "Dose potency", - "type": "boolean" - }, - "language": { - "binding_description": "IETF language tag for a human language", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", - "binding_version": "5.0.0", - "description": "The base language in which the resource is written.", - "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Language of the resource content", - "type": "string" - }, - "location": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "immunization", - "description": "The service delivery location where the vaccine administration occurred.", - "element_property": true, - "enum_reference_types": [ - "Location" - ], - "title": "Where immunization occurred" - }, - "lotNumber": { - "description": "Lot number of the vaccine product.", + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, "pattern": "[ \\r\\n\\t\\S]+", - "title": "Vaccine lot number", + "title": "Unique id for inter-element referencing", "type": "string" }, - "manufacturer": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", - "backref": "manufacturer_immunization", - "description": "Name of vaccine manufacturer.", - "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "Vaccine manufacturer" - }, - "meta": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "element_property": true, - "title": "Metadata about the resource" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Extensions that cannot be ignored", "type": "array" }, - "note": { - "description": "Extra information about the immunization that is not conveyed by the other attributes.", + "name": { + "description": "The name of an individual to contact, some types of contact detail are usually blank.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" + "$ref": "http://graph-fhir.io/schema/0.0.2/HumanName" }, - "title": "Additional immunization notes", + "title": "Name of an individual to contact", "type": "array" }, - "occurrenceDateTime": { - "description": "Date vaccine administered or was to be administered.", - "element_property": true, - "format": "date-time", - "one_of_many": "occurrence", - "one_of_many_required": true, - "title": "Vaccine administration date", - "type": "string" - }, - "occurrenceString": { - "description": "Date vaccine administered or was to be administered.", - "element_property": true, - "one_of_many": "occurrence", - "one_of_many_required": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Vaccine administration date", - "type": "string" - }, - "patient": { + "organization": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "patient_immunization", - "description": "The patient who either received or did not receive the immunization.", + "backref": "extended_contact_detail", + "description": "This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.", "element_property": true, "enum_reference_types": [ - "Patient" + "Organization" ], - "title": "Who was immunized" - }, - "performer": { - "description": "Indicates who performed the immunization event.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationPerformer" - }, - "title": "Who performed event", - "type": "array" - }, - "primarySource": { - "description": "Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.", - "element_property": true, - "title": "Indicates context the data was captured in", - "type": "boolean" - }, - "programEligibility": { - "description": "Indicates a patient's eligibility for a funding program.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationProgramEligibility" - }, - "title": "Patient eligibility for a specific vaccination program", - "type": "array" - }, - "protocolApplied": { - "description": "The protocol (set of recommendations) being followed by the provider who administered the dose.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationProtocolApplied" - }, - "title": "Protocol followed by the provider", - "type": "array" + "title": "This contact detail is handled/monitored by a specific organization" }, - "reaction": { - "description": "Categorical data indicating that an adverse event is associated in time to an immunization.", + "period": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationReaction" - }, - "title": "Details of a reaction that follows immunization", - "type": "array" + "title": "Period that this contact was valid for usage" }, - "reason": { - "backref": "reason_immunization", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-reason", + "purpose": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "The purpose for which an extended contact detail should be used.", + "binding_strength": "preferred", + "binding_uri": "http://terminology.hl7.org/ValueSet/contactentity-type", "binding_version": null, - "description": "Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.", + "description": "The purpose/type of contact.", "element_property": true, - "enum_reference_types": [ - "Condition", - "Observation", - "DiagnosticReport" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" - }, - "title": "Why immunization occurred", - "type": "array" + "title": "The type of contact" }, "resourceType": { - "const": "Immunization", - "default": "Immunization", + "const": "ExtendedContactDetail", + "default": "ExtendedContactDetail", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, - "route": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-route", - "binding_version": null, - "description": "The path by which the vaccine product is taken into the body.", - "element_property": true, - "title": "How vaccine entered body" - }, - "site": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-site", - "binding_version": null, - "description": "Body site where vaccine was administered.", - "element_property": true, - "title": "Body site vaccine was administered" - }, - "status": { - "binding_description": "x", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-status", - "binding_version": "5.0.0", - "description": "Indicates the current status of the immunization event.", - "element_property": true, - "element_required": true, - "enum_values": [ - "completed", - "entered-in-error", - "not-done" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "completed | entered-in-error | not-done", - "type": "string" - }, - "statusReason": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-status-reason", - "binding_version": null, - "description": "Indicates the reason the immunization event was not performed.", - "element_property": true, - "title": "Reason for current status" - }, - "subpotentReason": { - "binding_description": "The reason why a dose is considered to be subpotent.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-subpotent-reason", - "binding_version": null, - "description": "Reason why a dose is considered to be subpotent.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" - }, - "title": "Reason for being subpotent", - "type": "array" - }, - "supportingInformation": { - "backref": "supportingInformation_immunization", - "description": "Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.", + "telecom": { + "description": "The contact details application for the purpose defined.", "element_property": true, - "enum_reference_types": [ - "Resource" - ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "http://graph-fhir.io/schema/0.0.2/ContactPoint" }, - "title": "Additional information in support of the immunization", + "title": "Contact details (e.g.phone/fax/url)", "type": "array" - }, - "text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "element_property": true, - "title": "Text summary of the resource, for human interpretation" - }, - "vaccineCode": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/vaccine-code", - "binding_version": null, - "description": "Vaccine that was administered or was to be administered.", - "element_property": true, - "title": "Vaccine administered" } }, - "required": [ - "patient", - "vaccineCode" - ], - "title": "Immunization", + "title": "ExtendedContactDetail", "type": "object" }, - "FHIRPrimitiveExtension": { - "$id": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "DataRequirementValueFilter": { + "$id": "http://graph-fhir.io/schema/0.0.2/DataRequirementValueFilter", "additionalProperties": false, - "description": " [See https://hl7.org/fhir/R5/FHIRPrimitiveExtension.html]", + "description": "What values are expected. Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed). [See https://hl7.org/fhir/R5/DataRequirementValueFilter.html]", "links": [], "properties": { + "_comparator": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``comparator``." + }, + "_path": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``path``." + }, + "_searchParam": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``searchParam``." + }, + "_valueDateTime": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``valueDateTime``." + }, + "comparator": { + "binding_description": "Possible comparators for the valueFilter element.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/value-filter-comparator", + "binding_version": "5.0.0", + "description": "The comparator to be used to determine whether the value is matching.", + "element_property": true, + "enum_values": [ + "eq", + "gt", + "lt", + "ge", + "le", + "sa", + "eb" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "eq | gt | lt | ge | le | sa | eb", + "type": "string" + }, "extension": { - "description": "Additional content defined by implementations", + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "List of `Extension` items (represented as `dict` in JSON)", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for inter-element referencing", - "element_property": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Type `String`", - "type": "string" - }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" - }, - "type": "array" - }, - "resourceType": { - "const": "FHIRPrimitiveExtension", - "default": "FHIRPrimitiveExtension", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "title": "FHIRPrimitiveExtension", - "type": "object" - }, - "ExtendedContactDetail": { - "$id": "http://graph-fhir.io/schema/0.0.2/ExtendedContactDetail", - "additionalProperties": false, - "description": "Contact information. Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization. [See https://hl7.org/fhir/R5/ExtendedContactDetail.html]", - "links": [], - "properties": { - "address": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Address", - "element_property": true, - "title": "Address for the contact" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" - }, - "type": "array" - }, - "name": { - "description": "The name of an individual to contact, some types of contact detail are usually blank.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/HumanName" - }, - "title": "Name of an individual to contact", - "type": "array" - }, - "organization": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "extended_contact_detail", - "description": "This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.", - "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "This contact detail is handled/monitored by a specific organization" - }, - "period": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "element_property": true, - "title": "Period that this contact was valid for usage" - }, - "purpose": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "The purpose for which an extended contact detail should be used.", - "binding_strength": "preferred", - "binding_uri": "http://terminology.hl7.org/ValueSet/contactentity-type", - "binding_version": null, - "description": "The purpose/type of contact.", - "element_property": true, - "title": "The type of contact" - }, - "resourceType": { - "const": "ExtendedContactDetail", - "default": "ExtendedContactDetail", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "telecom": { - "description": "The contact details application for the purpose defined.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ContactPoint" - }, - "title": "Contact details (e.g.phone/fax/url)", - "type": "array" - } - }, - "title": "ExtendedContactDetail", - "type": "object" - }, - "DataRequirementValueFilter": { - "$id": "http://graph-fhir.io/schema/0.0.2/DataRequirementValueFilter", - "additionalProperties": false, - "description": "What values are expected. Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed). [See https://hl7.org/fhir/R5/DataRequirementValueFilter.html]", - "links": [], - "properties": { - "_comparator": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``comparator``." - }, - "_path": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``path``." - }, - "_searchParam": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``searchParam``." - }, - "_valueDateTime": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``valueDateTime``." - }, - "comparator": { - "binding_description": "Possible comparators for the valueFilter element.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/value-filter-comparator", - "binding_version": "5.0.0", - "description": "The comparator to be used to determine whether the value is matching.", - "element_property": true, - "enum_values": [ - "eq", - "gt", - "lt", - "ge", - "le", - "sa", - "eb" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "eq | gt | lt | ge | le | sa | eb", - "type": "string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", + "title": "Additional content defined by implementations", "type": "array" }, "fhir_comments": { @@ -7937,24 +9397,34 @@ "title": "DataRequirementValueFilter", "type": "object" }, - "ImmunizationReaction": { - "$id": "http://graph-fhir.io/schema/0.0.2/ImmunizationReaction", + "DataRequirementSort": { + "$id": "http://graph-fhir.io/schema/0.0.2/DataRequirementSort", "additionalProperties": false, - "description": "Details of a reaction that follows immunization. Categorical data indicating that an adverse event is associated in time to an immunization. [See https://hl7.org/fhir/R5/ImmunizationReaction.html]", + "description": "Order of the results. Specifies the order of the results to be returned. [See https://hl7.org/fhir/R5/DataRequirementSort.html]", + "links": [], "properties": { - "_date": { + "_direction": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``date``." + "title": "Extension field for ``direction``." }, - "_reported": { + "_path": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``reported``." + "title": "Extension field for ``path``." }, - "date": { - "description": "Date of reaction to the immunization.", + "direction": { + "binding_description": "The possible sort directions, ascending or descending.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/sort-direction", + "binding_version": "5.0.0", + "description": "The direction of the sort, ascending or descending.", "element_property": true, - "format": "date-time", - "title": "When reaction started", + "element_required": true, + "enum_values": [ + "ascending", + "descending" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "ascending | descending", "type": "string" }, "extension": { @@ -7988,72 +9458,216 @@ "title": "Unique id for inter-element referencing", "type": "string" }, - "manifestation": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", - "backref": "immunization_reaction", - "description": "Details of the reaction.", - "element_property": true, - "enum_reference_types": [ - "Observation" - ], - "title": "Additional information on reaction" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, - "reported": { - "description": "Self-reported indicator.", + "path": { + "description": "The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.", "element_property": true, - "title": "Indicates self-reported reaction", - "type": "boolean" + "element_required": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "The name of the attribute to perform the sort", + "type": "string" }, "resourceType": { - "const": "ImmunizationReaction", - "default": "ImmunizationReaction", + "const": "DataRequirementSort", + "default": "DataRequirementSort", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" } }, - "title": "ImmunizationReaction", + "title": "DataRequirementSort", "type": "object" }, - "DataRequirementSort": { - "$id": "http://graph-fhir.io/schema/0.0.2/DataRequirementSort", + "ImagingStudySeries": { + "$id": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeries", "additionalProperties": false, - "description": "Order of the results. Specifies the order of the results to be returned. [See https://hl7.org/fhir/R5/DataRequirementSort.html]", - "links": [], - "properties": { - "_direction": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``direction``." - }, - "_path": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``path``." - }, - "direction": { - "binding_description": "The possible sort directions, ascending or descending.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/sort-direction", - "binding_version": "5.0.0", - "description": "The direction of the sort, ascending or descending.", + "description": "Each study has one or more series of instances. Each study has one or more series of images or other content. [See https://hl7.org/fhir/R5/ImagingStudySeries.html]", + "links": [ + { + "href": "Specimen/{id}", + "rel": "specimen", + "targetHints": { + "backref": [ + "specimen_imaging_study_series" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" + }, + "templatePointers": { + "id": "/specimen/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ImagingStudySeriesPerformer/performer", + "href": "Practitioner/{id}", + "rel": "performer_actor_Practitioner", + "targetHints": { + "backref": [ + "imaging_study_series_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ImagingStudySeriesPerformer/performer", + "href": "PractitionerRole/{id}", + "rel": "performer_actor_PractitionerRole", + "targetHints": { + "backref": [ + "imaging_study_series_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ImagingStudySeriesPerformer/performer", + "href": "Organization/{id}", + "rel": "performer_actor_Organization", + "targetHints": { + "backref": [ + "imaging_study_series_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ImagingStudySeriesPerformer/performer", + "href": "Patient/{id}", + "rel": "performer_actor_Patient", + "targetHints": { + "backref": [ + "imaging_study_series_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_description": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``description``." + }, + "_number": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``number``." + }, + "_numberOfInstances": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``numberOfInstances``." + }, + "_started": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``started``." + }, + "_uid": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``uid``." + }, + "bodySite": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", + "backref": "imaging_study_series", + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.", "element_property": true, - "element_required": true, - "enum_values": [ - "ascending", - "descending" + "enum_reference_types": [ + "BodyStructure" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "ascending | descending", + "title": "Body part examined" + }, + "description": { + "description": "A description of the series.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "A short human readable summary of the series", "type": "string" }, + "endpoint": { + "backref": "endpoint_imaging_study_series", + "description": "The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType.", + "element_property": true, + "enum_reference_types": [ + "Endpoint" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Series access endpoint", + "type": "array" + }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, @@ -8085,29 +9699,115 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "instance": { + "description": "A single SOP instance within the series, e.g. an image, or presentation state.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeriesInstance" + }, + "title": "A single SOP instance from the series", + "type": "array" + }, + "laterality": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Codes describing body site laterality (left, right, etc.).", + "binding_strength": "example", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html", + "binding_version": null, + "description": "The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.", + "element_property": true, + "title": "Body part laterality" + }, "links": { "items": { "$ref": "https://json-schema.org/draft/2020-12/links" }, "type": "array" }, - "path": { - "description": "The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.", + "modality": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "binding_version": null, + "description": "The distinct modality for this series. This may include both acquisition and non-acquisition modalities.", "element_property": true, - "element_required": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "The name of the attribute to perform the sort", - "type": "string" + "title": "The modality used for this series" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "number": { + "description": "The numeric identifier of this series in the study.", + "element_property": true, + "minimum": 0, + "title": "Numeric identifier of this series", + "type": "integer" + }, + "numberOfInstances": { + "description": "Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.", + "element_property": true, + "minimum": 0, + "title": "Number of Series Related Instances", + "type": "integer" + }, + "performer": { + "description": "Indicates who or what performed the series and how they were involved.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeriesPerformer" + }, + "title": "Who performed the series", + "type": "array" }, "resourceType": { - "const": "DataRequirementSort", - "default": "DataRequirementSort", + "const": "ImagingStudySeries", + "default": "ImagingStudySeries", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" + }, + "specimen": { + "backref": "specimen_imaging_study_series", + "description": "The specimen imaged, e.g., for whole slide imaging of a biopsy.", + "element_property": true, + "enum_reference_types": [ + "Specimen" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Specimen imaged", + "type": "array" + }, + "started": { + "description": "The date and time the series was started.", + "element_property": true, + "format": "date-time", + "title": "When the series started", + "type": "string" + }, + "uid": { + "description": "The DICOM Series Instance UID for the series.", + "element_property": true, + "element_required": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "DICOM Series Instance UID for the series", + "type": "string" } }, - "title": "DataRequirementSort", + "required": [ + "modality" + ], + "title": "ImagingStudySeries", "type": "object" }, "MedicationStatement": { @@ -8140,35 +9840,35 @@ ] }, { - "href": "Patient/{id}", - "rel": "informationSource_Patient", + "href": "Encounter/{id}", + "rel": "encounter", "targetHints": { "backref": [ - "informationSource_medication_statement" + "medication_statement" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" }, "templatePointers": { - "id": "/informationSource/-/reference" + "id": "/encounter/reference" }, "templateRequired": [ "id" ] }, { - "href": "MedicationStatement/{id}", - "rel": "partOf_MedicationStatement", + "href": "Patient/{id}", + "rel": "informationSource_Patient", "targetHints": { "backref": [ - "partOf_medication_statement" + "informationSource_medication_statement" ], "direction": [ "outbound" @@ -8178,21 +9878,21 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationStatement" + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/partOf/-/reference" + "id": "/informationSource/-/reference" }, "templateRequired": [ "id" ] }, { - "href": "Observation/{id}", - "rel": "relatedClinicalInformation_Observation", + "href": "Procedure/{id}", + "rel": "partOf_Procedure", "targetHints": { "backref": [ - "relatedClinicalInformation_medication_statement" + "partOf_medication_statement" ], "direction": [ "outbound" @@ -8202,21 +9902,21 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" }, "templatePointers": { - "id": "/relatedClinicalInformation/-/reference" + "id": "/partOf/-/reference" }, "templateRequired": [ "id" ] }, { - "href": "Condition/{id}", - "rel": "relatedClinicalInformation_Condition", + "href": "MedicationStatement/{id}", + "rel": "partOf_MedicationStatement", "targetHints": { "backref": [ - "relatedClinicalInformation_medication_statement" + "partOf_medication_statement" ], "direction": [ "outbound" @@ -8226,10 +9926,58 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Condition" + "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationStatement" }, "templatePointers": { - "id": "/relatedClinicalInformation/-/reference" + "id": "/partOf/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Observation/{id}", + "rel": "relatedClinicalInformation_Observation", + "targetHints": { + "backref": [ + "relatedClinicalInformation_medication_statement" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + }, + "templatePointers": { + "id": "/relatedClinicalInformation/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Condition/{id}", + "rel": "relatedClinicalInformation_Condition", + "targetHints": { + "backref": [ + "relatedClinicalInformation_medication_statement" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Condition" + }, + "templatePointers": { + "id": "/relatedClinicalInformation/-/reference" }, "templateRequired": [ "id" @@ -8629,511 +10377,301 @@ "$id": "http://graph-fhir.io/schema/0.0.2/DiagnosticReport", "additionalProperties": false, "description": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports. The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. [See https://hl7.org/fhir/R5/DiagnosticReport.html]", - "properties": { - "_conclusion": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``conclusion``." - }, - "_effectiveDateTime": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``effectiveDateTime``." - }, - "_implicitRules": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." - }, - "_issued": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``issued``." - }, - "_language": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``language``." - }, - "_status": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``status``." - }, - "basedOn": { - "backref": "basedOn_diagnostic_report", - "description": "Details concerning a service requested.", - "element_property": true, - "enum_reference_types": [ - "CarePlan", - "ImmunizationRecommendation", - "MedicationRequest", - "NutritionOrder", - "ServiceRequest" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "links": [ + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "What was requested", - "type": "array" - }, - "category": { - "binding_description": "HL7 V2 table 0074", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", - "binding_version": null, - "description": "A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" }, - "title": "Service category", - "type": "array" + "templatePointers": { + "id": "/encounter/reference" + }, + "templateRequired": [ + "id" + ] }, - "code": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "LOINC Codes for Diagnostic Reports", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/report-codes", - "binding_version": null, - "description": "A code or name that describes this diagnostic report.", - "element_property": true, - "title": "Name/Code for this diagnostic report" + { + "href": "Practitioner/{id}", + "rel": "performer_Practitioner", + "targetHints": { + "backref": [ + "performer_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/performer/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "composition": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "diagnostic_report", - "description": "Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.", - "element_property": true, - "enum_reference_types": [ - "Composition" - ], - "title": "Reference to a Composition resource for the DiagnosticReport structure" + { + "href": "PractitionerRole/{id}", + "rel": "performer_PractitionerRole", + "targetHints": { + "backref": [ + "performer_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/performer/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "conclusion": { - "description": "Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.", - "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Clinical conclusion (interpretation) of test results", - "type": "string" + { + "href": "Organization/{id}", + "rel": "performer_Organization", + "targetHints": { + "backref": [ + "performer_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/performer/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "conclusionCode": { - "binding_description": "SNOMED CT Clinical Findings", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", - "binding_version": null, - "description": "One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + { + "href": "Observation/{id}", + "rel": "result", + "targetHints": { + "backref": [ + "result_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Codes for the clinical conclusion of test results", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + }, + "templatePointers": { + "id": "/result/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + { + "href": "Practitioner/{id}", + "rel": "resultsInterpreter_Practitioner", + "targetHints": { + "backref": [ + "resultsInterpreter_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Contained, inline Resources", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/resultsInterpreter/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "effectiveDateTime": { - "description": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", - "element_property": true, - "format": "date-time", - "one_of_many": "effective", - "one_of_many_required": false, - "title": "Clinically relevant time/time-period for report", - "type": "string" - }, - "effectivePeriod": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", - "element_property": true, - "one_of_many": "effective", - "one_of_many_required": false, - "title": "Clinically relevant time/time-period for report" - }, - "encounter": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "diagnostic_report", - "description": "The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.", - "element_property": true, - "enum_reference_types": [ - "Encounter" - ], - "title": "Health care event when test ordered" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "PractitionerRole/{id}", + "rel": "resultsInterpreter_PractitionerRole", + "targetHints": { + "backref": [ + "resultsInterpreter_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", - "type": "string" - }, - "identifier": { - "description": "Identifiers assigned to this report by the performer or other systems.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, - "title": "Business identifier for report", - "type": "array" - }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "element_property": true, - "pattern": "\\S*", - "title": "A set of rules under which this content was created", - "type": "string" - }, - "issued": { - "description": "The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.", - "element_property": true, - "format": "date-time", - "title": "DateTime this version was made", - "type": "string" - }, - "language": { - "binding_description": "IETF language tag for a human language", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", - "binding_version": "5.0.0", - "description": "The base language in which the resource is written.", - "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Language of the resource content", - "type": "string" - }, - "media": { - "description": "A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReportMedia" + "templatePointers": { + "id": "/resultsInterpreter/-/reference" }, - "title": "Key images or data associated with this report", - "type": "array" - }, - "meta": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", - "element_property": true, - "title": "Metadata about the resource" + "templateRequired": [ + "id" + ] }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "Organization/{id}", + "rel": "resultsInterpreter_Organization", + "targetHints": { + "backref": [ + "resultsInterpreter_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Extensions that cannot be ignored", - "type": "array" - }, - "note": { - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, - "title": "Comments about the diagnostic report", - "type": "array" - }, - "performer": { - "backref": "performer_diagnostic_report", - "description": "The diagnostic service that is responsible for issuing the report.", - "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "CareTeam" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "templatePointers": { + "id": "/resultsInterpreter/-/reference" }, - "title": "Responsible Diagnostic Service", - "type": "array" + "templateRequired": [ + "id" + ] }, - "presentedForm": { - "description": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Attachment" + { + "href": "Specimen/{id}", + "rel": "specimen", + "targetHints": { + "backref": [ + "specimen_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Entire report as issued", - "type": "array" - }, - "resourceType": { - "const": "DiagnosticReport", - "default": "DiagnosticReport", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "result": { - "backref": "result_diagnostic_report", - "description": "[Observations](observation.html) that are part of this diagnostic report.", - "element_property": true, - "enum_reference_types": [ - "Observation" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" }, - "title": "Observations", - "type": "array" - }, - "resultsInterpreter": { - "backref": "resultsInterpreter_diagnostic_report", - "description": "The practitioner or organization that is responsible for the report's conclusions and interpretations.", - "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "CareTeam" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "templatePointers": { + "id": "/specimen/-/reference" }, - "title": "Primary result interpreter", - "type": "array" + "templateRequired": [ + "id" + ] }, - "specimen": { - "backref": "specimen_diagnostic_report", - "description": "Details about the specimens on which this diagnostic report is based.", - "element_property": true, - "enum_reference_types": [ - "Specimen" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + { + "href": "ImagingStudy/{id}", + "rel": "study_ImagingStudy", + "targetHints": { + "backref": [ + "study_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Specimens this report is based on", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudy" + }, + "templatePointers": { + "id": "/study/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "status": { - "binding_description": "The status of the diagnostic report.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-report-status", - "binding_version": "5.0.0", - "description": "The status of the diagnostic report.", - "element_property": true, - "element_required": true, - "enum_values": [ - "registered", - "partial", - "preliminary", - "modified", - "final", - "amended", - "corrected", - "appended", - "cancelled", - "entered-in-error", - "unknown" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown", - "type": "string" - }, - "study": { - "backref": "study_diagnostic_report", - "description": "One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted.", - "element_property": true, - "enum_reference_types": [ - "GenomicStudy", - "ImagingStudy" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" - }, - "title": "Reference to full details of an analysis associated with the diagnostic report", - "type": "array" - }, - "subject": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "subject_diagnostic_report", - "description": "The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.", - "element_property": true, - "enum_reference_types": [ - "Patient", - "Group", - "Device", - "Location", - "Organization", - "Practitioner", - "Medication", - "Substance", - "BiologicallyDerivedProduct" - ], - "title": "The subject of the report - usually, but not always, the patient" - }, - "supportingInfo": { - "description": "This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReportSupportingInfo" - }, - "title": "Additional information supporting the diagnostic report", - "type": "array" - }, - "text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "element_property": true, - "title": "Text summary of the resource, for human interpretation" - } - }, - "required": [ - "code" - ], - "title": "DiagnosticReport", - "type": "object" - }, - "OrganizationQualification": { - "$id": "http://graph-fhir.io/schema/0.0.2/OrganizationQualification", - "additionalProperties": false, - "description": "Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care. The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization. [See https://hl7.org/fhir/R5/OrganizationQualification.html]", - "properties": { - "code": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "element_property": true, - "title": "Coded representation of the qualification" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "Patient/{id}", + "rel": "subject_Patient", + "targetHints": { + "backref": [ + "subject_diagnostic_report" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "identifier": { - "description": "An identifier allocated to this qualification for this organization.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, - "title": "An identifier for this qualification for the organization", - "type": "array" - }, - "issuer": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "organization_qualification", - "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "Organization that regulates and issues the qualification" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "templatePointers": { + "id": "/subject/reference" }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "period": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "element_property": true, - "title": "Period during which the qualification is valid" + "templateRequired": [ + "id" + ] }, - "resourceType": { - "const": "OrganizationQualification", - "default": "OrganizationQualification", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "required": [ - "code" - ], - "title": "OrganizationQualification", - "type": "object" - }, - "Task": { - "$id": "http://graph-fhir.io/schema/0.0.2/Task", - "additionalProperties": false, - "description": "A task to be performed. [See https://hl7.org/fhir/R5/Task.html]", - "links": [ { - "href": "Resource/{id}", - "rel": "basedOn", + "href": "Organization/{id}", + "rel": "subject_Organization", "targetHints": { "backref": [ - "basedOn_task" + "subject_diagnostic_report" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { - "id": "/basedOn/-/reference" + "id": "/subject/reference" }, "templateRequired": [ "id" ] }, { - "href": "Resource/{id}", - "rel": "focus", + "href": "Practitioner/{id}", + "rel": "subject_Practitioner", "targetHints": { "backref": [ - "focus_task" + "subject_diagnostic_report" ], "direction": [ "outbound" @@ -9143,21 +10681,21 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/focus/reference" + "id": "/subject/reference" }, "templateRequired": [ "id" ] }, { - "href": "Resource/{id}", - "rel": "for_fhir", + "href": "Medication/{id}", + "rel": "subject_Medication", "targetHints": { "backref": [ - "for_task" + "subject_diagnostic_report" ], "direction": [ "outbound" @@ -9167,21 +10705,21 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + "$ref": "http://graph-fhir.io/schema/0.0.2/Medication" }, "templatePointers": { - "id": "/for_fhir/reference" + "id": "/subject/reference" }, "templateRequired": [ "id" ] }, { - "href": "Patient/{id}", - "rel": "owner_Patient", + "href": "Substance/{id}", + "rel": "subject_Substance", "targetHints": { "backref": [ - "owner_task" + "subject_diagnostic_report" ], "direction": [ "outbound" @@ -9191,45 +10729,47 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Substance" }, "templatePointers": { - "id": "/owner/reference" + "id": "/subject/reference" }, "templateRequired": [ "id" ] }, { - "href": "Task/{id}", - "rel": "partOf", + "$comment": "From DiagnosticReportMedia/media", + "href": "DocumentReference/{id}", + "rel": "media_link", "targetHints": { "backref": [ - "partOf_task" + "diagnostic_report_media" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Task" + "$ref": "http://graph-fhir.io/schema/0.0.2/DocumentReference" }, "templatePointers": { - "id": "/partOf/-/reference" + "id": "/media/-/link/reference" }, "templateRequired": [ "id" ] }, { - "href": "Patient/{id}", - "rel": "requester_Patient", + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", "targetHints": { "backref": [ - "requester_task" + "annotation" ], "direction": [ "outbound" @@ -9239,10 +10779,10 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/requester/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" @@ -9250,8 +10790,8 @@ }, { "$comment": "From Annotation/note", - "href": "Patient/{id}", - "rel": "note_authorReference_Patient", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", "targetHints": { "backref": [ "annotation" @@ -9264,7 +10804,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { "id": "/note/-/authorReference/reference" @@ -9274,12 +10814,12 @@ ] }, { - "$comment": "From TaskPerformer/performer", + "$comment": "From Annotation/note", "href": "Patient/{id}", - "rel": "performer_actor_Patient", + "rel": "note_authorReference_Patient", "targetHints": { "backref": [ - "task_performer" + "annotation" ], "direction": [ "outbound" @@ -9292,118 +10832,207 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/performer/-/actor/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From TaskRestriction/restriction", - "href": "Patient/{id}", - "rel": "restriction_recipient_Patient", + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", "targetHints": { "backref": [ - "recipient_task_restriction" + "annotation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { - "id": "/restriction/recipient/-/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" ] - } - ], - "properties": { - "_authoredOn": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``authoredOn``." }, - "_description": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``description``." + { + "$comment": "From DiagnosticReportSupportingInfo/supportingInfo", + "href": "Procedure/{id}", + "rel": "supportingInfo_reference_Procedure", + "targetHints": { + "backref": [ + "diagnostic_report_supporting_info" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" + }, + "templatePointers": { + "id": "/supportingInfo/-/reference/reference" + }, + "templateRequired": [ + "id" + ] }, - "_doNotPerform": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``doNotPerform``." + { + "$comment": "From DiagnosticReportSupportingInfo/supportingInfo", + "href": "Observation/{id}", + "rel": "supportingInfo_reference_Observation", + "targetHints": { + "backref": [ + "diagnostic_report_supporting_info" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + }, + "templatePointers": { + "id": "/supportingInfo/-/reference/reference" + }, + "templateRequired": [ + "id" + ] }, - "_implicitRules": { + { + "$comment": "From DiagnosticReportSupportingInfo/supportingInfo", + "href": "DiagnosticReport/{id}", + "rel": "supportingInfo_reference_DiagnosticReport", + "targetHints": { + "backref": [ + "diagnostic_report_supporting_info" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReport" + }, + "templatePointers": { + "id": "/supportingInfo/-/reference/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_conclusion": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." + "title": "Extension field for ``conclusion``." }, - "_instantiatesCanonical": { + "_effectiveDateTime": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``instantiatesCanonical``." + "title": "Extension field for ``effectiveDateTime``." }, - "_instantiatesUri": { + "_implicitRules": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``instantiatesUri``." + "title": "Extension field for ``implicitRules``." }, - "_intent": { + "_issued": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``intent``." + "title": "Extension field for ``issued``." }, "_language": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``language``." }, - "_lastModified": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``lastModified``." - }, - "_priority": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``priority``." - }, "_status": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``status``." }, - "authoredOn": { - "description": "The date and time this task was created.", - "element_property": true, - "format": "date-time", - "title": "Task Creation Date", - "type": "string" - }, "basedOn": { - "backref": "basedOn_task", - "description": "BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.", + "backref": "basedOn_diagnostic_report", + "description": "Details concerning a service requested.", "element_property": true, "enum_reference_types": [ - "Resource" + "CarePlan", + "ImmunizationRecommendation", + "MedicationRequest", + "NutritionOrder", + "ServiceRequest" ], "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "Request fulfilled by this task", + "title": "What was requested", "type": "array" }, - "businessStatus": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "description": "Contains business-specific nuances of the business state.", + "category": { + "binding_description": "HL7 V2 table 0074", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "binding_version": null, + "description": "A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", "element_property": true, - "title": "E.g. \"Specimen collected\", \"IV prepped\"" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "Service category", + "type": "array" }, "code": { "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", + "binding_description": "LOINC Codes for Diagnostic Reports", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/report-codes", + "binding_version": null, + "description": "A code or name that describes this diagnostic report.", + "element_property": true, + "title": "Name/Code for this diagnostic report" + }, + "composition": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "diagnostic_report", + "description": "Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.", + "element_property": true, + "enum_reference_types": [ + "Composition" + ], + "title": "Reference to a Composition resource for the DiagnosticReport structure" + }, + "conclusion": { + "description": "Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.", + "element_property": true, + "pattern": "\\s*(\\S|\\s)*", + "title": "Clinical conclusion (interpretation) of test results", + "type": "string" + }, + "conclusionCode": { + "binding_description": "SNOMED CT Clinical Findings", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", "binding_version": null, - "description": "A name or code (or both) briefly describing what the task involves.", + "description": "One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", "element_property": true, - "title": "Task Type" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "Codes for the clinical conclusion of test results", + "type": "array" }, "contained": { "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", @@ -9414,34 +11043,32 @@ "title": "Contained, inline Resources", "type": "array" }, - "description": { - "description": "A free-text description of what is to be performed.", + "effectiveDateTime": { + "description": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Human-readable explanation of task", + "format": "date-time", + "one_of_many": "effective", + "one_of_many_required": false, + "title": "Clinically relevant time/time-period for report", "type": "string" }, - "doNotPerform": { - "description": "If true indicates that the Task is asking for the specified action to *not* occur.", + "effectivePeriod": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", "element_property": true, - "title": "True if Task is prohibiting action", - "type": "boolean" + "one_of_many": "effective", + "one_of_many_required": false, + "title": "Clinically relevant time/time-period for report" }, "encounter": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "task", - "description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", + "backref": "diagnostic_report", + "description": "The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.", "element_property": true, "enum_reference_types": [ "Encounter" ], - "title": "Healthcare event during which this task originated" - }, - "executionPeriod": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).", - "element_property": true, - "title": "Start and end time of execution" + "title": "Health care event when test ordered" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -9467,32 +11094,6 @@ "element_property": false, "title": "Fhir Comments" }, - "focus": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "focus_task", - "description": "The request being fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.", - "element_property": true, - "enum_reference_types": [ - "Resource" - ], - "title": "What task is acting on" - }, - "for_fhir": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "for_task", - "description": "[Reserved word `for` renamed to `for_fhir`] The entity who benefits from the performance of the service specified in the task (e.g., the patient).", - "element_property": true, - "enum_reference_types": [ - "Resource" - ], - "title": "Beneficiary of the Task" - }, - "groupIdentifier": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier", - "description": "A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.", - "element_property": true, - "title": "Requisition or grouper id" - }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, @@ -9503,12 +11104,12 @@ "type": "string" }, "identifier": { - "description": "The business identifier for this task.", + "description": "Identifiers assigned to this report by the performer or other systems.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" }, - "title": "Task Instance Identifier", + "title": "Business identifier for report", "type": "array" }, "implicitRules": { @@ -9518,103 +11119,39 @@ "title": "A set of rules under which this content was created", "type": "string" }, - "input": { - "description": "Additional information that may be needed in the execution of the task.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/TaskInput" - }, - "title": "Information used to perform task", - "type": "array" - }, - "instantiatesCanonical": { - "description": "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", + "issued": { + "description": "The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.", "element_property": true, - "enum_reference_types": [ - "ActivityDefinition" - ], - "pattern": "\\S*", - "title": "Formal definition of task", + "format": "date-time", + "title": "DateTime this version was made", "type": "string" }, - "instantiatesUri": { - "description": "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", + "language": { + "binding_description": "IETF language tag for a human language", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "The base language in which the resource is written.", "element_property": true, - "pattern": "\\S*", - "title": "Formal definition of task", + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "Language of the resource content", "type": "string" }, - "insurance": { - "backref": "insurance_task", - "description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.", - "element_property": true, - "enum_reference_types": [ - "Coverage", - "ClaimResponse" - ], + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Associated insurance coverage", "type": "array" }, - "intent": { - "binding_description": "Distinguishes whether the task is a proposal, plan or full order.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-intent", - "binding_version": "5.0.0", - "description": "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.", - "element_property": true, - "element_required": true, - "enum_values": [ - "unknown", - "proposal", - "plan", - "order", - "original-order", - "reflex-order", - "filler-order", - "instance-order", - "option" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", - "type": "string" - }, - "language": { - "binding_description": "IETF language tag for a human language", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", - "binding_version": "5.0.0", - "description": "The base language in which the resource is written.", - "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Language of the resource content", - "type": "string" - }, - "lastModified": { - "description": "The date and time of last modification to this task.", + "media": { + "description": "A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).", "element_property": true, - "format": "date-time", - "title": "Task Last Modified Date", - "type": "string" - }, - "links": { "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReportMedia" }, + "title": "Key images or data associated with this report", "type": "array" }, - "location": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "task", - "description": "Principal physical location where this task is performed.", - "element_property": true, - "enum_reference_types": [ - "Location" - ], - "title": "Where task occurs" - }, "meta": { "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", @@ -9631,323 +11168,202 @@ "type": "array" }, "note": { - "description": "Free-text information captured about the task as it progresses.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" }, - "title": "Comments made about the task", - "type": "array" - }, - "output": { - "description": "Outputs produced by the Task.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/TaskOutput" - }, - "title": "Information produced as part of task", + "title": "Comments about the diagnostic report", "type": "array" }, - "owner": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "owner_task", - "description": "Party responsible for managing task execution.", + "performer": { + "backref": "performer_diagnostic_report", + "description": "The diagnostic service that is responsible for issuing the report.", "element_property": true, "enum_reference_types": [ "Practitioner", "PractitionerRole", "Organization", - "CareTeam", - "Patient", - "RelatedPerson" - ], - "title": "Responsible individual" - }, - "partOf": { - "backref": "partOf_task", - "description": "Task that this particular task is part of.", - "element_property": true, - "enum_reference_types": [ - "Task" + "CareTeam" ], "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "Composite task", + "title": "Responsible Diagnostic Service", "type": "array" }, - "performer": { - "description": "The entity who performed the requested task.", + "presentedForm": { + "description": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/TaskPerformer" + "$ref": "http://graph-fhir.io/schema/0.0.2/Attachment" }, - "title": "Who or what performed the task", + "title": "Entire report as issued", "type": "array" }, - "priority": { - "binding_description": "The priority of a task (may affect service level applied to the task).", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/request-priority", - "binding_version": "5.0.0", - "description": "Indicates how quickly the Task should be addressed with respect to other requests.", - "element_property": true, - "enum_values": [ - "routine", - "urgent", - "asap", - "stat" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "routine | urgent | asap | stat", + "resourceType": { + "const": "DiagnosticReport", + "default": "DiagnosticReport", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "reason": { - "backref": "reason_task", - "description": "A description, code, or reference indicating why this task needs to be performed.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" - }, - "title": "Why task is needed", - "type": "array" - }, - "relevantHistory": { - "backref": "relevantHistory_task", - "description": "Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.", + "result": { + "backref": "result_diagnostic_report", + "description": "[Observations](observation.html) that are part of this diagnostic report.", "element_property": true, "enum_reference_types": [ - "Provenance" + "Observation" ], "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "Key events in history of the Task", + "title": "Observations", "type": "array" }, - "requestedPerformer": { - "backref": "requestedPerformer_task", - "binding_description": "The type(s) of task performers allowed.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", - "binding_version": null, - "description": "The kind of participant or specific participant that should perform the task.", + "resultsInterpreter": { + "backref": "resultsInterpreter_diagnostic_report", + "description": "The practitioner or organization that is responsible for the report's conclusions and interpretations.", "element_property": true, "enum_reference_types": [ "Practitioner", "PractitionerRole", "Organization", - "CareTeam", - "HealthcareService", - "Patient", - "Device", - "RelatedPerson" + "CareTeam" ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "Who should perform Task", + "title": "Primary result interpreter", "type": "array" }, - "requestedPeriod": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "Indicates the start and/or end of the period of time when completion of the task is desired to take place.", - "element_property": true, - "title": "When the task should be performed" - }, - "requester": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "requester_task", - "description": "The creator of the task.", + "specimen": { + "backref": "specimen_diagnostic_report", + "description": "Details about the specimens on which this diagnostic report is based.", "element_property": true, "enum_reference_types": [ - "Device", - "Organization", - "Patient", - "Practitioner", - "PractitionerRole", - "RelatedPerson" + "Specimen" ], - "title": "Who is asking for task to be done" - }, - "resourceType": { - "const": "Task", - "default": "Task", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "restriction": { - "$ref": "http://graph-fhir.io/schema/0.0.2/TaskRestriction", - "description": "If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.", - "element_property": true, - "title": "Constraints on fulfillment tasks" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Specimens this report is based on", + "type": "array" }, "status": { - "binding_description": "The current status of the task.", + "binding_description": "The status of the diagnostic report.", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-status", + "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-report-status", "binding_version": "5.0.0", - "description": "The current status of the task.", + "description": "The status of the diagnostic report.", "element_property": true, "element_required": true, "enum_values": [ - "draft", - "requested", - "received", - "accepted", - "+" + "registered", + "partial", + "preliminary", + "modified", + "final", + "amended", + "corrected", + "appended", + "cancelled", + "entered-in-error", + "unknown" ], "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "draft | requested | received | accepted | +", + "title": "registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown", "type": "string" }, - "statusReason": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", - "backref": "task", - "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", - "binding_version": null, - "description": "An explanation as to why this task is held, failed, was refused, etc.", + "study": { + "backref": "study_diagnostic_report", + "description": "One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted.", "element_property": true, - "title": "Reason for current status" + "enum_reference_types": [ + "GenomicStudy", + "ImagingStudy" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Reference to full details of an analysis associated with the diagnostic report", + "type": "array" }, - "text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "element_property": true, - "title": "Text summary of the resource, for human interpretation" - } - }, - "title": "Task", - "type": "object" - }, - "ResearchStudyAssociatedParty": { - "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyAssociatedParty", - "additionalProperties": false, - "description": "Sponsors, collaborators, and other parties. [See https://hl7.org/fhir/R5/ResearchStudyAssociatedParty.html]", - "links": [], - "properties": { - "_name": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``name``." - }, - "classifier": { - "binding_description": "A characterization or type of the entity.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-party-organization-type", - "binding_version": null, - "description": "A categorization other than role for the associated party.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" - }, - "title": "nih | fda | government | nonprofit | academic | industry", - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "name": { - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Name of associated party", - "type": "string" - }, - "party": { + "subject": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "research_study_associated_party", + "backref": "subject_diagnostic_report", + "description": "The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.", "element_property": true, "enum_reference_types": [ + "Patient", + "Group", + "Device", + "Location", + "Organization", "Practitioner", - "PractitionerRole", - "Organization" + "Medication", + "Substance", + "BiologicallyDerivedProduct" ], - "title": "Individual or organization associated with study (use practitionerRole to specify their organisation)" + "title": "The subject of the report - usually, but not always, the patient" }, - "period": { - "description": "Identifies the start date and the end date of the associated party in the role.", + "supportingInfo": { + "description": "This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period" + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReportSupportingInfo" }, - "title": "When active in the role", + "title": "Additional information supporting the diagnostic report", "type": "array" }, - "resourceType": { - "const": "ResearchStudyAssociatedParty", - "default": "ResearchStudyAssociatedParty", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "role": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "desc.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-party-role", - "binding_version": null, - "description": "Type of association.", + "text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", + "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "element_property": true, - "title": "sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair" + "title": "Text summary of the resource, for human interpretation" } }, "required": [ - "role" + "code" ], - "title": "ResearchStudyAssociatedParty", + "title": "DiagnosticReport", "type": "object" }, - "Range": { - "$id": "http://graph-fhir.io/schema/0.0.2/Range", + "OrganizationQualification": { + "$id": "http://graph-fhir.io/schema/0.0.2/OrganizationQualification", "additionalProperties": false, - "description": "Set of values bounded by low and high. A set of ordered Quantities defined by a low and high limit. [See https://hl7.org/fhir/R5/Range.html]", - "links": [], + "description": "Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care. The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization. [See https://hl7.org/fhir/R5/OrganizationQualification.html]", + "links": [ + { + "href": "Organization/{id}", + "rel": "issuer", + "targetHints": { + "backref": [ + "organization_qualification" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/issuer/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { + "code": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "element_property": true, + "title": "Coded representation of the qualification" + }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, @@ -9972,12 +11388,6 @@ "element_property": false, "title": "Fhir Comments" }, - "high": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The high limit. The boundary is inclusive.", - "element_property": true, - "title": "High limit" - }, "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, @@ -9985,91 +11395,23 @@ "title": "Unique id for inter-element referencing", "type": "string" }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" - }, - "type": "array" - }, - "low": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The low limit. The boundary is inclusive.", - "element_property": true, - "title": "Low limit" - }, - "resourceType": { - "const": "Range", - "default": "Range", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "title": "Range", - "type": "object" - }, - "PatientContact": { - "$id": "http://graph-fhir.io/schema/0.0.2/PatientContact", - "additionalProperties": false, - "description": "A contact party (e.g. guardian, partner, friend) for the patient. [See https://hl7.org/fhir/R5/PatientContact.html]", - "links": [], - "properties": { - "_gender": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``gender``." - }, - "address": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Address", - "element_property": true, - "title": "Address for the contact person" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "identifier": { + "description": "An identifier allocated to this qualification for this organization.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" }, - "title": "Additional content defined by implementations", + "title": "An identifier for this qualification for the organization", "type": "array" }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "gender": { - "binding_description": "The gender of a person used for administrative purposes.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", - "binding_version": "5.0.0", - "description": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.", + "issuer": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "organization_qualification", "element_property": true, - "enum_values": [ - "male", - "female", - "other", - "unknown" + "enum_reference_types": [ + "Organization" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "male | female | other | unknown", - "type": "string" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" + "title": "Organization that regulates and issues the qualification" }, "links": { "items": { @@ -10086,323 +11428,204 @@ "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, - "name": { - "$ref": "http://graph-fhir.io/schema/0.0.2/HumanName", - "element_property": true, - "title": "A name associated with the contact person" - }, - "organization": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "patient_contact", - "description": "Organization on behalf of which the contact is acting or for which the contact is working.", - "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "Organization that is associated with the contact" - }, "period": { "$ref": "http://graph-fhir.io/schema/0.0.2/Period", "element_property": true, - "title": "The period during which this contact person or organization is valid to be contacted relating to this patient" - }, - "relationship": { - "binding_description": "The nature of the relationship between a patient and a contact person for that patient.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/patient-contactrelationship", - "binding_version": null, - "description": "The nature of the relationship between the patient and the contact person.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" - }, - "title": "The kind of relationship", - "type": "array" + "title": "Period during which the qualification is valid" }, "resourceType": { - "const": "PatientContact", - "default": "PatientContact", + "const": "OrganizationQualification", + "default": "OrganizationQualification", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" - }, - "telecom": { - "description": "A contact detail for the person, e.g. a telephone number or an email address.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ContactPoint" - }, - "title": "A contact detail for the person", - "type": "array" } }, - "title": "PatientContact", + "required": [ + "code" + ], + "title": "OrganizationQualification", "type": "object" }, - "DataRequirement": { - "$id": "http://graph-fhir.io/schema/0.0.2/DataRequirement", + "Task": { + "$id": "http://graph-fhir.io/schema/0.0.2/Task", "additionalProperties": false, - "description": "Describes a required data item. Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data. [See https://hl7.org/fhir/R5/DataRequirement.html]", - "links": [], - "properties": { - "_limit": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``limit``." - }, - "_mustSupport": { - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" + "description": "A task to be performed. [See https://hl7.org/fhir/R5/Task.html]", + "links": [ + { + "href": "Resource/{id}", + "rel": "basedOn", + "targetHints": { + "backref": [ + "basedOn_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Extension field for ``mustSupport``.", - "type": "array" - }, - "_profile": { - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" }, - "title": "Extension field for ``profile``.", - "type": "array" - }, - "_type": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``type``." - }, - "codeFilter": { - "description": "Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementCodeFilter" + "templatePointers": { + "id": "/basedOn/-/reference" }, - "title": "What codes are expected", - "type": "array" + "templateRequired": [ + "id" + ] }, - "dateFilter": { - "description": "Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementDateFilter" + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "What dates/date ranges are expected", - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "limit": { - "description": "Specifies a maximum number of results that are required (uses the _count search parameter).", - "element_property": true, - "exclusiveMinimum": 0, - "title": "Number of results", - "type": "integer" - }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + "templatePointers": { + "id": "/encounter/reference" }, - "type": "array" + "templateRequired": [ + "id" + ] }, - "mustSupport": { - "description": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).", - "element_property": true, - "items": { - "pattern": "[ \\r\\n\\t\\S]+", - "type": "string" + { + "href": "Resource/{id}", + "rel": "focus", + "targetHints": { + "backref": [ + "focus_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Indicates specific structure elements that are referenced by the knowledge module", - "type": "array" - }, - "profile": { - "description": "The profile of the required data, specified as the uri of the profile definition.", - "element_property": true, - "enum_reference_types": [ - "StructureDefinition" - ], - "items": { - "pattern": "\\S*", - "type": "string" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" }, - "title": "The profile of the required data", - "type": "array" - }, - "resourceType": { - "const": "DataRequirement", - "default": "DataRequirement", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "sort": { - "description": "Specifies the order of the results to be returned.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementSort" + "templatePointers": { + "id": "/focus/reference" }, - "title": "Order of the results", - "type": "array" + "templateRequired": [ + "id" + ] }, - "subjectCodeableConcept": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.", - "element_property": true, - "one_of_many": "subject", - "one_of_many_required": false, - "title": "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device" + { + "href": "Resource/{id}", + "rel": "for_fhir", + "targetHints": { + "backref": [ + "for_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + }, + "templatePointers": { + "id": "/for_fhir/reference" + }, + "templateRequired": [ + "id" + ] }, - "subjectReference": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "data_requirement", - "description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.", - "element_property": true, - "enum_reference_types": [ - "Group" - ], - "one_of_many": "subject", - "one_of_many_required": false, - "title": "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device" - }, - "type": { - "binding_description": "List of FHIR types (resources, data types).", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/fhir-types", - "binding_version": "5.0.0", - "description": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.", - "element_property": true, - "element_required": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "The type of the required data", - "type": "string" - }, - "valueFilter": { - "description": "Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementValueFilter" + { + "href": "Practitioner/{id}", + "rel": "owner_Practitioner", + "targetHints": { + "backref": [ + "owner_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "What values are expected", - "type": "array" - } - }, - "title": "DataRequirement", - "type": "object" - }, - "ProcedureFocalDevice": { - "$id": "http://graph-fhir.io/schema/0.0.2/ProcedureFocalDevice", - "additionalProperties": false, - "description": "Manipulated, implanted, or removed device. A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure. [See https://hl7.org/fhir/R5/ProcedureFocalDevice.html]", - "properties": { - "action": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "A kind of change that happened to the device during the procedure.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/device-action", - "binding_version": null, - "description": "The kind of change that happened to the device during the procedure.", - "element_property": true, - "title": "Kind of change to device" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" + "templatePointers": { + "id": "/owner/reference" + }, + "templateRequired": [ + "id" + ] }, - "manipulated": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "procedure_focal_device", - "description": "The device that was manipulated (changed) during the procedure.", - "element_property": true, - "enum_reference_types": [ - "Device" - ], - "title": "Device that was changed" + { + "href": "PractitionerRole/{id}", + "rel": "owner_PractitionerRole", + "targetHints": { + "backref": [ + "owner_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/owner/reference" + }, + "templateRequired": [ + "id" + ] }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "Organization/{id}", + "rel": "owner_Organization", + "targetHints": { + "backref": [ + "owner_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/owner/reference" + }, + "templateRequired": [ + "id" + ] }, - "resourceType": { - "const": "ProcedureFocalDevice", - "default": "ProcedureFocalDevice", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "required": [ - "manipulated" - ], - "title": "ProcedureFocalDevice", - "type": "object" - }, - "Condition": { - "$id": "http://graph-fhir.io/schema/0.0.2/Condition", - "additionalProperties": false, - "description": "Detailed information about conditions, problems or diagnoses. A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. [See https://hl7.org/fhir/R5/Condition.html]", - "links": [ { "href": "Patient/{id}", - "rel": "subject_Patient", + "rel": "owner_Patient", "targetHints": { "backref": [ - "condition" + "owner_task" ], "direction": [ "outbound" @@ -10415,19 +11638,42 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/subject/reference" + "id": "/owner/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From Annotation/note", - "href": "Patient/{id}", - "rel": "note_authorReference_Patient", + "href": "Task/{id}", + "rel": "partOf", "targetHints": { "backref": [ - "annotation" + "partOf_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Task" + }, + "templatePointers": { + "id": "/partOf/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "requester_Organization", + "targetHints": { + "backref": [ + "requester_task" ], "direction": [ "outbound" @@ -10437,22 +11683,21 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { - "id": "/note/-/authorReference/reference" + "id": "/requester/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From ConditionParticipant/participant", "href": "Patient/{id}", - "rel": "participant_actor_Patient", + "rel": "requester_Patient", "targetHints": { "backref": [ - "condition_participant" + "requester_task" ], "direction": [ "outbound" @@ -10465,50 +11710,1850 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/participant/-/actor/reference" + "id": "/requester/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From ConditionStage/stage", - "href": "Observation/{id}", - "rel": "stage_assessment_Observation", + "href": "Practitioner/{id}", + "rel": "requester_Practitioner", "targetHints": { "backref": [ - "assessment_condition_stage" + "requester_task" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/stage/-/assessment/-/reference" + "id": "/requester/reference" }, "templateRequired": [ "id" ] - } - ], - "properties": { - "_abatementDateTime": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``abatementDateTime``." - }, - "_abatementString": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``abatementString``." }, - "_implicitRules": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." + { + "href": "PractitionerRole/{id}", + "rel": "requester_PractitionerRole", + "targetHints": { + "backref": [ + "requester_task" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/requester/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Patient/{id}", + "rel": "note_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskPerformer/performer", + "href": "Practitioner/{id}", + "rel": "performer_actor_Practitioner", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskPerformer/performer", + "href": "PractitionerRole/{id}", + "rel": "performer_actor_PractitionerRole", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskPerformer/performer", + "href": "Organization/{id}", + "rel": "performer_actor_Organization", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskPerformer/performer", + "href": "Patient/{id}", + "rel": "performer_actor_Patient", + "targetHints": { + "backref": [ + "task_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskRestriction/restriction", + "href": "Patient/{id}", + "rel": "restriction_recipient_Patient", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/restriction/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskRestriction/restriction", + "href": "Practitioner/{id}", + "rel": "restriction_recipient_Practitioner", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/restriction/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskRestriction/restriction", + "href": "PractitionerRole/{id}", + "rel": "restriction_recipient_PractitionerRole", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/restriction/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From TaskRestriction/restriction", + "href": "Organization/{id}", + "rel": "restriction_recipient_Organization", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/restriction/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_authoredOn": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``authoredOn``." + }, + "_description": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``description``." + }, + "_doNotPerform": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``doNotPerform``." + }, + "_implicitRules": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``implicitRules``." + }, + "_instantiatesCanonical": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``instantiatesCanonical``." + }, + "_instantiatesUri": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``instantiatesUri``." + }, + "_intent": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``intent``." + }, + "_language": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``language``." + }, + "_lastModified": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``lastModified``." + }, + "_priority": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``priority``." + }, + "_status": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``status``." + }, + "authoredOn": { + "description": "The date and time this task was created.", + "element_property": true, + "format": "date-time", + "title": "Task Creation Date", + "type": "string" + }, + "basedOn": { + "backref": "basedOn_task", + "description": "BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Request fulfilled by this task", + "type": "array" + }, + "businessStatus": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "description": "Contains business-specific nuances of the business state.", + "element_property": true, + "title": "E.g. \"Specimen collected\", \"IV prepped\"" + }, + "code": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", + "binding_version": null, + "description": "A name or code (or both) briefly describing what the task involves.", + "element_property": true, + "title": "Task Type" + }, + "contained": { + "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + }, + "title": "Contained, inline Resources", + "type": "array" + }, + "description": { + "description": "A free-text description of what is to be performed.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Human-readable explanation of task", + "type": "string" + }, + "doNotPerform": { + "description": "If true indicates that the Task is asking for the specified action to *not* occur.", + "element_property": true, + "title": "True if Task is prohibiting action", + "type": "boolean" + }, + "encounter": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "task", + "description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "Healthcare event during which this task originated" + }, + "executionPeriod": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).", + "element_property": true, + "title": "Start and end time of execution" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "focus": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "focus_task", + "description": "The request being fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "title": "What task is acting on" + }, + "for_fhir": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "for_task", + "description": "[Reserved word `for` renamed to `for_fhir`] The entity who benefits from the performance of the service specified in the task (e.g., the patient).", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "title": "Beneficiary of the Task" + }, + "groupIdentifier": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier", + "description": "A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.", + "element_property": true, + "title": "Requisition or grouper id" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "The business identifier for this task.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + }, + "title": "Task Instance Identifier", + "type": "array" + }, + "implicitRules": { + "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", + "element_property": true, + "pattern": "\\S*", + "title": "A set of rules under which this content was created", + "type": "string" + }, + "input": { + "description": "Additional information that may be needed in the execution of the task.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/TaskInput" + }, + "title": "Information used to perform task", + "type": "array" + }, + "instantiatesCanonical": { + "description": "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", + "element_property": true, + "enum_reference_types": [ + "ActivityDefinition" + ], + "pattern": "\\S*", + "title": "Formal definition of task", + "type": "string" + }, + "instantiatesUri": { + "description": "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", + "element_property": true, + "pattern": "\\S*", + "title": "Formal definition of task", + "type": "string" + }, + "insurance": { + "backref": "insurance_task", + "description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.", + "element_property": true, + "enum_reference_types": [ + "Coverage", + "ClaimResponse" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Associated insurance coverage", + "type": "array" + }, + "intent": { + "binding_description": "Distinguishes whether the task is a proposal, plan or full order.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-intent", + "binding_version": "5.0.0", + "description": "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.", + "element_property": true, + "element_required": true, + "enum_values": [ + "unknown", + "proposal", + "plan", + "order", + "original-order", + "reflex-order", + "filler-order", + "instance-order", + "option" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", + "type": "string" + }, + "language": { + "binding_description": "IETF language tag for a human language", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "The base language in which the resource is written.", + "element_property": true, + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "Language of the resource content", + "type": "string" + }, + "lastModified": { + "description": "The date and time of last modification to this task.", + "element_property": true, + "format": "date-time", + "title": "Task Last Modified Date", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "location": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "task", + "description": "Principal physical location where this task is performed.", + "element_property": true, + "enum_reference_types": [ + "Location" + ], + "title": "Where task occurs" + }, + "meta": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", + "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", + "element_property": true, + "title": "Metadata about the resource" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored", + "type": "array" + }, + "note": { + "description": "Free-text information captured about the task as it progresses.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" + }, + "title": "Comments made about the task", + "type": "array" + }, + "output": { + "description": "Outputs produced by the Task.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/TaskOutput" + }, + "title": "Information produced as part of task", + "type": "array" + }, + "owner": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "owner_task", + "description": "Party responsible for managing task execution.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam", + "Patient", + "RelatedPerson" + ], + "title": "Responsible individual" + }, + "partOf": { + "backref": "partOf_task", + "description": "Task that this particular task is part of.", + "element_property": true, + "enum_reference_types": [ + "Task" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Composite task", + "type": "array" + }, + "performer": { + "description": "The entity who performed the requested task.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/TaskPerformer" + }, + "title": "Who or what performed the task", + "type": "array" + }, + "priority": { + "binding_description": "The priority of a task (may affect service level applied to the task).", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/request-priority", + "binding_version": "5.0.0", + "description": "Indicates how quickly the Task should be addressed with respect to other requests.", + "element_property": true, + "enum_values": [ + "routine", + "urgent", + "asap", + "stat" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "routine | urgent | asap | stat", + "type": "string" + }, + "reason": { + "backref": "reason_task", + "description": "A description, code, or reference indicating why this task needs to be performed.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" + }, + "title": "Why task is needed", + "type": "array" + }, + "relevantHistory": { + "backref": "relevantHistory_task", + "description": "Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.", + "element_property": true, + "enum_reference_types": [ + "Provenance" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Key events in history of the Task", + "type": "array" + }, + "requestedPerformer": { + "backref": "requestedPerformer_task", + "binding_description": "The type(s) of task performers allowed.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", + "binding_version": null, + "description": "The kind of participant or specific participant that should perform the task.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam", + "HealthcareService", + "Patient", + "Device", + "RelatedPerson" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" + }, + "title": "Who should perform Task", + "type": "array" + }, + "requestedPeriod": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "Indicates the start and/or end of the period of time when completion of the task is desired to take place.", + "element_property": true, + "title": "When the task should be performed" + }, + "requester": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "requester_task", + "description": "The creator of the task.", + "element_property": true, + "enum_reference_types": [ + "Device", + "Organization", + "Patient", + "Practitioner", + "PractitionerRole", + "RelatedPerson" + ], + "title": "Who is asking for task to be done" + }, + "resourceType": { + "const": "Task", + "default": "Task", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "restriction": { + "$ref": "http://graph-fhir.io/schema/0.0.2/TaskRestriction", + "description": "If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.", + "element_property": true, + "title": "Constraints on fulfillment tasks" + }, + "status": { + "binding_description": "The current status of the task.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-status", + "binding_version": "5.0.0", + "description": "The current status of the task.", + "element_property": true, + "element_required": true, + "enum_values": [ + "draft", + "requested", + "received", + "accepted", + "+" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "draft | requested | received | accepted | +", + "type": "string" + }, + "statusReason": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", + "backref": "task", + "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", + "binding_version": null, + "description": "An explanation as to why this task is held, failed, was refused, etc.", + "element_property": true, + "title": "Reason for current status" + }, + "text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", + "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", + "element_property": true, + "title": "Text summary of the resource, for human interpretation" + } + }, + "title": "Task", + "type": "object" + }, + "ResearchStudyAssociatedParty": { + "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyAssociatedParty", + "additionalProperties": false, + "description": "Sponsors, collaborators, and other parties. [See https://hl7.org/fhir/R5/ResearchStudyAssociatedParty.html]", + "links": [ + { + "href": "Practitioner/{id}", + "rel": "party_Practitioner", + "targetHints": { + "backref": [ + "research_study_associated_party" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/party/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "party_PractitionerRole", + "targetHints": { + "backref": [ + "research_study_associated_party" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/party/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "party_Organization", + "targetHints": { + "backref": [ + "research_study_associated_party" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/party/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_name": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``name``." + }, + "classifier": { + "binding_description": "A characterization or type of the entity.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-party-organization-type", + "binding_version": null, + "description": "A categorization other than role for the associated party.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "nih | fda | government | nonprofit | academic | industry", + "type": "array" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "name": { + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Name of associated party", + "type": "string" + }, + "party": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "research_study_associated_party", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization" + ], + "title": "Individual or organization associated with study (use practitionerRole to specify their organisation)" + }, + "period": { + "description": "Identifies the start date and the end date of the associated party in the role.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period" + }, + "title": "When active in the role", + "type": "array" + }, + "resourceType": { + "const": "ResearchStudyAssociatedParty", + "default": "ResearchStudyAssociatedParty", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "role": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "desc.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-party-role", + "binding_version": null, + "description": "Type of association.", + "element_property": true, + "title": "sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair" + } + }, + "required": [ + "role" + ], + "title": "ResearchStudyAssociatedParty", + "type": "object" + }, + "Range": { + "$id": "http://graph-fhir.io/schema/0.0.2/Range", + "additionalProperties": false, + "description": "Set of values bounded by low and high. A set of ordered Quantities defined by a low and high limit. [See https://hl7.org/fhir/R5/Range.html]", + "links": [], + "properties": { + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "high": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The high limit. The boundary is inclusive.", + "element_property": true, + "title": "High limit" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "low": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The low limit. The boundary is inclusive.", + "element_property": true, + "title": "Low limit" + }, + "resourceType": { + "const": "Range", + "default": "Range", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "title": "Range", + "type": "object" + }, + "PatientContact": { + "$id": "http://graph-fhir.io/schema/0.0.2/PatientContact", + "additionalProperties": false, + "description": "A contact party (e.g. guardian, partner, friend) for the patient. [See https://hl7.org/fhir/R5/PatientContact.html]", + "links": [ + { + "href": "Organization/{id}", + "rel": "organization", + "targetHints": { + "backref": [ + "patient_contact" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/organization/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_gender": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``gender``." + }, + "address": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Address", + "element_property": true, + "title": "Address for the contact person" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "gender": { + "binding_description": "The gender of a person used for administrative purposes.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "binding_version": "5.0.0", + "description": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.", + "element_property": true, + "enum_values": [ + "male", + "female", + "other", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "male | female | other | unknown", + "type": "string" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "name": { + "$ref": "http://graph-fhir.io/schema/0.0.2/HumanName", + "element_property": true, + "title": "A name associated with the contact person" + }, + "organization": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "patient_contact", + "description": "Organization on behalf of which the contact is acting or for which the contact is working.", + "element_property": true, + "enum_reference_types": [ + "Organization" + ], + "title": "Organization that is associated with the contact" + }, + "period": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "element_property": true, + "title": "The period during which this contact person or organization is valid to be contacted relating to this patient" + }, + "relationship": { + "binding_description": "The nature of the relationship between a patient and a contact person for that patient.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/patient-contactrelationship", + "binding_version": null, + "description": "The nature of the relationship between the patient and the contact person.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "The kind of relationship", + "type": "array" + }, + "resourceType": { + "const": "PatientContact", + "default": "PatientContact", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "telecom": { + "description": "A contact detail for the person, e.g. a telephone number or an email address.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ContactPoint" + }, + "title": "A contact detail for the person", + "type": "array" + } + }, + "title": "PatientContact", + "type": "object" + }, + "DataRequirement": { + "$id": "http://graph-fhir.io/schema/0.0.2/DataRequirement", + "additionalProperties": false, + "description": "Describes a required data item. Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data. [See https://hl7.org/fhir/R5/DataRequirement.html]", + "links": [], + "properties": { + "_limit": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``limit``." + }, + "_mustSupport": { + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" + }, + "title": "Extension field for ``mustSupport``.", + "type": "array" + }, + "_profile": { + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" + }, + "title": "Extension field for ``profile``.", + "type": "array" + }, + "_type": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``type``." + }, + "codeFilter": { + "description": "Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementCodeFilter" + }, + "title": "What codes are expected", + "type": "array" + }, + "dateFilter": { + "description": "Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementDateFilter" + }, + "title": "What dates/date ranges are expected", + "type": "array" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "limit": { + "description": "Specifies a maximum number of results that are required (uses the _count search parameter).", + "element_property": true, + "exclusiveMinimum": 0, + "title": "Number of results", + "type": "integer" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "mustSupport": { + "description": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).", + "element_property": true, + "items": { + "pattern": "[ \\r\\n\\t\\S]+", + "type": "string" + }, + "title": "Indicates specific structure elements that are referenced by the knowledge module", + "type": "array" + }, + "profile": { + "description": "The profile of the required data, specified as the uri of the profile definition.", + "element_property": true, + "enum_reference_types": [ + "StructureDefinition" + ], + "items": { + "pattern": "\\S*", + "type": "string" + }, + "title": "The profile of the required data", + "type": "array" + }, + "resourceType": { + "const": "DataRequirement", + "default": "DataRequirement", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "sort": { + "description": "Specifies the order of the results to be returned.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementSort" + }, + "title": "Order of the results", + "type": "array" + }, + "subjectCodeableConcept": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.", + "element_property": true, + "one_of_many": "subject", + "one_of_many_required": false, + "title": "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device" + }, + "subjectReference": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "data_requirement", + "description": "The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.", + "element_property": true, + "enum_reference_types": [ + "Group" + ], + "one_of_many": "subject", + "one_of_many_required": false, + "title": "E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device" + }, + "type": { + "binding_description": "List of FHIR types (resources, data types).", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/fhir-types", + "binding_version": "5.0.0", + "description": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.", + "element_property": true, + "element_required": true, + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "The type of the required data", + "type": "string" + }, + "valueFilter": { + "description": "Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementValueFilter" + }, + "title": "What values are expected", + "type": "array" + } + }, + "title": "DataRequirement", + "type": "object" + }, + "ProcedureFocalDevice": { + "$id": "http://graph-fhir.io/schema/0.0.2/ProcedureFocalDevice", + "additionalProperties": false, + "description": "Manipulated, implanted, or removed device. A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure. [See https://hl7.org/fhir/R5/ProcedureFocalDevice.html]", + "links": [], + "properties": { + "action": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "A kind of change that happened to the device during the procedure.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/device-action", + "binding_version": null, + "description": "The kind of change that happened to the device during the procedure.", + "element_property": true, + "title": "Kind of change to device" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "manipulated": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "procedure_focal_device", + "description": "The device that was manipulated (changed) during the procedure.", + "element_property": true, + "enum_reference_types": [ + "Device" + ], + "title": "Device that was changed" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "resourceType": { + "const": "ProcedureFocalDevice", + "default": "ProcedureFocalDevice", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "required": [ + "manipulated" + ], + "title": "ProcedureFocalDevice", + "type": "object" + }, + "Condition": { + "$id": "http://graph-fhir.io/schema/0.0.2/Condition", + "additionalProperties": false, + "description": "Detailed information about conditions, problems or diagnoses. A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. [See https://hl7.org/fhir/R5/Condition.html]", + "links": [ + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "condition" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" + }, + "templatePointers": { + "id": "/encounter/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "subject_Patient", + "targetHints": { + "backref": [ + "condition" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Patient/{id}", + "rel": "note_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ConditionParticipant/participant", + "href": "Practitioner/{id}", + "rel": "participant_actor_Practitioner", + "targetHints": { + "backref": [ + "condition_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ConditionParticipant/participant", + "href": "PractitionerRole/{id}", + "rel": "participant_actor_PractitionerRole", + "targetHints": { + "backref": [ + "condition_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ConditionParticipant/participant", + "href": "Patient/{id}", + "rel": "participant_actor_Patient", + "targetHints": { + "backref": [ + "condition_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ConditionParticipant/participant", + "href": "Organization/{id}", + "rel": "participant_actor_Organization", + "targetHints": { + "backref": [ + "condition_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ConditionStage/stage", + "href": "DiagnosticReport/{id}", + "rel": "stage_assessment_DiagnosticReport", + "targetHints": { + "backref": [ + "assessment_condition_stage" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReport" + }, + "templatePointers": { + "id": "/stage/-/assessment/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ConditionStage/stage", + "href": "Observation/{id}", + "rel": "stage_assessment_Observation", + "targetHints": { + "backref": [ + "assessment_condition_stage" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + }, + "templatePointers": { + "id": "/stage/-/assessment/-/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_abatementDateTime": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``abatementDateTime``." + }, + "_abatementString": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``abatementString``." + }, + "_implicitRules": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``implicitRules``." }, "_language": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -10875,304 +13920,55 @@ "_availableStartTime": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``availableStartTime``." - }, - "_daysOfWeek": { - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" - }, - "title": "Extension field for ``daysOfWeek``.", - "type": "array" - }, - "allDay": { - "element_property": true, - "title": "Always available? i.e. 24 hour service", - "type": "boolean" - }, - "availableEndTime": { - "element_property": true, - "format": "time", - "title": "Closing time of day (ignored if allDay = true)", - "type": "string" - }, - "availableStartTime": { - "element_property": true, - "format": "time", - "title": "Opening time of day (ignored if allDay = true)", - "type": "string" - }, - "daysOfWeek": { - "binding_description": "The purpose for which an extended contact detail should be used.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/days-of-week", - "binding_version": "5.0.0", - "element_property": true, - "enum_values": [ - "mon", - "tue", - "wed", - "thu", - "fri", - "sat", - "sun" - ], - "items": { - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "type": "string" - }, - "title": "mon | tue | wed | thu | fri | sat | sun", - "type": "array" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" - }, - "type": "array" - }, - "resourceType": { - "const": "AvailabilityAvailableTime", - "default": "AvailabilityAvailableTime", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "title": "AvailabilityAvailableTime", - "type": "object" - }, - "ResearchStudyRecruitment": { - "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyRecruitment", - "additionalProperties": false, - "description": "Target or actual group of participants enrolled in study. [See https://hl7.org/fhir/R5/ResearchStudyRecruitment.html]", - "links": [], - "properties": { - "_actualNumber": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``actualNumber``." - }, - "_targetNumber": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``targetNumber``." - }, - "actualGroup": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "actualGroup_research_study_recruitment", - "element_property": true, - "enum_reference_types": [ - "Group" - ], - "title": "Group of participants who were enrolled in study" - }, - "actualNumber": { - "element_property": true, - "minimum": 0, - "title": "Actual total number of participants enrolled in study", - "type": "integer" - }, - "eligibility": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "eligibility_research_study_recruitment", - "element_property": true, - "enum_reference_types": [ - "Group", - "EvidenceVariable" - ], - "title": "Inclusion and exclusion criteria" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" - }, - "type": "array" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "resourceType": { - "const": "ResearchStudyRecruitment", - "default": "ResearchStudyRecruitment", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "targetNumber": { - "element_property": true, - "minimum": 0, - "title": "Estimated total number of participants to be enrolled", - "type": "integer" - } - }, - "title": "ResearchStudyRecruitment", - "type": "object" - }, - "Location": { - "$id": "http://graph-fhir.io/schema/0.0.2/Location", - "additionalProperties": false, - "description": "Details and position information for a place. Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated. [See https://hl7.org/fhir/R5/Location.html]", - "properties": { - "_alias": { - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" - }, - "title": "Extension field for ``alias``.", - "type": "array" - }, - "_description": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``description``." - }, - "_implicitRules": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." - }, - "_language": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``language``." - }, - "_mode": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``mode``." - }, - "_name": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``name``." - }, - "_status": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``status``." - }, - "address": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Address", - "element_property": true, - "title": "Physical location" - }, - "alias": { - "element_property": true, - "items": { - "pattern": "[ \\r\\n\\t\\S]+", - "type": "string" - }, - "title": "A list of alternate names that the location is known as, or was known as, in the past", - "type": "array" - }, - "characteristic": { - "binding_description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/location-characteristic", - "binding_version": null, - "element_property": true, + }, + "_daysOfWeek": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" }, - "title": "Collection of characteristics (attributes)", + "title": "Extension field for ``daysOfWeek``.", "type": "array" }, - "contact": { - "description": "The contact details of communication devices available at the location. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.", + "allDay": { "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ExtendedContactDetail" - }, - "title": "Official contact details for the location", - "type": "array" + "title": "Always available? i.e. 24 hour service", + "type": "boolean" }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", + "availableEndTime": { "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" - }, - "title": "Contained, inline Resources", - "type": "array" + "format": "time", + "title": "Closing time of day (ignored if allDay = true)", + "type": "string" }, - "description": { - "description": "Description of the Location, which helps in finding or referencing the place.", + "availableStartTime": { "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Additional details about the location that could be displayed as further information to identify the location beyond its name", + "format": "time", + "title": "Opening time of day (ignored if allDay = true)", "type": "string" }, - "endpoint": { - "backref": "endpoint_location", + "daysOfWeek": { + "binding_description": "The purpose for which an extended contact detail should be used.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/days-of-week", + "binding_version": "5.0.0", "element_property": true, - "enum_reference_types": [ - "Endpoint" + "enum_values": [ + "mon", + "tue", + "wed", + "thu", + "fri", + "sat", + "sun" ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "type": "string" }, - "title": "Technical endpoints providing access to services operated for the location", + "title": "mon | tue | wed | thu | fri | sat | sun", "type": "array" }, "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" @@ -11195,193 +13991,185 @@ "element_property": false, "title": "Fhir Comments" }, - "form": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Physical form of the location.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/location-form", - "binding_version": null, - "description": "Physical form of the location, e.g. building, room, vehicle, road, virtual.", - "element_property": true, - "title": "Physical form of the location" - }, - "hoursOfOperation": { - "description": "What days/times during a week is this location usually open, and any exceptions where the location is not available.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Availability" - }, - "title": "What days/times during a week is this location usually open (including exceptions)", - "type": "array" - }, "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", "type": "string" }, - "identifier": { - "element_property": true, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Unique code or number identifying the location to its users", "type": "array" }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "element_property": true, - "pattern": "\\S*", - "title": "A set of rules under which this content was created", + "resourceType": { + "const": "AvailabilityAvailableTime", + "default": "AvailabilityAvailableTime", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" + } + }, + "title": "AvailabilityAvailableTime", + "type": "object" + }, + "ResearchStudyRecruitment": { + "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyRecruitment", + "additionalProperties": false, + "description": "Target or actual group of participants enrolled in study. [See https://hl7.org/fhir/R5/ResearchStudyRecruitment.html]", + "links": [], + "properties": { + "_actualNumber": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``actualNumber``." }, - "language": { - "binding_description": "IETF language tag for a human language", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", - "binding_version": "5.0.0", - "description": "The base language in which the resource is written.", - "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Language of the resource content", - "type": "string" + "_targetNumber": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``targetNumber``." }, - "managingOrganization": { + "actualGroup": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "location", - "description": "The organization responsible for the provisioning and upkeep of the location.", + "backref": "actualGroup_research_study_recruitment", "element_property": true, "enum_reference_types": [ - "Organization" + "Group" ], - "title": "Organization responsible for provisioning and upkeep" + "title": "Group of participants who were enrolled in study" }, - "meta": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", + "actualNumber": { "element_property": true, - "title": "Metadata about the resource" + "minimum": 0, + "title": "Actual total number of participants enrolled in study", + "type": "integer" }, - "mode": { - "binding_description": "Indicates whether a resource instance represents a specific location or a class of locations.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/location-mode", - "binding_version": "5.0.0", - "description": "Indicates whether a resource instance represents a specific location or a class of locations.", + "eligibility": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "eligibility_research_study_recruitment", "element_property": true, - "enum_values": [ - "instance", - "kind" + "enum_reference_types": [ + "Group", + "EvidenceVariable" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "instance | kind", - "type": "string" + "title": "Inclusion and exclusion criteria" }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Extensions that cannot be ignored", + "title": "Additional content defined by implementations", "type": "array" }, - "name": { - "description": "Name of the location as used by humans. Does not need to be unique.", + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, "pattern": "[ \\r\\n\\t\\S]+", - "title": "Name of the location as used by humans", + "title": "Unique id for inter-element referencing", "type": "string" }, - "operationalStatus": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Coding", - "binding_description": "The operational status if the location (where typically a bed/room).", - "binding_strength": "preferred", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0116", - "binding_version": null, - "description": "The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.", - "element_property": true, - "title": "The operational status of the location (typically only for a bed/room)" - }, - "partOf": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "location", - "description": "Another Location of which this Location is physically a part of.", - "element_property": true, - "enum_reference_types": [ - "Location" - ], - "title": "Another Location this one is physically a part of" + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" }, - "position": { - "$ref": "http://graph-fhir.io/schema/0.0.2/LocationPosition", - "description": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).", + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, - "title": "The absolute geographic location" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" }, "resourceType": { - "const": "Location", - "default": "Location", + "const": "ResearchStudyRecruitment", + "default": "ResearchStudyRecruitment", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, - "status": { - "binding_description": "Indicates whether the location is still in use.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/location-status", - "binding_version": "5.0.0", - "description": "The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.", - "element_property": true, - "enum_values": [ - "active", - "suspended", - "inactive" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "active | suspended | inactive", - "type": "string" - }, - "text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", + "targetNumber": { "element_property": true, - "title": "Text summary of the resource, for human interpretation" + "minimum": 0, + "title": "Estimated total number of participants to be enrolled", + "type": "integer" + } + }, + "title": "ResearchStudyRecruitment", + "type": "object" + }, + "SpecimenCollection": { + "$id": "http://graph-fhir.io/schema/0.0.2/SpecimenCollection", + "additionalProperties": false, + "description": "Collection details. Details concerning the specimen collection. [See https://hl7.org/fhir/R5/SpecimenCollection.html]", + "links": [ + { + "href": "Practitioner/{id}", + "rel": "collector_Practitioner", + "targetHints": { + "backref": [ + "specimen_collection" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/collector/reference" + }, + "templateRequired": [ + "id" + ] }, - "type": { - "binding_description": "Indicates the type of function performed at the location.", - "binding_strength": "extensible", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType", - "binding_version": null, - "description": "Indicates the type of function performed at the location.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + { + "href": "PractitionerRole/{id}", + "rel": "collector_PractitionerRole", + "targetHints": { + "backref": [ + "specimen_collection" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Type of function performed", - "type": "array" - }, - "virtualService": { - "description": "Connection details of a virtual service (e.g. shared conference call facility with dedicated number/details).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/VirtualServiceDetail" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, - "title": "Connection details of a virtual service (e.g. conference call)", - "type": "array" - } - }, - "title": "Location", - "type": "object" - }, - "SpecimenCollection": { - "$id": "http://graph-fhir.io/schema/0.0.2/SpecimenCollection", - "additionalProperties": false, - "description": "Collection details. Details concerning the specimen collection. [See https://hl7.org/fhir/R5/SpecimenCollection.html]", - "links": [ + "templatePointers": { + "id": "/collector/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Patient/{id}", "rel": "collector_Patient", @@ -11405,6 +14193,30 @@ "templateRequired": [ "id" ] + }, + { + "href": "Procedure/{id}", + "rel": "procedure", + "targetHints": { + "backref": [ + "specimen_collection" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" + }, + "templatePointers": { + "id": "/procedure/reference" + }, + "templateRequired": [ + "id" + ] } ], "properties": { @@ -11827,52 +14639,260 @@ }, "type": "array" }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "period": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "element_property": true, - "title": "Date range" - }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "period": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "element_property": true, + "title": "Date range" + }, + "resourceType": { + "const": "ResearchStudyProgressStatus", + "default": "ResearchStudyProgressStatus", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "state": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "defn.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-status", + "binding_version": null, + "element_property": true, + "title": "Label for status or state (e.g. recruitment status)" + } + }, + "required": [ + "state" + ], + "title": "ResearchStudyProgressStatus", + "type": "object" + }, + "MedicationIngredient": { + "$id": "http://graph-fhir.io/schema/0.0.2/MedicationIngredient", + "additionalProperties": false, + "description": "Active or inactive ingredient. Identifies a particular constituent of interest in the product. [See https://hl7.org/fhir/R5/MedicationIngredient.html]", + "links": [], + "properties": { + "_isActive": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``isActive``." + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "isActive": { + "description": "Indication of whether this ingredient affects the therapeutic action of the drug.", + "element_property": true, + "title": "Active ingredient indicator", + "type": "boolean" + }, + "item": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", + "backref": "medication_ingredient", + "binding_description": null, + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_version": null, + "description": "The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).", + "element_property": true, + "enum_reference_types": [ + "Substance", + "Medication" + ], + "title": "The ingredient (substance or medication) that the ingredient.strength relates to" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "resourceType": { + "const": "MedicationIngredient", + "default": "MedicationIngredient", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "strengthCodeableConcept": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.", + "element_property": true, + "one_of_many": "strength", + "one_of_many_required": false, + "title": "Quantity of ingredient present" + }, + "strengthQuantity": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.", + "element_property": true, + "one_of_many": "strength", + "one_of_many_required": false, + "title": "Quantity of ingredient present" + }, + "strengthRatio": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Ratio", + "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.", + "element_property": true, + "one_of_many": "strength", + "one_of_many_required": false, + "title": "Quantity of ingredient present" + } + }, + "required": [ + "item" + ], + "title": "MedicationIngredient", + "type": "object" + }, + "Money": { + "$id": "http://graph-fhir.io/schema/0.0.2/Money", + "additionalProperties": false, + "description": "An amount of economic utility in some recognized currency. [See https://hl7.org/fhir/R5/Money.html]", + "links": [], + "properties": { + "_currency": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``currency``." + }, + "_value": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``value``." + }, + "currency": { + "binding_description": "A code indicating the currency, taken from ISO 4217.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/currencies", + "binding_version": "5.0.0", + "element_property": true, + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "ISO 4217 Currency Code", + "type": "string" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "resourceType": { - "const": "ResearchStudyProgressStatus", - "default": "ResearchStudyProgressStatus", + "const": "Money", + "default": "Money", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, - "state": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "defn.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-status", - "binding_version": null, + "value": { "element_property": true, - "title": "Label for status or state (e.g. recruitment status)" + "title": "Numerical value (with implicit precision)", + "type": "number" } }, - "required": [ - "state" - ], - "title": "ResearchStudyProgressStatus", + "title": "Money", "type": "object" }, - "MedicationIngredient": { - "$id": "http://graph-fhir.io/schema/0.0.2/MedicationIngredient", + "MedicationRequestSubstitution": { + "$id": "http://graph-fhir.io/schema/0.0.2/MedicationRequestSubstitution", "additionalProperties": false, - "description": "Active or inactive ingredient. Identifies a particular constituent of interest in the product. [See https://hl7.org/fhir/R5/MedicationIngredient.html]", + "description": "Any restrictions on medication substitution. Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done. [See https://hl7.org/fhir/R5/MedicationRequestSubstitution.html]", "links": [], "properties": { - "_isActive": { + "_allowedBoolean": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``isActive``." + "title": "Extension field for ``allowedBoolean``." + }, + "allowedBoolean": { + "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed.", + "element_property": true, + "one_of_many": "allowed", + "one_of_many_required": true, + "title": "Whether substitution is allowed or not", + "type": "boolean" + }, + "allowedCodeableConcept": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed.", + "element_property": true, + "one_of_many": "allowed", + "one_of_many_required": true, + "title": "Whether substitution is allowed or not" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -11905,27 +14925,6 @@ "title": "Unique id for inter-element referencing", "type": "string" }, - "isActive": { - "description": "Indication of whether this ingredient affects the therapeutic action of the drug.", - "element_property": true, - "title": "Active ingredient indicator", - "type": "boolean" - }, - "item": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference", - "backref": "medication_ingredient", - "binding_description": null, - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", - "binding_version": null, - "description": "The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).", - "element_property": true, - "enum_reference_types": [ - "Substance", - "Medication" - ], - "title": "The ingredient (substance or medication) that the ingredient.strength relates to" - }, "links": { "items": { "$ref": "https://json-schema.org/draft/2020-12/links" @@ -11941,67 +14940,161 @@ "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, + "reason": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "SubstanceAdminSubstitutionReason", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason", + "binding_version": null, + "description": "Indicates the reason for the substitution, or why substitution must or must not be performed.", + "element_property": true, + "title": "Why should (not) substitution be made" + }, "resourceType": { - "const": "MedicationIngredient", - "default": "MedicationIngredient", + "const": "MedicationRequestSubstitution", + "default": "MedicationRequestSubstitution", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" - }, - "strengthCodeableConcept": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.", - "element_property": true, - "one_of_many": "strength", - "one_of_many_required": false, - "title": "Quantity of ingredient present" - }, - "strengthQuantity": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.", - "element_property": true, - "one_of_many": "strength", - "one_of_many_required": false, - "title": "Quantity of ingredient present" - }, - "strengthRatio": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Ratio", - "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet but can also be expressed a quantity when the denominator is assumed to be 1 tablet.", - "element_property": true, - "one_of_many": "strength", - "one_of_many_required": false, - "title": "Quantity of ingredient present" } }, - "required": [ - "item" - ], - "title": "MedicationIngredient", + "title": "MedicationRequestSubstitution", "type": "object" }, - "Money": { - "$id": "http://graph-fhir.io/schema/0.0.2/Money", + "FamilyMemberHistoryProcedure": { + "$id": "http://graph-fhir.io/schema/0.0.2/FamilyMemberHistoryProcedure", "additionalProperties": false, - "description": "An amount of economic utility in some recognized currency. [See https://hl7.org/fhir/R5/Money.html]", - "links": [], + "description": "Procedures that the related person had. The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure. [See https://hl7.org/fhir/R5/FamilyMemberHistoryProcedure.html]", + "links": [ + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Patient/{id}", + "rel": "note_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { - "_currency": { + "_contributedToDeath": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``currency``." + "title": "Extension field for ``contributedToDeath``." }, - "_value": { + "_performedDateTime": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``value``." + "title": "Extension field for ``performedDateTime``." }, - "currency": { - "binding_description": "A code indicating the currency, taken from ISO 4217.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/currencies", - "binding_version": "5.0.0", + "_performedString": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``performedString``." + }, + "code": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "A code to identify a specific procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-code", + "binding_version": null, + "description": "The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system.", + "element_property": true, + "title": "Procedures performed on the related person" + }, + "contributedToDeath": { + "description": "This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.", "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "ISO 4217 Currency Code", - "type": "string" + "title": "Whether the procedure contributed to the cause of death", + "type": "boolean" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -12040,127 +15133,274 @@ }, "type": "array" }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "note": { + "description": "An area where general notes can be placed about this specific procedure.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" + }, + "title": "Extra information about the procedure", + "type": "array" + }, + "outcome": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "The result of the procedure; e.g. death, permanent disability, temporary disability, etc.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.", + "element_property": true, + "title": "What happened following the procedure" + }, + "performedAge": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Age", + "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "performed", + "one_of_many_required": false, + "title": "When the procedure was performed" + }, + "performedDateTime": { + "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "format": "date-time", + "one_of_many": "performed", + "one_of_many_required": false, + "title": "When the procedure was performed", + "type": "string" + }, + "performedPeriod": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "performed", + "one_of_many_required": false, + "title": "When the procedure was performed" + }, + "performedRange": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Range", + "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "performed", + "one_of_many_required": false, + "title": "When the procedure was performed" + }, + "performedString": { + "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "performed", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "When the procedure was performed", + "type": "string" + }, "resourceType": { - "const": "Money", - "default": "Money", + "const": "FamilyMemberHistoryProcedure", + "default": "FamilyMemberHistoryProcedure", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" - }, - "value": { - "element_property": true, - "title": "Numerical value (with implicit precision)", - "type": "number" } }, - "title": "Money", + "required": [ + "code" + ], + "title": "FamilyMemberHistoryProcedure", "type": "object" }, - "MedicationRequestSubstitution": { - "$id": "http://graph-fhir.io/schema/0.0.2/MedicationRequestSubstitution", + "Encounter": { + "$id": "http://graph-fhir.io/schema/0.0.2/Encounter", "additionalProperties": false, - "description": "Any restrictions on medication substitution. Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done. [See https://hl7.org/fhir/R5/MedicationRequestSubstitution.html]", - "links": [], - "properties": { - "_allowedBoolean": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``allowedBoolean``." - }, - "allowedBoolean": { - "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed.", - "element_property": true, - "one_of_many": "allowed", - "one_of_many_required": true, - "title": "Whether substitution is allowed or not", - "type": "boolean" + "description": "An interaction during which services are provided to the 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. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities. [See https://hl7.org/fhir/R5/Encounter.html]", + "links": [ + { + "href": "Encounter/{id}", + "rel": "partOf", + "targetHints": { + "backref": [ + "encounter" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" + }, + "templatePointers": { + "id": "/partOf/reference" + }, + "templateRequired": [ + "id" + ] }, - "allowedCodeableConcept": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed.", - "element_property": true, - "one_of_many": "allowed", - "one_of_many_required": true, - "title": "Whether substitution is allowed or not" + { + "href": "Organization/{id}", + "rel": "serviceProvider", + "targetHints": { + "backref": [ + "encounter" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/serviceProvider/reference" + }, + "templateRequired": [ + "id" + ] }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "Patient/{id}", + "rel": "subject_Patient", + "targetHints": { + "backref": [ + "encounter" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Additional content defined by implementations", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" + { + "$comment": "From EncounterAdmission/admission", + "href": "Organization/{id}", + "rel": "admission_destination_Organization", + "targetHints": { + "backref": [ + "destination_encounter_admission" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/admission/destination/reference" + }, + "templateRequired": [ + "id" + ] }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" + { + "$comment": "From EncounterAdmission/admission", + "href": "Organization/{id}", + "rel": "admission_origin_Organization", + "targetHints": { + "backref": [ + "origin_encounter_admission" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/admission/origin/reference" + }, + "templateRequired": [ + "id" + ] }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + { + "$comment": "From EncounterParticipant/participant", + "href": "Patient/{id}", + "rel": "participant_actor_Patient", + "targetHints": { + "backref": [ + "encounter_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" }, - "type": "array" + "templateRequired": [ + "id" + ] }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "$comment": "From EncounterParticipant/participant", + "href": "Practitioner/{id}", + "rel": "participant_actor_Practitioner", + "targetHints": { + "backref": [ + "encounter_participant" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "reason": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "SubstanceAdminSubstitutionReason", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-SubstanceAdminSubstitutionReason", - "binding_version": null, - "description": "Indicates the reason for the substitution, or why substitution must or must not be performed.", - "element_property": true, - "title": "Why should (not) substitution be made" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/participant/-/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "resourceType": { - "const": "MedicationRequestSubstitution", - "default": "MedicationRequestSubstitution", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "title": "MedicationRequestSubstitution", - "type": "object" - }, - "FamilyMemberHistoryProcedure": { - "$id": "http://graph-fhir.io/schema/0.0.2/FamilyMemberHistoryProcedure", - "additionalProperties": false, - "description": "Procedures that the related person had. The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure. [See https://hl7.org/fhir/R5/FamilyMemberHistoryProcedure.html]", - "links": [ { - "$comment": "From Annotation/note", - "href": "Patient/{id}", - "rel": "note_authorReference_Patient", + "$comment": "From EncounterParticipant/participant", + "href": "PractitionerRole/{id}", + "rel": "participant_actor_PractitionerRole", "targetHints": { "backref": [ - "annotation" + "encounter_participant" ], "direction": [ "outbound" @@ -12170,10 +15410,10 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/note/-/authorReference/reference" + "id": "/participant/-/actor/reference" }, "templateRequired": [ "id" @@ -12181,36 +15421,147 @@ } ], "properties": { - "_contributedToDeath": { + "_implicitRules": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``contributedToDeath``." + "title": "Extension field for ``implicitRules``." }, - "_performedDateTime": { + "_language": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``performedDateTime``." + "title": "Extension field for ``language``." }, - "_performedString": { + "_plannedEndDate": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``performedString``." + "title": "Extension field for ``plannedEndDate``." }, - "code": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "A code to identify a specific procedure.", + "_plannedStartDate": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``plannedStartDate``." + }, + "_status": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``status``." + }, + "account": { + "backref": "account_encounter", + "element_property": true, + "enum_reference_types": [ + "Account" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "The set of accounts that may be used for billing for this Encounter", + "type": "array" + }, + "actualPeriod": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "element_property": true, + "title": "The actual start and end time of the encounter" + }, + "admission": { + "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterAdmission", + "description": "Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.", + "element_property": true, + "title": "Details about the admission to a healthcare service" + }, + "appointment": { + "backref": "appointment_encounter", + "element_property": true, + "enum_reference_types": [ + "Appointment" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "The appointment that scheduled this encounter", + "type": "array" + }, + "basedOn": { + "backref": "basedOn_encounter", + "description": "The request this encounter satisfies (e.g. incoming referral or procedure request).", + "element_property": true, + "enum_reference_types": [ + "CarePlan", + "DeviceRequest", + "MedicationRequest", + "ServiceRequest" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "The request that initiated this encounter", + "type": "array" + }, + "careTeam": { + "backref": "careTeam_encounter", + "description": "The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.", + "element_property": true, + "enum_reference_types": [ + "CareTeam" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "The group(s) that are allocated to participate in this encounter", + "type": "array" + }, + "class": { + "binding_description": "Classification of the encounter.", + "binding_strength": "preferred", + "binding_uri": "http://terminology.hl7.org/ValueSet/encounter-class", + "binding_version": null, + "description": "Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "Classification of patient encounter context - e.g. Inpatient, outpatient", + "type": "array" + }, + "contained": { + "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + }, + "title": "Contained, inline Resources", + "type": "array" + }, + "diagnosis": { + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterDiagnosis" + }, + "title": "The list of diagnosis relevant to this encounter", + "type": "array" + }, + "dietPreference": { + "binding_description": "Medical, cultural or ethical food preferences to help with catering requirements.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-diet", "binding_version": null, - "description": "The actual procedure specified. Could be a coded procedure or a less specific string depending on how much is known about the procedure and the capabilities of the creating system.", "element_property": true, - "title": "Procedures performed on the related person" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "Diet preferences reported by the patient", + "type": "array" }, - "contributedToDeath": { - "description": "This procedure contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.", + "episodeOfCare": { + "backref": "episodeOfCare_encounter", + "description": "Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).", "element_property": true, - "title": "Whether the procedure contributed to the cause of death", - "type": "boolean" + "enum_reference_types": [ + "EpisodeOfCare" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Episode(s) of care that this encounter should be recorded against", + "type": "array" }, "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" @@ -12234,248 +15585,368 @@ "title": "Fhir Comments" }, "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + }, + "title": "Identifier(s) by which this encounter is known", + "type": "array" + }, + "implicitRules": { + "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", + "element_property": true, + "pattern": "\\S*", + "title": "A set of rules under which this content was created", + "type": "string" + }, + "language": { + "binding_description": "IETF language tag for a human language", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "The base language in which the resource is written.", + "element_property": true, + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "Language of the resource content", "type": "string" }, + "length": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Duration", + "description": "Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.", + "element_property": true, + "title": "Actual quantity of time the encounter lasted (less time absent)" + }, "links": { "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "location": { + "description": "List of locations where the patient has been during this encounter.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterLocation" }, + "title": "List of locations where the patient has been", "type": "array" }, + "meta": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", + "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", + "element_property": true, + "title": "Metadata about the resource" + }, "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Extensions that cannot be ignored even if unrecognized", + "title": "Extensions that cannot be ignored", "type": "array" }, - "note": { - "description": "An area where general notes can be placed about this specific procedure.", + "partOf": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "encounter", + "description": "Another Encounter of which this encounter is a part of (administratively or in time).", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "Another Encounter this encounter is part of" + }, + "participant": { + "description": "The list of people responsible for providing the service.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" + "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterParticipant" }, - "title": "Extra information about the procedure", + "title": "List of participants involved in the encounter", "type": "array" }, - "outcome": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "The result of the procedure; e.g. death, permanent disability, temporary disability, etc.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", - "binding_version": null, - "description": "Indicates what happened following the procedure. If the procedure resulted in death, deceased date is captured on the relation.", - "element_property": true, - "title": "What happened following the procedure" - }, - "performedAge": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Age", - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", - "element_property": true, - "one_of_many": "performed", - "one_of_many_required": false, - "title": "When the procedure was performed" - }, - "performedDateTime": { - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "plannedEndDate": { "element_property": true, "format": "date-time", - "one_of_many": "performed", - "one_of_many_required": false, - "title": "When the procedure was performed", + "title": "The planned end date/time (or discharge date) of the encounter", "type": "string" }, - "performedPeriod": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "plannedStartDate": { "element_property": true, - "one_of_many": "performed", - "one_of_many_required": false, - "title": "When the procedure was performed" + "format": "date-time", + "title": "The planned start date/time (or admission date) of the encounter", + "type": "string" }, - "performedRange": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Range", - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "priority": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Indicates the urgency of the encounter.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActPriority", + "binding_version": null, "element_property": true, - "one_of_many": "performed", - "one_of_many_required": false, - "title": "When the procedure was performed" + "title": "Indicates the urgency of the encounter" }, - "performedString": { - "description": "Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "reason": { "element_property": true, - "one_of_many": "performed", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "When the procedure was performed", - "type": "string" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterReason" + }, + "title": "The list of medical reasons that are expected to be addressed during the episode of care", + "type": "array" }, "resourceType": { - "const": "FamilyMemberHistoryProcedure", - "default": "FamilyMemberHistoryProcedure", + "const": "Encounter", + "default": "Encounter", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" - } - }, - "required": [ - "code" - ], - "title": "FamilyMemberHistoryProcedure", - "type": "object" - }, - "Encounter": { - "$id": "http://graph-fhir.io/schema/0.0.2/Encounter", - "additionalProperties": false, - "description": "An interaction during which services are provided to the 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. Encounter is primarily used to record information about the actual activities that occurred, where Appointment is used to record planned activities. [See https://hl7.org/fhir/R5/Encounter.html]", - "properties": { - "_implicitRules": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." - }, - "_language": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``language``." - }, - "_plannedEndDate": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``plannedEndDate``." - }, - "_plannedStartDate": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``plannedStartDate``." }, - "_status": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``status``." + "serviceProvider": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "encounter", + "description": "The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the colonoscopy example on the Encounter examples tab.", + "element_property": true, + "enum_reference_types": [ + "Organization" + ], + "title": "The organization (facility) responsible for this encounter" }, - "account": { - "backref": "account_encounter", + "serviceType": { + "backref": "serviceType_encounter", + "binding_description": "Broad categorization of the service that is to be provided.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/service-type", + "binding_version": null, + "description": "Broad categorization of the service that is to be provided (e.g. cardiology).", "element_property": true, "enum_reference_types": [ - "Account" + "HealthcareService" ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" }, - "title": "The set of accounts that may be used for billing for this Encounter", + "title": "Specific type of service", "type": "array" }, - "actualPeriod": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "element_property": true, - "title": "The actual start and end time of the encounter" - }, - "admission": { - "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterAdmission", - "description": "Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.", - "element_property": true, - "title": "Details about the admission to a healthcare service" - }, - "appointment": { - "backref": "appointment_encounter", + "specialArrangement": { + "binding_description": "Special arrangements.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-special-arrangements", + "binding_version": null, + "description": "Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.", "element_property": true, - "enum_reference_types": [ - "Appointment" - ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" }, - "title": "The appointment that scheduled this encounter", + "title": "Wheelchair, translator, stretcher, etc", "type": "array" }, - "basedOn": { - "backref": "basedOn_encounter", - "description": "The request this encounter satisfies (e.g. incoming referral or procedure request).", + "specialCourtesy": { + "binding_description": "Special courtesies.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-special-courtesy", + "binding_version": null, + "description": "Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).", "element_property": true, - "enum_reference_types": [ - "CarePlan", - "DeviceRequest", - "MedicationRequest", - "ServiceRequest" - ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" }, - "title": "The request that initiated this encounter", + "title": "Special courtesies (VIP, board member)", "type": "array" }, - "careTeam": { - "backref": "careTeam_encounter", - "description": "The group(s) of individuals, organizations that are allocated to participate in this encounter. The participants backbone will record the actuals of when these individuals participated during the encounter.", + "status": { + "binding_description": "Current state of the encounter.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-status", + "binding_version": "5.0.0", + "description": "The current state of the encounter (not the state of the patient within the encounter - that is subjectState).", + "element_property": true, + "element_required": true, + "enum_values": [ + "planned", + "in-progress", + "on-hold", + "discharged", + "completed", + "cancelled", + "discontinued", + "entered-in-error", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown", + "type": "string" + }, + "subject": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "encounter", + "description": "The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.", "element_property": true, "enum_reference_types": [ - "CareTeam" + "Patient", + "Group" ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" - }, - "title": "The group(s) that are allocated to participate in this encounter", - "type": "array" + "title": "The patient or group related to this encounter" }, - "class": { - "binding_description": "Classification of the encounter.", - "binding_strength": "preferred", - "binding_uri": "http://terminology.hl7.org/ValueSet/encounter-class", + "subjectStatus": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Current status of the subject within the encounter.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-subject-status", + "binding_version": null, + "description": "The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.", + "element_property": true, + "title": "The current status of the subject in relation to the Encounter" + }, + "text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", + "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", + "element_property": true, + "title": "Text summary of the resource, for human interpretation" + }, + "type": { + "binding_description": "A specific code indicating type of service provided", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-type", "binding_version": null, - "description": "Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.", + "description": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" }, - "title": "Classification of patient encounter context - e.g. Inpatient, outpatient", + "title": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)", "type": "array" }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", + "virtualService": { "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + "$ref": "http://graph-fhir.io/schema/0.0.2/VirtualServiceDetail" }, - "title": "Contained, inline Resources", + "title": "Connection details of a virtual service (e.g. conference call)", "type": "array" + } + }, + "title": "Encounter", + "type": "object" + }, + "TaskRestriction": { + "$id": "http://graph-fhir.io/schema/0.0.2/TaskRestriction", + "additionalProperties": false, + "description": "Constraints on fulfillment tasks. If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. [See https://hl7.org/fhir/R5/TaskRestriction.html]", + "links": [ + { + "href": "Patient/{id}", + "rel": "recipient_Patient", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "diagnosis": { - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterDiagnosis" + { + "href": "Practitioner/{id}", + "rel": "recipient_Practitioner", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "The list of diagnosis relevant to this encounter", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "dietPreference": { - "binding_description": "Medical, cultural or ethical food preferences to help with catering requirements.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-diet", - "binding_version": null, - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + { + "href": "PractitionerRole/{id}", + "rel": "recipient_PractitionerRole", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Diet preferences reported by the patient", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "episodeOfCare": { - "backref": "episodeOfCare_encounter", - "description": "Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).", - "element_property": true, - "enum_reference_types": [ - "EpisodeOfCare" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + { + "href": "Organization/{id}", + "rel": "recipient_Organization", + "targetHints": { + "backref": [ + "recipient_task_restriction" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Episode(s) of care that this encounter should be recorded against", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/recipient/-/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "_repetitions": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``repetitions``." }, "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" @@ -12499,277 +15970,327 @@ "title": "Fhir Comments" }, "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", "type": "string" }, - "identifier": { - "element_property": true, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Identifier(s) by which this encounter is known", "type": "array" }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", - "element_property": true, - "pattern": "\\S*", - "title": "A set of rules under which this content was created", - "type": "string" - }, - "language": { - "binding_description": "IETF language tag for a human language", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", - "binding_version": "5.0.0", - "description": "The base language in which the resource is written.", + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Language of the resource content", - "type": "string" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" }, - "length": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Duration", - "description": "Actual quantity of time the encounter lasted. This excludes the time during leaves of absence. When missing it is the time in between the start and end values.", + "period": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "The time-period for which fulfillment is sought. This must fall within the overall time period authorized in the referenced request. E.g. ServiceRequest.occurance[x].", "element_property": true, - "title": "Actual quantity of time the encounter lasted (less time absent)" + "title": "When fulfillment is sought" }, - "location": { - "description": "List of locations where the patient has been during this encounter.", + "recipient": { + "backref": "recipient_task_restriction", + "description": "For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for.", "element_property": true, + "enum_reference_types": [ + "Patient", + "Practitioner", + "PractitionerRole", + "RelatedPerson", + "Group", + "Organization" + ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterLocation" + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "List of locations where the patient has been", + "title": "For whom is fulfillment sought?", "type": "array" }, - "meta": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", + "repetitions": { + "description": "Indicates the number of times the requested action should occur.", "element_property": true, - "title": "Metadata about the resource" + "exclusiveMinimum": 0, + "title": "How many times to repeat", + "type": "integer" }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "resourceType": { + "const": "TaskRestriction", + "default": "TaskRestriction", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "title": "TaskRestriction", + "type": "object" + }, + "RatioRange": { + "$id": "http://graph-fhir.io/schema/0.0.2/RatioRange", + "additionalProperties": false, + "description": "Range of ratio values. A range of ratios expressed as a low and high numerator and a denominator. [See https://hl7.org/fhir/R5/RatioRange.html]", + "links": [], + "properties": { + "denominator": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The value of the denominator.", + "element_property": true, + "title": "Denominator value" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Extensions that cannot be ignored", + "title": "Additional content defined by implementations", "type": "array" }, - "partOf": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "encounter", - "description": "Another Encounter of which this encounter is a part of (administratively or in time).", - "element_property": true, - "enum_reference_types": [ - "Encounter" + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], - "title": "Another Encounter this encounter is part of" + "element_property": false, + "title": "Fhir Comments" }, - "participant": { - "description": "The list of people responsible for providing the service.", + "highNumerator": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The value of the high limit numerator.", + "element_property": true, + "title": "High Numerator limit" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterParticipant" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "List of participants involved in the encounter", "type": "array" }, - "plannedEndDate": { + "lowNumerator": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The value of the low limit numerator.", "element_property": true, - "format": "date-time", - "title": "The planned end date/time (or discharge date) of the encounter", - "type": "string" + "title": "Low Numerator limit" }, - "plannedStartDate": { - "element_property": true, - "format": "date-time", - "title": "The planned start date/time (or admission date) of the encounter", + "resourceType": { + "const": "RatioRange", + "default": "RatioRange", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" - }, - "priority": { + } + }, + "title": "RatioRange", + "type": "object" + }, + "MedicationStatementAdherence": { + "$id": "http://graph-fhir.io/schema/0.0.2/MedicationStatementAdherence", + "additionalProperties": false, + "description": "Indicates whether the medication is or is not being consumed or administered. [See https://hl7.org/fhir/R5/MedicationStatementAdherence.html]", + "links": [], + "properties": { + "code": { "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Indicates the urgency of the encounter.", + "binding_description": null, "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActPriority", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-statement-adherence", "binding_version": null, + "description": "Type of the adherence for the medication.", "element_property": true, - "title": "Indicates the urgency of the encounter" + "title": "Type of adherence" }, - "reason": { + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/EncounterReason" + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "The list of medical reasons that are expected to be addressed during the episode of care", + "title": "Additional content defined by implementations", "type": "array" }, - "resourceType": { - "const": "Encounter", - "default": "Encounter", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "serviceProvider": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "encounter", - "description": "The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the colonoscopy example on the Encounter examples tab.", - "element_property": true, - "enum_reference_types": [ - "Organization" + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], - "title": "The organization (facility) responsible for this encounter" + "element_property": false, + "title": "Fhir Comments" }, - "serviceType": { - "backref": "serviceType_encounter", - "binding_description": "Broad categorization of the service that is to be provided.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/service-type", - "binding_version": null, - "description": "Broad categorization of the service that is to be provided (e.g. cardiology).", + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, - "enum_reference_types": [ - "HealthcareService" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" - }, - "title": "Specific type of service", - "type": "array" + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" }, - "specialArrangement": { - "binding_description": "Special arrangements.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-special-arrangements", - "binding_version": null, - "description": "Any special requests that have been made for this encounter, such as the provision of specific equipment or other things.", - "element_property": true, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Wheelchair, translator, stretcher, etc", "type": "array" }, - "specialCourtesy": { - "binding_description": "Special courtesies.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-special-courtesy", - "binding_version": null, - "description": "Special courtesies that may be provided to the patient during the encounter (VIP, board member, professional courtesy).", + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Special courtesies (VIP, board member)", + "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, - "status": { - "binding_description": "Current state of the encounter.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-status", - "binding_version": "5.0.0", - "description": "The current state of the encounter (not the state of the patient within the encounter - that is subjectState).", - "element_property": true, - "element_required": true, - "enum_values": [ - "planned", - "in-progress", - "on-hold", - "discharged", - "completed", - "cancelled", - "discontinued", - "entered-in-error", - "unknown" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown", - "type": "string" - }, - "subject": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "encounter", - "description": "The patient or group related to this encounter. In some use-cases the patient MAY not be present, such as a case meeting about a patient between several practitioners or a careteam.", - "element_property": true, - "enum_reference_types": [ - "Patient", - "Group" - ], - "title": "The patient or group related to this encounter" - }, - "subjectStatus": { + "reason": { "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Current status of the subject within the encounter.", + "binding_description": null, "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-subject-status", + "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-status-codes", "binding_version": null, - "description": "The subjectStatus value can be used to track the patient's status within the encounter. It details whether the patient has arrived or departed, has been triaged or is currently in a waiting status.", - "element_property": true, - "title": "The current status of the subject in relation to the Encounter" - }, - "text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", + "description": "Captures the reason for the current use or adherence of a medication.", "element_property": true, - "title": "Text summary of the resource, for human interpretation" + "title": "Details of the reason for the current use of the medication" }, - "type": { - "binding_description": "A specific code indicating type of service provided", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/encounter-type", - "binding_version": null, - "description": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "resourceType": { + "const": "MedicationStatementAdherence", + "default": "MedicationStatementAdherence", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "required": [ + "code" + ], + "title": "MedicationStatementAdherence", + "type": "object" + }, + "FamilyMemberHistoryCondition": { + "$id": "http://graph-fhir.io/schema/0.0.2/FamilyMemberHistoryCondition", + "additionalProperties": false, + "description": "Condition that the related person had. The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. [See https://hl7.org/fhir/R5/FamilyMemberHistoryCondition.html]", + "links": [ + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "virtualService": { - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/VirtualServiceDetail" + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, - "title": "Connection details of a virtual service (e.g. conference call)", - "type": "array" - } - }, - "title": "Encounter", - "type": "object" - }, - "TaskRestriction": { - "$id": "http://graph-fhir.io/schema/0.0.2/TaskRestriction", - "additionalProperties": false, - "description": "Constraints on fulfillment tasks. If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. [See https://hl7.org/fhir/R5/TaskRestriction.html]", - "links": [ + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, { + "$comment": "From Annotation/note", "href": "Patient/{id}", - "rel": "recipient_Patient", + "rel": "note_authorReference_Patient", "targetHints": { "backref": [ - "recipient_task_restriction" + "annotation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/recipient/-/reference" + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" @@ -12777,9 +16298,29 @@ } ], "properties": { - "_repetitions": { + "_contributedToDeath": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``repetitions``." + "title": "Extension field for ``contributedToDeath``." + }, + "_onsetString": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``onsetString``." + }, + "code": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Identification of the Condition or diagnosis.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.", + "element_property": true, + "title": "Condition suffered by relation" + }, + "contributedToDeath": { + "description": "This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.", + "element_property": true, + "title": "Whether the condition contributed to the cause of death", + "type": "boolean" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -12827,59 +16368,89 @@ "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, - "period": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "The time-period for which fulfillment is sought. This must fall within the overall time period authorized in the referenced request. E.g. ServiceRequest.occurance[x].", - "element_property": true, - "title": "When fulfillment is sought" - }, - "recipient": { - "backref": "recipient_task_restriction", - "description": "For requests that are targeted to more than one potential recipient/target, to identify who is fulfillment is sought for.", + "note": { + "description": "An area where general notes can be placed about this specific condition.", "element_property": true, - "enum_reference_types": [ - "Patient", - "Practitioner", - "PractitionerRole", - "RelatedPerson", - "Group", - "Organization" - ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" }, - "title": "For whom is fulfillment sought?", + "title": "Extra information about condition", "type": "array" }, - "repetitions": { - "description": "Indicates the number of times the requested action should occur.", + "onsetAge": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Age", + "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", "element_property": true, - "exclusiveMinimum": 0, - "title": "How many times to repeat", - "type": "integer" + "one_of_many": "onset", + "one_of_many_required": false, + "title": "When condition first manifested" + }, + "onsetPeriod": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", + "element_property": true, + "one_of_many": "onset", + "one_of_many_required": false, + "title": "When condition first manifested" + }, + "onsetRange": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Range", + "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", + "element_property": true, + "one_of_many": "onset", + "one_of_many_required": false, + "title": "When condition first manifested" + }, + "onsetString": { + "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", + "element_property": true, + "one_of_many": "onset", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "When condition first manifested", + "type": "string" + }, + "outcome": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-outcome", + "binding_version": null, + "description": "Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.", + "element_property": true, + "title": "deceased | permanent disability | etc" }, "resourceType": { - "const": "TaskRestriction", - "default": "TaskRestriction", + "const": "FamilyMemberHistoryCondition", + "default": "FamilyMemberHistoryCondition", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" } }, - "title": "TaskRestriction", + "required": [ + "code" + ], + "title": "FamilyMemberHistoryCondition", "type": "object" }, - "RatioRange": { - "$id": "http://graph-fhir.io/schema/0.0.2/RatioRange", + "ImagingStudySeriesInstance": { + "$id": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeriesInstance", "additionalProperties": false, - "description": "Range of ratio values. A range of ratios expressed as a low and high numerator and a denominator. [See https://hl7.org/fhir/R5/RatioRange.html]", + "description": "A single SOP instance from the series. A single SOP instance within the series, e.g. an image, or presentation state. [See https://hl7.org/fhir/R5/ImagingStudySeriesInstance.html]", "links": [], "properties": { - "denominator": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The value of the denominator.", - "element_property": true, - "title": "Denominator value" + "_number": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``number``." + }, + "_title": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``title``." + }, + "_uid": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``uid``." }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -12905,12 +16476,6 @@ "element_property": false, "title": "Fhir Comments" }, - "highNumerator": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The value of the high limit numerator.", - "element_property": true, - "title": "High Numerator limit" - }, "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, @@ -12924,47 +16489,76 @@ }, "type": "array" }, - "lowNumerator": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The value of the low limit numerator.", + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, - "title": "Low Numerator limit" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "number": { + "description": "The number of instance in the series.", + "element_property": true, + "minimum": 0, + "title": "The number of this instance in the series", + "type": "integer" }, "resourceType": { - "const": "RatioRange", - "default": "RatioRange", + "const": "ImagingStudySeriesInstance", + "default": "ImagingStudySeriesInstance", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" + }, + "sopClass": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Coding", + "binding_description": "The sopClass for the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1", + "binding_version": null, + "description": "DICOM instance type.", + "element_property": true, + "title": "DICOM class type" + }, + "title": { + "description": "The description of the instance.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Description of instance", + "type": "string" + }, + "uid": { + "description": "The DICOM SOP Instance UID for this image or other DICOM content.", + "element_property": true, + "element_required": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "DICOM SOP Instance UID", + "type": "string" } }, - "title": "RatioRange", + "required": [ + "sopClass" + ], + "title": "ImagingStudySeriesInstance", "type": "object" }, - "MedicationStatementAdherence": { - "$id": "http://graph-fhir.io/schema/0.0.2/MedicationStatementAdherence", + "Resource": { + "$id": "http://graph-fhir.io/schema/0.0.2/Resource", "additionalProperties": false, - "description": "Indicates whether the medication is or is not being consumed or administered. [See https://hl7.org/fhir/R5/MedicationStatementAdherence.html]", + "description": "Base Resource. This is the base resource type for everything. [See https://hl7.org/fhir/R5/Resource.html]", "links": [], "properties": { - "code": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": null, - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-statement-adherence", - "binding_version": null, - "description": "Type of the adherence for the medication.", - "element_property": true, - "title": "Type of adherence" + "_implicitRules": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``implicitRules``." }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" + "_language": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``language``." }, "fhir_comments": { "anyOf": [ @@ -12982,10 +16576,30 @@ "title": "Fhir Comments" }, "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "implicitRules": { + "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", + "element_property": true, + "pattern": "\\S*", + "title": "A set of rules under which this content was created", + "type": "string" + }, + "language": { + "binding_description": "IETF language tag for a human language", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "The base language in which the resource is written.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "Language of the resource content", "type": "string" }, "links": { @@ -12994,51 +16608,34 @@ }, "type": "array" }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "reason": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": null, - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-status-codes", - "binding_version": null, - "description": "Captures the reason for the current use or adherence of a medication.", + "meta": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", + "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "element_property": true, - "title": "Details of the reason for the current use of the medication" + "title": "Metadata about the resource" }, "resourceType": { - "const": "MedicationStatementAdherence", - "default": "MedicationStatementAdherence", + "const": "Resource", + "default": "Resource", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" } }, - "required": [ - "code" - ], - "title": "MedicationStatementAdherence", + "title": "Resource", "type": "object" }, - "FamilyMemberHistoryCondition": { - "$id": "http://graph-fhir.io/schema/0.0.2/FamilyMemberHistoryCondition", + "PractitionerRole": { + "$id": "http://graph-fhir.io/schema/0.0.2/PractitionerRole", "additionalProperties": false, - "description": "Condition that the related person had. The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. [See https://hl7.org/fhir/R5/FamilyMemberHistoryCondition.html]", + "description": "Roles/organizations the practitioner is associated with. A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. [See https://hl7.org/fhir/R5/PractitionerRole.html]", "links": [ { - "$comment": "From Annotation/note", - "href": "Patient/{id}", - "rel": "note_authorReference_Patient", + "href": "Organization/{id}", + "rel": "organization", "targetHints": { "backref": [ - "annotation" + "practitioner_role" ], "direction": [ "outbound" @@ -13048,10 +16645,59 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { - "id": "/note/-/authorReference/reference" + "id": "/organization/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Practitioner/{id}", + "rel": "practitioner", + "targetHints": { + "backref": [ + "practitioner_role" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/practitioner/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ExtendedContactDetail/contact", + "href": "Organization/{id}", + "rel": "contact_organization", + "targetHints": { + "backref": [ + "extended_contact_detail" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/contact/-/organization/reference" }, "templateRequired": [ "id" @@ -13059,155 +16705,110 @@ } ], "properties": { - "_contributedToDeath": { + "_active": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``contributedToDeath``." + "title": "Extension field for ``active``." }, - "_onsetString": { + "_implicitRules": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``onsetString``." + "title": "Extension field for ``implicitRules``." }, - "code": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Identification of the Condition or diagnosis.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", - "binding_version": null, - "description": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.", - "element_property": true, - "title": "Condition suffered by relation" + "_language": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``language``." }, - "contributedToDeath": { - "description": "This condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.", + "active": { + "description": " Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed.", "element_property": true, - "title": "Whether the condition contributed to the cause of death", + "title": "Whether this practitioner role record is in active use", "type": "boolean" }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "availability": { + "description": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "$ref": "http://graph-fhir.io/schema/0.0.2/Availability" }, - "title": "Additional content defined by implementations", + "title": "Times the Practitioner is available at this location and/or healthcare service (including exceptions)", "type": "array" }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "characteristic": { + "binding_description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/service-mode", + "binding_version": null, "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "links": { "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" }, + "title": "Collection of characteristics (attributes)", "type": "array" }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "code": { + "binding_description": "The role a person plays representing an organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/practitioner-role", + "binding_version": null, + "description": "Roles which this practitioner is authorized to perform for the organization.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" }, - "title": "Extensions that cannot be ignored even if unrecognized", + "title": "Roles which this practitioner may perform", "type": "array" }, - "note": { - "description": "An area where general notes can be placed about this specific condition.", + "communication": { + "binding_description": "IETF language tag for a human language", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" }, - "title": "Extra information about condition", + "title": "A language the practitioner (in this role) can use in patient communication", "type": "array" }, - "onsetAge": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Age", - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", - "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "title": "When condition first manifested" - }, - "onsetPeriod": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", - "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "title": "When condition first manifested" - }, - "onsetRange": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Range", - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", - "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "title": "When condition first manifested" - }, - "onsetString": { - "description": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.", + "contact": { + "description": "The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.", "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "When condition first manifested", - "type": "string" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ExtendedContactDetail" + }, + "title": "Official contact details relating to this PractitionerRole", + "type": "array" }, - "outcome": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-outcome", - "binding_version": null, - "description": "Indicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.", + "contained": { + "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", "element_property": true, - "title": "deceased | permanent disability | etc" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + }, + "title": "Contained, inline Resources", + "type": "array" }, - "resourceType": { - "const": "FamilyMemberHistoryCondition", - "default": "FamilyMemberHistoryCondition", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "required": [ - "code" - ], - "title": "FamilyMemberHistoryCondition", - "type": "object" - }, - "Resource": { - "$id": "http://graph-fhir.io/schema/0.0.2/Resource", - "additionalProperties": false, - "description": "Base Resource. This is the base resource type for everything. [See https://hl7.org/fhir/R5/Resource.html]", - "links": [], - "properties": { - "_implicitRules": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." + "endpoint": { + "backref": "endpoint_practitioner_role", + "description": " Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.", + "element_property": true, + "enum_reference_types": [ + "Endpoint" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Endpoints for interacting with the practitioner in this role", + "type": "array" }, - "_language": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``language``." + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" }, "fhir_comments": { "anyOf": [ @@ -13224,6 +16825,19 @@ "element_property": false, "title": "Fhir Comments" }, + "healthcareService": { + "backref": "healthcareService_practitioner_role", + "description": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", + "element_property": true, + "enum_reference_types": [ + "HealthcareService" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Healthcare services provided for this role's Organization/Location(s)", + "type": "array" + }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, @@ -13233,6 +16847,15 @@ "title": "Logical id of this artifact", "type": "string" }, + "identifier": { + "description": "Business Identifiers that are specific to a role/location.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + }, + "title": "Identifiers for a role/location", + "type": "array" + }, "implicitRules": { "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "element_property": true, @@ -13257,126 +16880,220 @@ }, "type": "array" }, + "location": { + "backref": "location_practitioner_role", + "description": "The location(s) at which this practitioner provides care.", + "element_property": true, + "enum_reference_types": [ + "Location" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Location(s) where the practitioner provides care", + "type": "array" + }, "meta": { "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "element_property": true, "title": "Metadata about the resource" }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored", + "type": "array" + }, + "organization": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "practitioner_role", + "description": "The organization where the Practitioner performs the roles associated.", + "element_property": true, + "enum_reference_types": [ + "Organization" + ], + "title": "Organization where the roles are available" + }, + "period": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", + "element_property": true, + "title": "The period during which the practitioner is authorized to perform in these role(s)" + }, + "practitioner": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "practitioner_role", + "description": "Practitioner that is able to provide the defined services for the organization.", + "element_property": true, + "enum_reference_types": [ + "Practitioner" + ], + "title": "Practitioner that provides services for the organization" + }, "resourceType": { - "const": "Resource", - "default": "Resource", + "const": "PractitionerRole", + "default": "PractitionerRole", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" + }, + "specialty": { + "binding_description": "Specific specialty associated with the agency.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", + "binding_version": null, + "description": "The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "Specific specialty of the practitioner", + "type": "array" + }, + "text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", + "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", + "element_property": true, + "title": "Text summary of the resource, for human interpretation" } }, - "title": "Resource", + "title": "PractitionerRole", "type": "object" }, - "PractitionerRole": { - "$id": "http://graph-fhir.io/schema/0.0.2/PractitionerRole", + "DosageDoseAndRate": { + "$id": "http://graph-fhir.io/schema/0.0.2/DosageDoseAndRate", "additionalProperties": false, - "description": "Roles/organizations the practitioner is associated with. A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. [See https://hl7.org/fhir/R5/PractitionerRole.html]", + "description": "Amount of medication administered, to be administered or typical amount to be administered. Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered. [See https://hl7.org/fhir/R5/DosageDoseAndRate.html]", + "links": [], "properties": { - "_active": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``active``." - }, - "_implicitRules": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``implicitRules``." - }, - "_language": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``language``." + "doseQuantity": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "element_property": true, + "one_of_many": "dose", + "one_of_many_required": false, + "title": "Amount of medication per dose" }, - "active": { - "description": " Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed.", + "doseRange": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Range", "element_property": true, - "title": "Whether this practitioner role record is in active use", - "type": "boolean" + "one_of_many": "dose", + "one_of_many_required": false, + "title": "Amount of medication per dose" }, - "availability": { - "description": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.", + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Availability" + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Times the Practitioner is available at this location and/or healthcare service (including exceptions)", + "title": "Additional content defined by implementations", "type": "array" }, - "characteristic": { - "binding_description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/service-mode", - "binding_version": null, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Collection of characteristics (attributes)", "type": "array" }, - "code": { - "binding_description": "The role a person plays representing an organization.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/practitioner-role", - "binding_version": null, - "description": "Roles which this practitioner is authorized to perform for the organization.", + "rateQuantity": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" - }, - "title": "Roles which this practitioner may perform", - "type": "array" + "one_of_many": "rate", + "one_of_many_required": false, + "title": "Amount of medication per unit of time" }, - "communication": { - "binding_description": "IETF language tag for a human language", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", - "binding_version": "5.0.0", - "description": "A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.", + "rateRange": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Range", "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" - }, - "title": "A language the practitioner (in this role) can use in patient communication", - "type": "array" + "one_of_many": "rate", + "one_of_many_required": false, + "title": "Amount of medication per unit of time" }, - "contact": { - "description": "The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.", + "rateRatio": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Ratio", "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ExtendedContactDetail" - }, - "title": "Official contact details relating to this PractitionerRole", - "type": "array" + "one_of_many": "rate", + "one_of_many_required": false, + "title": "Amount of medication per unit of time" + }, + "resourceType": { + "const": "DosageDoseAndRate", + "default": "DosageDoseAndRate", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "type": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "The kind of dose or rate specified.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/dose-rate-type", + "binding_version": null, + "description": "The kind of dose or rate specified, for example, ordered or calculated.", + "element_property": true, + "title": "The kind of dose or rate specified" + } + }, + "title": "DosageDoseAndRate", + "type": "object" + }, + "ObservationReferenceRange": { + "$id": "http://graph-fhir.io/schema/0.0.2/ObservationReferenceRange", + "additionalProperties": false, + "description": "Provides guide for interpretation. Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. [See https://hl7.org/fhir/R5/ObservationReferenceRange.html]", + "links": [], + "properties": { + "_text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``text``." }, - "contained": { - "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", + "age": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Range", + "description": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.", "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" - }, - "title": "Contained, inline Resources", - "type": "array" + "title": "Applicable age range, if relevant" }, - "endpoint": { - "backref": "endpoint_practitioner_role", - "description": " Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.", + "appliesTo": { + "binding_description": "Codes identifying the population the reference range applies to.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/referencerange-appliesto", + "binding_version": null, + "description": "Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.", "element_property": true, - "enum_reference_types": [ - "Endpoint" - ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" }, - "title": "Endpoints for interacting with the practitioner in this role", + "title": "Reference range population", "type": "array" }, "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" @@ -13399,441 +17116,911 @@ "element_property": false, "title": "Fhir Comments" }, - "healthcareService": { - "backref": "healthcareService_practitioner_role", - "description": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", + "high": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).", "element_property": true, - "enum_reference_types": [ - "HealthcareService" - ], + "title": "High Range, if relevant" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + "$ref": "https://json-schema.org/draft/2020-12/links" }, - "title": "Healthcare services provided for this role's Organization/Location(s)", "type": "array" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "low": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", - "type": "string" + "title": "Low Range, if relevant" }, - "identifier": { - "description": "Business Identifiers that are specific to a role/location.", + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Identifiers for a role/location", + "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, - "implicitRules": { - "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", + "normalValue": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Codes identifying the normal value of the observation.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue", + "binding_version": null, + "description": "The value of the normal value of the reference range.", "element_property": true, - "pattern": "\\S*", - "title": "A set of rules under which this content was created", - "type": "string" + "title": "Normal value, if relevant" }, - "language": { - "binding_description": "IETF language tag for a human language", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", - "binding_version": "5.0.0", - "description": "The base language in which the resource is written.", - "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Language of the resource content", + "resourceType": { + "const": "ObservationReferenceRange", + "default": "ObservationReferenceRange", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "location": { - "backref": "location_practitioner_role", - "description": "The location(s) at which this practitioner provides care.", + "text": { + "description": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\".", "element_property": true, - "enum_reference_types": [ - "Location" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" - }, - "title": "Location(s) where the practitioner provides care", - "type": "array" + "pattern": "\\s*(\\S|\\s)*", + "title": "Text based reference range in an observation", + "type": "string" }, - "meta": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", - "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", + "type": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Code for the meaning of a reference range.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/referencerange-meaning", + "binding_version": null, + "description": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "element_property": true, - "title": "Metadata about the resource" + "title": "Reference range qualifier" + } + }, + "title": "ObservationReferenceRange", + "type": "object" + }, + "ContactDetail": { + "$id": "http://graph-fhir.io/schema/0.0.2/ContactDetail", + "additionalProperties": false, + "description": "Contact information. Specifies contact information for a person or organization. [See https://hl7.org/fhir/R5/ContactDetail.html]", + "links": [], + "properties": { + "_name": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``name``." }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Extensions that cannot be ignored", + "title": "Additional content defined by implementations", "type": "array" }, - "organization": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "practitioner_role", - "description": "The organization where the Practitioner performs the roles associated.", - "element_property": true, - "enum_reference_types": [ - "Organization" + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], - "title": "Organization where the roles are available" + "element_property": false, + "title": "Fhir Comments" }, - "period": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, - "title": "The period during which the practitioner is authorized to perform in these role(s)" + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" }, - "practitioner": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "practitioner_role", - "description": "Practitioner that is able to provide the defined services for the organization.", + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "name": { + "description": "The name of an individual to contact.", "element_property": true, - "enum_reference_types": [ - "Practitioner" - ], - "title": "Practitioner that provides services for the organization" + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Name of an individual to contact", + "type": "string" }, "resourceType": { - "const": "PractitionerRole", - "default": "PractitionerRole", + "const": "ContactDetail", + "default": "ContactDetail", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, - "specialty": { - "binding_description": "Specific specialty associated with the agency.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "binding_version": null, - "description": "The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.", + "telecom": { + "description": "The contact details for the individual (if a name was provided) or the organization.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "$ref": "http://graph-fhir.io/schema/0.0.2/ContactPoint" + }, + "title": "Contact details for individual or organization", + "type": "array" + } + }, + "title": "ContactDetail", + "type": "object" + }, + "Procedure": { + "$id": "http://graph-fhir.io/schema/0.0.2/Procedure", + "additionalProperties": false, + "description": "An action that is being or was performed on an individual or entity. An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing. [See https://hl7.org/fhir/R5/Procedure.html]", + "links": [ + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" + }, + "templatePointers": { + "id": "/encounter/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "focus_Patient", + "targetHints": { + "backref": [ + "focus_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Specific specialty of the practitioner", - "type": "array" - }, - "text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "element_property": true, - "title": "Text summary of the resource, for human interpretation" - } - }, - "title": "PractitionerRole", - "type": "object" - }, - "DosageDoseAndRate": { - "$id": "http://graph-fhir.io/schema/0.0.2/DosageDoseAndRate", - "additionalProperties": false, - "description": "Amount of medication administered, to be administered or typical amount to be administered. Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered. [See https://hl7.org/fhir/R5/DosageDoseAndRate.html]", - "links": [], - "properties": { - "doseQuantity": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "element_property": true, - "one_of_many": "dose", - "one_of_many_required": false, - "title": "Amount of medication per dose" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/focus/reference" + }, + "templateRequired": [ + "id" + ] }, - "doseRange": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Range", - "element_property": true, - "one_of_many": "dose", - "one_of_many_required": false, - "title": "Amount of medication per dose" + { + "href": "Practitioner/{id}", + "rel": "focus_Practitioner", + "targetHints": { + "backref": [ + "focus_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/focus/reference" + }, + "templateRequired": [ + "id" + ] }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "Organization/{id}", + "rel": "focus_Organization", + "targetHints": { + "backref": [ + "focus_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Additional content defined by implementations", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/focus/reference" + }, + "templateRequired": [ + "id" + ] }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" + { + "href": "PractitionerRole/{id}", + "rel": "focus_PractitionerRole", + "targetHints": { + "backref": [ + "focus_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/focus/reference" + }, + "templateRequired": [ + "id" + ] }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" + { + "href": "Specimen/{id}", + "rel": "focus_Specimen", + "targetHints": { + "backref": [ + "focus_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" + }, + "templatePointers": { + "id": "/focus/reference" + }, + "templateRequired": [ + "id" + ] }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + { + "href": "Procedure/{id}", + "rel": "partOf_Procedure", + "targetHints": { + "backref": [ + "partOf_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" + }, + "templatePointers": { + "id": "/partOf/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "rateQuantity": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "element_property": true, - "one_of_many": "rate", - "one_of_many_required": false, - "title": "Amount of medication per unit of time" + { + "href": "Observation/{id}", + "rel": "partOf_Observation", + "targetHints": { + "backref": [ + "partOf_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Observation" + }, + "templatePointers": { + "id": "/partOf/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "rateRange": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Range", - "element_property": true, - "one_of_many": "rate", - "one_of_many_required": false, - "title": "Amount of medication per unit of time" + { + "href": "MedicationAdministration/{id}", + "rel": "partOf_MedicationAdministration", + "targetHints": { + "backref": [ + "partOf_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationAdministration" + }, + "templatePointers": { + "id": "/partOf/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "rateRatio": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Ratio", - "element_property": true, - "one_of_many": "rate", - "one_of_many_required": false, - "title": "Amount of medication per unit of time" + { + "href": "Patient/{id}", + "rel": "recorder_Patient", + "targetHints": { + "backref": [ + "recorder_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/recorder/reference" + }, + "templateRequired": [ + "id" + ] }, - "resourceType": { - "const": "DosageDoseAndRate", - "default": "DosageDoseAndRate", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + { + "href": "Practitioner/{id}", + "rel": "recorder_Practitioner", + "targetHints": { + "backref": [ + "recorder_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/recorder/reference" + }, + "templateRequired": [ + "id" + ] }, - "type": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "The kind of dose or rate specified.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/dose-rate-type", - "binding_version": null, - "description": "The kind of dose or rate specified, for example, ordered or calculated.", - "element_property": true, - "title": "The kind of dose or rate specified" - } - }, - "title": "DosageDoseAndRate", - "type": "object" - }, - "ObservationReferenceRange": { - "$id": "http://graph-fhir.io/schema/0.0.2/ObservationReferenceRange", - "additionalProperties": false, - "description": "Provides guide for interpretation. Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. [See https://hl7.org/fhir/R5/ObservationReferenceRange.html]", - "links": [], - "properties": { - "_text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``text``." + { + "href": "PractitionerRole/{id}", + "rel": "recorder_PractitionerRole", + "targetHints": { + "backref": [ + "recorder_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/recorder/reference" + }, + "templateRequired": [ + "id" + ] }, - "age": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Range", - "description": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.", - "element_property": true, - "title": "Applicable age range, if relevant" + { + "href": "DiagnosticReport/{id}", + "rel": "report_DiagnosticReport", + "targetHints": { + "backref": [ + "report_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReport" + }, + "templatePointers": { + "id": "/report/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "appliesTo": { - "binding_description": "Codes identifying the population the reference range applies to.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/referencerange-appliesto", - "binding_version": null, - "description": "Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an \"AND\" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + { + "href": "DocumentReference/{id}", + "rel": "report_DocumentReference", + "targetHints": { + "backref": [ + "report_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] }, - "title": "Reference range population", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DocumentReference" + }, + "templatePointers": { + "id": "/report/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "Patient/{id}", + "rel": "reportedReference_Patient", + "targetHints": { + "backref": [ + "reportedReference_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Additional content defined by implementations", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/reportedReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" + { + "href": "Practitioner/{id}", + "rel": "reportedReference_Practitioner", + "targetHints": { + "backref": [ + "reportedReference_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/reportedReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "high": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).", - "element_property": true, - "title": "High Range, if relevant" + { + "href": "PractitionerRole/{id}", + "rel": "reportedReference_PractitionerRole", + "targetHints": { + "backref": [ + "reportedReference_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/reportedReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" + { + "href": "Organization/{id}", + "rel": "reportedReference_Organization", + "targetHints": { + "backref": [ + "reportedReference_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/reportedReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + { + "href": "Patient/{id}", + "rel": "subject_Patient", + "targetHints": { + "backref": [ + "subject_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] }, - "low": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).", - "element_property": true, - "title": "Low Range, if relevant" + { + "href": "Practitioner/{id}", + "rel": "subject_Practitioner", + "targetHints": { + "backref": [ + "subject_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "href": "Organization/{id}", + "rel": "subject_Organization", + "targetHints": { + "backref": [ + "subject_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] }, - "normalValue": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Codes identifying the normal value of the observation.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue", - "binding_version": null, - "description": "The value of the normal value of the reference range.", - "element_property": true, - "title": "Normal value, if relevant" + { + "href": "Resource/{id}", + "rel": "supportingInfo", + "targetHints": { + "backref": [ + "supportingInfo_procedure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + }, + "templatePointers": { + "id": "/supportingInfo/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "resourceType": { - "const": "ObservationReferenceRange", - "default": "ObservationReferenceRange", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "text": { - "description": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of \"normals\".", - "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Text based reference range in an observation", - "type": "string" + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "type": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Code for the meaning of a reference range.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/referencerange-meaning", - "binding_version": null, - "description": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", - "element_property": true, - "title": "Reference range qualifier" - } - }, - "title": "ObservationReferenceRange", - "type": "object" - }, - "ContactDetail": { - "$id": "http://graph-fhir.io/schema/0.0.2/ContactDetail", - "additionalProperties": false, - "description": "Contact information. Specifies contact information for a person or organization. [See https://hl7.org/fhir/R5/ContactDetail.html]", - "links": [], - "properties": { - "_name": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``name``." + { + "$comment": "From Annotation/note", + "href": "Patient/{id}", + "rel": "note_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Additional content defined by implementations", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" + { + "$comment": "From ProcedurePerformer/performer", + "href": "Practitioner/{id}", + "rel": "performer_actor_Practitioner", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" + { + "$comment": "From ProcedurePerformer/performer", + "href": "PractitionerRole/{id}", + "rel": "performer_actor_PractitionerRole", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + { + "$comment": "From ProcedurePerformer/performer", + "href": "Organization/{id}", + "rel": "performer_actor_Organization", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "type": "array" - }, - "name": { - "description": "The name of an individual to contact.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Name of an individual to contact", - "type": "string" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "resourceType": { - "const": "ContactDetail", - "default": "ContactDetail", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + { + "$comment": "From ProcedurePerformer/performer", + "href": "Patient/{id}", + "rel": "performer_actor_Patient", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/performer/-/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "telecom": { - "description": "The contact details for the individual (if a name was provided) or the organization.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ContactPoint" + { + "$comment": "From ProcedurePerformer/performer", + "href": "Organization/{id}", + "rel": "performer_onBehalfOf", + "targetHints": { + "backref": [ + "onBehalfOf_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Contact details for individual or organization", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/performer/-/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] } - }, - "title": "ContactDetail", - "type": "object" - }, - "Procedure": { - "$id": "http://graph-fhir.io/schema/0.0.2/Procedure", - "additionalProperties": false, - "description": "An action that is being or was performed on an individual or entity. An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing. [See https://hl7.org/fhir/R5/Procedure.html]", + ], "properties": { "_implicitRules": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -14089,6 +18276,12 @@ "title": "Language of the resource content", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "location": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", "backref": "location_procedure", @@ -14368,36 +18561,196 @@ "binding_version": null, "description": "Identifies medications, devices and any other substance used as part of the procedure.", "element_property": true, - "enum_reference_types": [ - "Device", - "Medication", - "Substance", - "BiologicallyDerivedProduct" - ], - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" - }, - "title": "Items used during procedure", - "type": "array" + "enum_reference_types": [ + "Device", + "Medication", + "Substance", + "BiologicallyDerivedProduct" + ], + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" + }, + "title": "Items used during procedure", + "type": "array" + } + }, + "required": [ + "subject" + ], + "title": "Procedure", + "type": "object" + }, + "MedicationRequestDispenseRequestInitialFill": { + "$id": "http://graph-fhir.io/schema/0.0.2/MedicationRequestDispenseRequestInitialFill", + "additionalProperties": false, + "description": "First fill details. Indicates the quantity or duration for the first dispense of the medication. [See https://hl7.org/fhir/R5/MedicationRequestDispenseRequestInitialFill.html]", + "links": [], + "properties": { + "duration": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Duration", + "description": "The length of time that the first dispense is expected to last.", + "element_property": true, + "title": "First fill duration" + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "quantity": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", + "description": "The amount or quantity to provide as part of the first dispense.", + "element_property": true, + "title": "First fill quantity" + }, + "resourceType": { + "const": "MedicationRequestDispenseRequestInitialFill", + "default": "MedicationRequestDispenseRequestInitialFill", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "title": "MedicationRequestDispenseRequestInitialFill", + "type": "object" + }, + "ResearchStudyLabel": { + "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyLabel", + "additionalProperties": false, + "description": "Additional names for the study. [See https://hl7.org/fhir/R5/ResearchStudyLabel.html]", + "links": [], + "properties": { + "_value": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``value``." + }, + "extension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "fhir_comments": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ], + "element_property": false, + "title": "Fhir Comments" + }, + "id": { + "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unique id for inter-element referencing", + "type": "string" + }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "modifierExtension": { + "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + }, + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "resourceType": { + "const": "ResearchStudyLabel", + "default": "ResearchStudyLabel", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "type": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "desc.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/title-type", + "binding_version": null, + "description": "Kind of name.", + "element_property": true, + "title": "primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid" + }, + "value": { + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "The name", + "type": "string" } }, - "required": [ - "subject" - ], - "title": "Procedure", + "title": "ResearchStudyLabel", "type": "object" }, - "MedicationRequestDispenseRequestInitialFill": { - "$id": "http://graph-fhir.io/schema/0.0.2/MedicationRequestDispenseRequestInitialFill", + "DocumentReferenceContentProfile": { + "$id": "http://graph-fhir.io/schema/0.0.2/DocumentReferenceContentProfile", "additionalProperties": false, - "description": "First fill details. Indicates the quantity or duration for the first dispense of the medication. [See https://hl7.org/fhir/R5/MedicationRequestDispenseRequestInitialFill.html]", + "description": "Content profile rules for the document. An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. [See https://hl7.org/fhir/R5/DocumentReferenceContentProfile.html]", "links": [], "properties": { - "duration": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Duration", - "description": "The length of time that the first dispense is expected to last.", - "element_property": true, - "title": "First fill duration" + "_valueCanonical": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``valueCanonical``." + }, + "_valueUri": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``valueUri``." }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -14445,32 +18798,60 @@ "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, - "quantity": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity", - "description": "The amount or quantity to provide as part of the first dispense.", - "element_property": true, - "title": "First fill quantity" - }, "resourceType": { - "const": "MedicationRequestDispenseRequestInitialFill", - "default": "MedicationRequestDispenseRequestInitialFill", + "const": "DocumentReferenceContentProfile", + "default": "DocumentReferenceContentProfile", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" + }, + "valueCanonical": { + "element_property": true, + "one_of_many": "value", + "one_of_many_required": true, + "pattern": "\\S*", + "title": "Code|uri|canonical", + "type": "string" + }, + "valueCoding": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Coding", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": true, + "title": "Code|uri|canonical" + }, + "valueUri": { + "element_property": true, + "one_of_many": "value", + "one_of_many_required": true, + "pattern": "\\S*", + "title": "Code|uri|canonical", + "type": "string" } }, - "title": "MedicationRequestDispenseRequestInitialFill", + "title": "DocumentReferenceContentProfile", "type": "object" }, - "ResearchStudyLabel": { - "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyLabel", + "ResearchStudyObjective": { + "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyObjective", "additionalProperties": false, - "description": "Additional names for the study. [See https://hl7.org/fhir/R5/ResearchStudyLabel.html]", + "description": "A goal for the study. A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study. [See https://hl7.org/fhir/R5/ResearchStudyObjective.html]", "links": [], "properties": { - "_value": { + "_description": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``value``." + "title": "Extension field for ``description``." + }, + "_name": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``name``." + }, + "description": { + "description": "Free text description of the objective of the study. This is what the study is trying to achieve rather than how it is going to achieve it (see ResearchStudy.description).", + "element_property": true, + "pattern": "\\s*(\\S|\\s)*", + "title": "Description of the objective", + "type": "string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -14518,55 +18899,177 @@ "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, + "name": { + "description": "Unique, human-readable label for this objective of the study.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Label for the objective", + "type": "string" + }, "resourceType": { - "const": "ResearchStudyLabel", - "default": "ResearchStudyLabel", + "const": "ResearchStudyObjective", + "default": "ResearchStudyObjective", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, "type": { "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "desc.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/title-type", + "binding_description": "Codes for the kind of study objective.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-objective-type", "binding_version": null, - "description": "Kind of name.", - "element_property": true, - "title": "primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid" - }, - "value": { + "description": "The kind of study objective.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "The name", - "type": "string" + "title": "primary | secondary | exploratory" } }, - "title": "ResearchStudyLabel", + "title": "ResearchStudyObjective", "type": "object" }, - "LocationPosition": { - "$id": "http://graph-fhir.io/schema/0.0.2/LocationPosition", + "ProcedurePerformer": { + "$id": "http://graph-fhir.io/schema/0.0.2/ProcedurePerformer", "additionalProperties": false, - "description": "The absolute geographic location. The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML). [See https://hl7.org/fhir/R5/LocationPosition.html]", - "properties": { - "_altitude": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``altitude``." + "description": "Who performed the procedure and what they did. Indicates who or what performed the procedure and how they were involved. [See https://hl7.org/fhir/R5/ProcedurePerformer.html]", + "links": [ + { + "href": "Practitioner/{id}", + "rel": "actor_Practitioner", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "_latitude": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``latitude``." + { + "href": "PractitionerRole/{id}", + "rel": "actor_PractitionerRole", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "_longitude": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``longitude``." + { + "href": "Organization/{id}", + "rel": "actor_Organization", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "actor_Patient", + "targetHints": { + "backref": [ + "actor_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/actor/reference" + }, + "templateRequired": [ + "id" + ] }, - "altitude": { - "description": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes on Location main page).", + { + "href": "Organization/{id}", + "rel": "onBehalfOf", + "targetHints": { + "backref": [ + "onBehalfOf_procedure_performer" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { + "actor": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "actor_procedure_performer", + "description": "Indicates who or what performed the procedure.", "element_property": true, - "title": "Altitude with WGS84 datum", - "type": "number" + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "Patient", + "RelatedPerson", + "Device", + "CareTeam", + "HealthcareService" + ], + "title": "Who performed the procedure" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -14592,6 +19095,16 @@ "element_property": false, "title": "Fhir Comments" }, + "function": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "A code that identifies the role of a performer of the procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", + "binding_version": null, + "description": "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.", + "element_property": true, + "title": "Type of performance" + }, "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "element_property": true, @@ -14599,19 +19112,11 @@ "title": "Unique id for inter-element referencing", "type": "string" }, - "latitude": { - "description": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes on Location main page).", - "element_property": true, - "element_required": true, - "title": "Latitude with WGS84 datum", - "type": "number" - }, - "longitude": { - "description": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes on Location main page).", - "element_property": true, - "element_required": true, - "title": "Longitude with WGS84 datum", - "type": "number" + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", @@ -14622,30 +19127,56 @@ "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, + "onBehalfOf": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "onBehalfOf_procedure_performer", + "description": "The Organization the Patient, RelatedPerson, Device, CareTeam, and HealthcareService was acting on behalf of.", + "element_property": true, + "enum_reference_types": [ + "Organization" + ], + "title": "Organization the device or practitioner was acting for" + }, + "period": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Period", + "description": "Time period during which the performer performed the procedure.", + "element_property": true, + "title": "When the performer performed the procedure" + }, "resourceType": { - "const": "LocationPosition", - "default": "LocationPosition", + "const": "ProcedurePerformer", + "default": "ProcedurePerformer", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" } }, - "title": "LocationPosition", + "required": [ + "actor" + ], + "title": "ProcedurePerformer", "type": "object" }, - "DocumentReferenceContentProfile": { - "$id": "http://graph-fhir.io/schema/0.0.2/DocumentReferenceContentProfile", + "ResearchSubjectProgress": { + "$id": "http://graph-fhir.io/schema/0.0.2/ResearchSubjectProgress", "additionalProperties": false, - "description": "Content profile rules for the document. An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. [See https://hl7.org/fhir/R5/DocumentReferenceContentProfile.html]", + "description": "Subject status. The current state (status) of the subject and resons for status change where appropriate. [See https://hl7.org/fhir/R5/ResearchSubjectProgress.html]", "links": [], "properties": { - "_valueCanonical": { + "_endDate": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``valueCanonical``." + "title": "Extension field for ``endDate``." }, - "_valueUri": { + "_startDate": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``valueUri``." + "title": "Extension field for ``startDate``." + }, + "endDate": { + "description": "The date when the state ended.", + "element_property": true, + "format": "date-time", + "title": "State change date", + "type": "string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -14684,6 +19215,16 @@ }, "type": "array" }, + "milestone": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Indicates the progression of a study subject through the study milestones.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-subject-milestone", + "binding_version": null, + "description": "The milestones the subject has passed through.", + "element_property": true, + "title": "SignedUp | Screened | Randomized" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -14693,159 +19234,215 @@ "title": "Extensions that cannot be ignored even if unrecognized", "type": "array" }, + "reason": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Indicates why the state of the subject changed.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/state-change-reason", + "binding_version": null, + "description": "The reason for the state change. If coded it should follow the formal subject state model.", + "element_property": true, + "title": "State change reason" + }, "resourceType": { - "const": "DocumentReferenceContentProfile", - "default": "DocumentReferenceContentProfile", + "const": "ResearchSubjectProgress", + "default": "ResearchSubjectProgress", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, - "valueCanonical": { + "startDate": { + "description": "The date when the new status started.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": true, - "pattern": "\\S*", - "title": "Code|uri|canonical", + "format": "date-time", + "title": "State change date", "type": "string" }, - "valueCoding": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Coding", + "subjectState": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Indicates the progression of a study subject through a study.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-subject-state", + "binding_version": "5.0.0", + "description": "The current state of the subject.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": true, - "title": "Code|uri|canonical" + "title": "candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn" }, - "valueUri": { + "type": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", + "binding_description": "Identifies the kind of state being refered to.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-subject-state-type", + "binding_version": null, + "description": "Identifies the aspect of the subject's journey that the state refers to.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": true, - "pattern": "\\S*", - "title": "Code|uri|canonical", - "type": "string" + "title": "state | milestone" } }, - "title": "DocumentReferenceContentProfile", + "title": "ResearchSubjectProgress", "type": "object" }, - "ResearchStudyObjective": { - "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudyObjective", + "Organization": { + "$id": "http://graph-fhir.io/schema/0.0.2/Organization", "additionalProperties": false, - "description": "A goal for the study. A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study. [See https://hl7.org/fhir/R5/ResearchStudyObjective.html]", - "links": [], + "description": "A grouping of people or organizations with a common purpose. A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. [See https://hl7.org/fhir/R5/Organization.html]", + "links": [ + { + "href": "Organization/{id}", + "rel": "partOf", + "targetHints": { + "backref": [ + "organization" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/partOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ExtendedContactDetail/contact", + "href": "Organization/{id}", + "rel": "contact_organization", + "targetHints": { + "backref": [ + "extended_contact_detail" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/contact/-/organization/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From OrganizationQualification/qualification", + "href": "Organization/{id}", + "rel": "qualification_issuer", + "targetHints": { + "backref": [ + "organization_qualification" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/qualification/-/issuer/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { + "_active": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``active``." + }, + "_alias": { + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" + }, + "title": "Extension field for ``alias``.", + "type": "array" + }, "_description": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``description``." }, + "_implicitRules": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``implicitRules``." + }, + "_language": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``language``." + }, "_name": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``name``." }, - "description": { - "description": "Free text description of the objective of the study. This is what the study is trying to achieve rather than how it is going to achieve it (see ResearchStudy.description).", + "active": { "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Description of the objective", - "type": "string" + "title": "Whether the organization's record is still in active use", + "type": "boolean" }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "alias": { "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "pattern": "[ \\r\\n\\t\\S]+", + "type": "string" }, - "title": "Additional content defined by implementations", + "title": "A list of alternate names that the organization is known as, or was known as in the past", "type": "array" }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "contact": { + "description": "The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "links": { "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + "$ref": "http://graph-fhir.io/schema/0.0.2/ExtendedContactDetail" }, + "title": "Official contact details for the Organization", "type": "array" }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "contained": { + "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" }, - "title": "Extensions that cannot be ignored even if unrecognized", + "title": "Contained, inline Resources", "type": "array" }, - "name": { - "description": "Unique, human-readable label for this objective of the study.", + "description": { + "description": "Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Label for the objective", - "type": "string" - }, - "resourceType": { - "const": "ResearchStudyObjective", - "default": "ResearchStudyObjective", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", + "pattern": "\\s*(\\S|\\s)*", + "title": "Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name", "type": "string" }, - "type": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Codes for the kind of study objective.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-objective-type", - "binding_version": null, - "description": "The kind of study objective.", - "element_property": true, - "title": "primary | secondary | exploratory" - } - }, - "title": "ResearchStudyObjective", - "type": "object" - }, - "ProcedurePerformer": { - "$id": "http://graph-fhir.io/schema/0.0.2/ProcedurePerformer", - "additionalProperties": false, - "description": "Who performed the procedure and what they did. Indicates who or what performed the procedure and how they were involved. [See https://hl7.org/fhir/R5/ProcedurePerformer.html]", - "properties": { - "actor": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "actor_procedure_performer", - "description": "Indicates who or what performed the procedure.", + "endpoint": { + "backref": "endpoint_organization", "element_property": true, "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "Patient", - "RelatedPerson", - "Device", - "CareTeam", - "HealthcareService" + "Endpoint" ], - "title": "Who performed the procedure" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" + }, + "title": "Technical endpoints providing access to services operated for the organization", + "type": "array" }, "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" @@ -14868,81 +19465,167 @@ "element_property": false, "title": "Fhir Comments" }, - "function": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "A code that identifies the role of a performer of the procedure.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", - "binding_version": null, - "description": "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, - "title": "Type of performance" + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "identifier": { + "description": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" + }, + "title": "Identifies this organization across multiple systems", + "type": "array" + }, + "implicitRules": { + "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", + "element_property": true, + "pattern": "\\S*", + "title": "A set of rules under which this content was created", + "type": "string" + }, + "language": { + "binding_description": "IETF language tag for a human language", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "The base language in which the resource is written.", + "element_property": true, + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "Language of the resource content", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "meta": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", + "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", + "element_property": true, + "title": "Metadata about the resource" + }, "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", + "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Extensions that cannot be ignored even if unrecognized", + "title": "Extensions that cannot be ignored", "type": "array" }, - "onBehalfOf": { + "name": { + "description": "A name associated with the organization.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Name used for the organization", + "type": "string" + }, + "partOf": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "onBehalfOf_procedure_performer", - "description": "The Organization the Patient, RelatedPerson, Device, CareTeam, and HealthcareService was acting on behalf of.", + "backref": "organization", "element_property": true, "enum_reference_types": [ "Organization" ], - "title": "Organization the device or practitioner was acting for" + "title": "The organization of which this organization forms a part" }, - "period": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Period", - "description": "Time period during which the performer performed the procedure.", + "qualification": { + "description": "The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.", "element_property": true, - "title": "When the performer performed the procedure" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/OrganizationQualification" + }, + "title": "Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care", + "type": "array" }, "resourceType": { - "const": "ProcedurePerformer", - "default": "ProcedurePerformer", + "const": "Organization", + "default": "Organization", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" + }, + "text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", + "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", + "element_property": true, + "title": "Text summary of the resource, for human interpretation" + }, + "type": { + "binding_description": "Used to categorize the organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/organization-type", + "binding_version": null, + "description": "The kind(s) of organization that this is.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "Kind of organization", + "type": "array" } }, - "required": [ - "actor" - ], - "title": "ProcedurePerformer", + "title": "Organization", "type": "object" }, - "ResearchSubjectProgress": { - "$id": "http://graph-fhir.io/schema/0.0.2/ResearchSubjectProgress", + "Distance": { + "$id": "http://graph-fhir.io/schema/0.0.2/Distance", "additionalProperties": false, - "description": "Subject status. The current state (status) of the subject and resons for status change where appropriate. [See https://hl7.org/fhir/R5/ResearchSubjectProgress.html]", + "description": "A length - a value with a unit that is a physical distance. [See https://hl7.org/fhir/R5/Distance.html]", "links": [], "properties": { - "_endDate": { + "_code": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``endDate``." + "title": "Extension field for ``code``." }, - "_startDate": { + "_comparator": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``startDate``." + "title": "Extension field for ``comparator``." }, - "endDate": { - "description": "The date when the state ended.", + "_system": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``system``." + }, + "_unit": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``unit``." + }, + "_value": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``value``." + }, + "code": { + "description": "A computer processable form of the unit in some unit representation system.", "element_property": true, - "format": "date-time", - "title": "State change date", + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "Coded form of the unit", + "type": "string" + }, + "comparator": { + "binding_description": "How the Quantity should be understood and represented.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/quantity-comparator", + "binding_version": "5.0.0", + "description": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", + "element_property": true, + "enum_values": [ + "<", + "<=", + ">=", + ">", + "ad" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "< | <= | >= | > | ad - how to understand the value", "type": "string" }, "extension": { @@ -14976,95 +19659,319 @@ "title": "Unique id for inter-element referencing", "type": "string" }, - "links": { - "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" - }, - "type": "array" - }, - "milestone": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Indicates the progression of a study subject through the study milestones.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-subject-milestone", - "binding_version": null, - "description": "The milestones the subject has passed through.", - "element_property": true, - "title": "SignedUp | Screened | Randomized" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "reason": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Indicates why the state of the subject changed.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/state-change-reason", - "binding_version": null, - "description": "The reason for the state change. If coded it should follow the formal subject state model.", - "element_property": true, - "title": "State change reason" + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" }, "resourceType": { - "const": "ResearchSubjectProgress", - "default": "ResearchSubjectProgress", + "const": "Distance", + "default": "Distance", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, - "startDate": { - "description": "The date when the new status started.", + "system": { + "description": "The identification of the system that provides the coded form of the unit.", "element_property": true, - "format": "date-time", - "title": "State change date", + "pattern": "\\S*", + "title": "System that defines coded unit form", "type": "string" }, - "subjectState": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Indicates the progression of a study subject through a study.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-subject-state", - "binding_version": "5.0.0", - "description": "The current state of the subject.", + "unit": { + "description": "A human-readable form of the unit.", "element_property": true, - "title": "candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn" + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Unit representation", + "type": "string" }, - "type": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "Identifies the kind of state being refered to.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-subject-state-type", - "binding_version": null, - "description": "Identifies the aspect of the subject's journey that the state refers to.", + "value": { + "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "element_property": true, - "title": "state | milestone" + "title": "Numerical value (with implicit precision)", + "type": "number" } }, - "title": "ResearchSubjectProgress", + "title": "Distance", "type": "object" }, - "Organization": { - "$id": "http://graph-fhir.io/schema/0.0.2/Organization", + "ImagingStudy": { + "$id": "http://graph-fhir.io/schema/0.0.2/ImagingStudy", "additionalProperties": false, - "description": "A grouping of people or organizations with a common purpose. A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. [See https://hl7.org/fhir/R5/Organization.html]", - "properties": { - "_active": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``active``." + "description": "A set of images produced in single study (one or more series of references images). Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. [See https://hl7.org/fhir/R5/ImagingStudy.html]", + "links": [ + { + "href": "Task/{id}", + "rel": "basedOn_Task", + "targetHints": { + "backref": [ + "basedOn_imaging_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Task" + }, + "templatePointers": { + "id": "/basedOn/-/reference" + }, + "templateRequired": [ + "id" + ] }, - "_alias": { - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" + { + "href": "Encounter/{id}", + "rel": "encounter", + "targetHints": { + "backref": [ + "imaging_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Encounter" + }, + "templatePointers": { + "id": "/encounter/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Procedure/{id}", + "rel": "partOf", + "targetHints": { + "backref": [ + "partOf_imaging_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" + }, + "templatePointers": { + "id": "/partOf/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Practitioner/{id}", + "rel": "referrer_Practitioner", + "targetHints": { + "backref": [ + "imaging_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/referrer/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "referrer_PractitionerRole", + "targetHints": { + "backref": [ + "imaging_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/referrer/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "subject_Patient", + "targetHints": { + "backref": [ + "imaging_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Patient/{id}", + "rel": "note_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Extension field for ``alias``.", - "type": "array" + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] }, + { + "$comment": "From ImagingStudySeries/series", + "href": "Specimen/{id}", + "rel": "series_specimen", + "targetHints": { + "backref": [ + "specimen_imaging_study_series" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" + }, + "templatePointers": { + "id": "/series/-/specimen/-/reference" + }, + "templateRequired": [ + "id" + ] + } + ], + "properties": { "_description": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``description``." @@ -15077,31 +19984,37 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", "title": "Extension field for ``language``." }, - "_name": { + "_numberOfInstances": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``name``." + "title": "Extension field for ``numberOfInstances``." }, - "active": { - "element_property": true, - "title": "Whether the organization's record is still in active use", - "type": "boolean" + "_numberOfSeries": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``numberOfSeries``." }, - "alias": { - "element_property": true, - "items": { - "pattern": "[ \\r\\n\\t\\S]+", - "type": "string" - }, - "title": "A list of alternate names that the organization is known as, or was known as in the past", - "type": "array" + "_started": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``started``." }, - "contact": { - "description": "The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.", + "_status": { + "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", + "title": "Extension field for ``status``." + }, + "basedOn": { + "backref": "basedOn_imaging_study", + "description": "A list of the diagnostic requests that resulted in this imaging study being performed.", "element_property": true, + "enum_reference_types": [ + "CarePlan", + "ServiceRequest", + "Appointment", + "AppointmentResponse", + "Task" + ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ExtendedContactDetail" + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "Official contact details for the Organization", + "title": "Request fulfilled", "type": "array" }, "contained": { @@ -15114,14 +20027,25 @@ "type": "array" }, "description": { - "description": "Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.", + "description": "The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.", "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name", + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Institution-generated description", "type": "string" }, + "encounter": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "imaging_study", + "description": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "Encounter with which this imaging study is associated" + }, "endpoint": { - "backref": "endpoint_organization", + "backref": "endpoint_imaging_study", + "description": "The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.", "element_property": true, "enum_reference_types": [ "Endpoint" @@ -15129,7 +20053,7 @@ "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "Technical endpoints providing access to services operated for the organization", + "title": "Study access endpoint", "type": "array" }, "extension": { @@ -15166,12 +20090,12 @@ "type": "string" }, "identifier": { - "description": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", + "description": "Identifiers for the ImagingStudy such as DICOM Study Instance UID.", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Identifier" }, - "title": "Identifies this organization across multiple systems", + "title": "Identifiers for the whole study", "type": "array" }, "implicitRules": { @@ -15192,12 +20116,41 @@ "title": "Language of the resource content", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "location": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "imaging_study", + "description": "The principal physical location where the ImagingStudy was performed.", + "element_property": true, + "enum_reference_types": [ + "Location" + ], + "title": "Where ImagingStudy occurred" + }, "meta": { "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "element_property": true, "title": "Metadata about the resource" }, + "modality": { + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "binding_version": null, + "description": "A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + }, + "title": "All of the distinct values for series' modalities", + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -15207,184 +20160,188 @@ "title": "Extensions that cannot be ignored", "type": "array" }, - "name": { - "description": "A name associated with the organization.", + "note": { + "description": "Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Name used for the organization", - "type": "string" + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Annotation" + }, + "title": "User-defined comments", + "type": "array" + }, + "numberOfInstances": { + "description": "Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.", + "element_property": true, + "minimum": 0, + "title": "Number of Study Related Instances", + "type": "integer" + }, + "numberOfSeries": { + "description": "Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.", + "element_property": true, + "minimum": 0, + "title": "Number of Study Related Series", + "type": "integer" }, "partOf": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "organization", + "backref": "partOf_imaging_study", + "description": "A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure.", "element_property": true, "enum_reference_types": [ - "Organization" + "Procedure" ], - "title": "The organization of which this organization forms a part" - }, - "qualification": { - "description": "The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.", - "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/OrganizationQualification" + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference" }, - "title": "Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care", + "title": "Part of referenced event", "type": "array" }, - "resourceType": { - "const": "Organization", - "default": "Organization", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "text": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", - "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", - "element_property": true, - "title": "Text summary of the resource, for human interpretation" - }, - "type": { - "binding_description": "Used to categorize the organization.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/organization-type", + "procedure": { + "backref": "procedure_imaging_study", + "binding_description": "Use of RadLex is preferred", + "binding_strength": "preferred", + "binding_uri": "http://loinc.org/vs/loinc-rsna-radiology-playbook", "binding_version": null, - "description": "The kind(s) of organization that this is.", + "description": "This field corresponds to the DICOM Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure resource that may include the ImagingStudy.", "element_property": true, + "enum_reference_types": [ + "PlanDefinition", + "ActivityDefinition" + ], "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" }, - "title": "Kind of organization", + "title": "The performed procedure or code", "type": "array" - } - }, - "title": "Organization", - "type": "object" - }, - "Distance": { - "$id": "http://graph-fhir.io/schema/0.0.2/Distance", - "additionalProperties": false, - "description": "A length - a value with a unit that is a physical distance. [See https://hl7.org/fhir/R5/Distance.html]", - "links": [], - "properties": { - "_code": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``code``." - }, - "_comparator": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``comparator``." - }, - "_system": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``system``." - }, - "_unit": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``unit``." - }, - "_value": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``value``." - }, - "code": { - "description": "A computer processable form of the unit in some unit representation system.", - "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Coded form of the unit", - "type": "string" }, - "comparator": { - "binding_description": "How the Quantity should be understood and represented.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/quantity-comparator", - "binding_version": "5.0.0", - "description": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", + "reason": { + "backref": "reason_imaging_study", + "binding_description": "The reason for the study.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-reason", + "binding_version": null, + "description": "Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.", "element_property": true, - "enum_values": [ - "<", - "<=", - ">=", - ">", - "ad" + "enum_reference_types": [ + "Condition", + "Observation", + "DiagnosticReport", + "DocumentReference" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "< | <= | >= | > | ad - how to understand the value", - "type": "string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" + "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" }, - "title": "Additional content defined by implementations", + "title": "Why the study was requested / performed", "type": "array" }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", + "referrer": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "imaging_study", + "description": "The requesting/referring physician.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", + "enum_reference_types": [ + "Practitioner", + "PractitionerRole" + ], + "title": "Referring physician" + }, + "resourceType": { + "const": "ImagingStudy", + "default": "ImagingStudy", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "links": { + "series": { + "description": "Each study has one or more series of images or other content.", + "element_property": true, "items": { - "$ref": "https://json-schema.org/draft/2020-12/links" + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeries" }, + "title": "Each study has one or more series of instances", "type": "array" }, - "resourceType": { - "const": "Distance", - "default": "Distance", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", + "started": { + "description": "Date and time the study started.", + "element_property": true, + "format": "date-time", + "title": "When the study was started", "type": "string" }, - "system": { - "description": "The identification of the system that provides the coded form of the unit.", + "status": { + "binding_description": "The status of the ImagingStudy.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/imagingstudy-status", + "binding_version": "5.0.0", + "description": "The current state of the ImagingStudy resource. This is not the status of any ServiceRequest or Task resources associated with the ImagingStudy.", "element_property": true, - "pattern": "\\S*", - "title": "System that defines coded unit form", + "element_required": true, + "enum_values": [ + "registered", + "available", + "cancelled", + "entered-in-error", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "registered | available | cancelled | entered-in-error | unknown", "type": "string" }, - "unit": { - "description": "A human-readable form of the unit.", + "subject": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", + "backref": "imaging_study", + "description": "The subject, typically a patient, of the imaging study.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unit representation", - "type": "string" + "enum_reference_types": [ + "Patient", + "Device", + "Group" + ], + "title": "Who or what is the subject of the study" }, - "value": { - "description": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", + "text": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Narrative", + "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "element_property": true, - "title": "Numerical value (with implicit precision)", - "type": "number" + "title": "Text summary of the resource, for human interpretation" } }, - "title": "Distance", + "required": [ + "subject" + ], + "title": "ImagingStudy", "type": "object" }, "BodyStructure": { "$id": "http://graph-fhir.io/schema/0.0.2/BodyStructure", "additionalProperties": false, "description": "Specific and identified anatomical structure. Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case. [See https://hl7.org/fhir/R5/BodyStructure.html]", + "links": [ + { + "href": "Patient/{id}", + "rel": "patient", + "targetHints": { + "backref": [ + "body_structure" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/patient/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "_active": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -15511,6 +20468,12 @@ "title": "Language of the resource content", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "meta": { "$ref": "http://graph-fhir.io/schema/0.0.2/Meta", "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", @@ -15806,119 +20769,6 @@ "title": "ObservationComponent", "type": "object" }, - "ImmunizationProtocolApplied": { - "$id": "http://graph-fhir.io/schema/0.0.2/ImmunizationProtocolApplied", - "additionalProperties": false, - "description": "Protocol followed by the provider. The protocol (set of recommendations) being followed by the provider who administered the dose. [See https://hl7.org/fhir/R5/ImmunizationProtocolApplied.html]", - "properties": { - "_doseNumber": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``doseNumber``." - }, - "_series": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``series``." - }, - "_seriesDoses": { - "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", - "title": "Extension field for ``seriesDoses``." - }, - "authority": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "immunization_protocol_applied", - "description": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.", - "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "Who is responsible for publishing the recommendations" - }, - "doseNumber": { - "description": "Nominal position in a series as intended by the practitioner administering the dose.", - "element_property": true, - "element_required": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Dose number within series", - "type": "string" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "resourceType": { - "const": "ImmunizationProtocolApplied", - "default": "ImmunizationProtocolApplied", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "series": { - "description": "One possible path to achieve presumed immunity against a disease - within the context of an authority.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Name of vaccine series", - "type": "string" - }, - "seriesDoses": { - "description": "The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Recommended number of doses for immunity", - "type": "string" - }, - "targetDisease": { - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-target-disease", - "binding_version": null, - "description": "The vaccine preventable disease the dose is being administered against.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept" - }, - "title": "Vaccine preventatable disease being targeted", - "type": "array" - } - }, - "title": "ImmunizationProtocolApplied", - "type": "object" - }, "Address": { "$id": "http://graph-fhir.io/schema/0.0.2/Address", "additionalProperties": false, @@ -16340,6 +21190,7 @@ "$id": "http://graph-fhir.io/schema/0.0.2/EncounterLocation", "additionalProperties": false, "description": "List of locations where the patient has been. List of locations where the patient has been during this encounter. [See https://hl7.org/fhir/R5/EncounterLocation.html]", + "links": [], "properties": { "_status": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -16386,6 +21237,12 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "location": { "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", "backref": "encounter_location", @@ -16445,6 +21302,7 @@ "$id": "http://graph-fhir.io/schema/0.0.2/EncounterDiagnosis", "additionalProperties": false, "description": "The list of diagnosis relevant to this encounter. [See https://hl7.org/fhir/R5/EncounterDiagnosis.html]", + "links": [], "properties": { "condition": { "backref": "condition_encounter_diagnosis", @@ -16494,6 +21352,12 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -16935,6 +21799,7 @@ "$id": "http://graph-fhir.io/schema/0.0.2/BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark", "additionalProperties": false, "description": "Landmark relative location. The distance in centimeters a certain observation is made from a body landmark. [See https://hl7.org/fhir/R5/BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark.html]", + "links": [], "properties": { "device": { "backref": "device_body_structure_included_structure_body_landmark_orientation_distance_from_landmark", @@ -16984,43 +21849,121 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "resourceType": { - "const": "BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark", - "default": "BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + "title": "Extensions that cannot be ignored even if unrecognized", + "type": "array" + }, + "resourceType": { + "const": "BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark", + "default": "BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "value": { + "description": "The measured distance (e.g., in cm) from a body landmark.", + "element_property": true, + "items": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity" + }, + "title": "Measured distance from body landmark", + "type": "array" + } + }, + "title": "BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark", + "type": "object" + }, + "DocumentReferenceAttester": { + "$id": "http://graph-fhir.io/schema/0.0.2/DocumentReferenceAttester", + "additionalProperties": false, + "description": "Attests to accuracy of the document. A participant who has authenticated the accuracy of the document. [See https://hl7.org/fhir/R5/DocumentReferenceAttester.html]", + "links": [ + { + "href": "Patient/{id}", + "rel": "party_Patient", + "targetHints": { + "backref": [ + "document_reference_attester" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/party/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Practitioner/{id}", + "rel": "party_Practitioner", + "targetHints": { + "backref": [ + "document_reference_attester" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/party/reference" + }, + "templateRequired": [ + "id" + ] }, - "value": { - "description": "The measured distance (e.g., in cm) from a body landmark.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Quantity" + { + "href": "PractitionerRole/{id}", + "rel": "party_PractitionerRole", + "targetHints": { + "backref": [ + "document_reference_attester" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] }, - "title": "Measured distance from body landmark", - "type": "array" - } - }, - "title": "BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark", - "type": "object" - }, - "DocumentReferenceAttester": { - "$id": "http://graph-fhir.io/schema/0.0.2/DocumentReferenceAttester", - "additionalProperties": false, - "description": "Attests to accuracy of the document. A participant who has authenticated the accuracy of the document. [See https://hl7.org/fhir/R5/DocumentReferenceAttester.html]", - "links": [ + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/party/reference" + }, + "templateRequired": [ + "id" + ] + }, { - "href": "Patient/{id}", - "rel": "party_Patient", + "href": "Organization/{id}", + "rel": "party_Organization", "targetHints": { "backref": [ "document_reference_attester" @@ -17033,7 +21976,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { "id": "/party/reference" @@ -17511,6 +22454,56 @@ "$id": "http://graph-fhir.io/schema/0.0.2/EncounterAdmission", "additionalProperties": false, "description": "Details about the admission to a healthcare service. Details about the stay during which a healthcare service is provided. This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge. [See https://hl7.org/fhir/R5/EncounterAdmission.html]", + "links": [ + { + "href": "Organization/{id}", + "rel": "destination_Organization", + "targetHints": { + "backref": [ + "destination_encounter_admission" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/destination/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "origin_Organization", + "targetHints": { + "backref": [ + "origin_encounter_admission" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/origin/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "admitSource": { "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", @@ -17571,6 +22564,12 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -17620,6 +22619,33 @@ "$id": "http://graph-fhir.io/schema/0.0.2/VirtualServiceDetail", "additionalProperties": false, "description": "Virtual Service Contact Details. [See https://hl7.org/fhir/R5/VirtualServiceDetail.html]", + "links": [ + { + "$comment": "From ExtendedContactDetail/addressExtendedContactDetail", + "href": "Organization/{id}", + "rel": "addressExtendedContactDetail_organization", + "targetHints": { + "backref": [ + "extended_contact_detail" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/addressExtendedContactDetail/organization/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "_additionalInfo": { "items": { @@ -17732,77 +22758,256 @@ "title": "Unique id for inter-element referencing", "type": "string" }, - "maxParticipants": { - "element_property": true, - "exclusiveMinimum": 0, - "title": "Maximum number of participants supported by the virtual service", - "type": "integer" + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, + "maxParticipants": { + "element_property": true, + "exclusiveMinimum": 0, + "title": "Maximum number of participants supported by the virtual service", + "type": "integer" + }, + "resourceType": { + "const": "VirtualServiceDetail", + "default": "VirtualServiceDetail", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "sessionKey": { + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Session Key required by the virtual service", + "type": "string" + } + }, + "title": "VirtualServiceDetail", + "type": "object" + }, + "ResearchStudy": { + "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudy", + "additionalProperties": false, + "description": "Investigation to increase healthcare-related patient-independent knowledge. A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future. [See https://hl7.org/fhir/R5/ResearchStudy.html]", + "links": [ + { + "href": "ResearchStudy/{id}", + "rel": "partOf", + "targetHints": { + "backref": [ + "partOf_research_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudy" + }, + "templatePointers": { + "id": "/partOf/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "DiagnosticReport/{id}", + "rel": "result_DiagnosticReport", + "targetHints": { + "backref": [ + "result_research_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReport" + }, + "templatePointers": { + "id": "/result/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "ResearchStudy/{id}", + "rel": "site_ResearchStudy", + "targetHints": { + "backref": [ + "site_research_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudy" + }, + "templatePointers": { + "id": "/site/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "site_Organization", + "targetHints": { + "backref": [ + "site_research_study" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/site/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ResearchStudyAssociatedParty/associatedParty", + "href": "Practitioner/{id}", + "rel": "associatedParty_party_Practitioner", + "targetHints": { + "backref": [ + "research_study_associated_party" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/associatedParty/-/party/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ResearchStudyAssociatedParty/associatedParty", + "href": "PractitionerRole/{id}", + "rel": "associatedParty_party_PractitionerRole", + "targetHints": { + "backref": [ + "research_study_associated_party" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/associatedParty/-/party/reference" + }, + "templateRequired": [ + "id" + ] }, - "resourceType": { - "const": "VirtualServiceDetail", - "default": "VirtualServiceDetail", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + { + "$comment": "From ResearchStudyAssociatedParty/associatedParty", + "href": "Organization/{id}", + "rel": "associatedParty_party_Organization", + "targetHints": { + "backref": [ + "research_study_associated_party" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/associatedParty/-/party/reference" + }, + "templateRequired": [ + "id" + ] }, - "sessionKey": { - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Session Key required by the virtual service", - "type": "string" - } - }, - "title": "VirtualServiceDetail", - "type": "object" - }, - "ResearchStudy": { - "$id": "http://graph-fhir.io/schema/0.0.2/ResearchStudy", - "additionalProperties": false, - "description": "Investigation to increase healthcare-related patient-independent knowledge. A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future. [See https://hl7.org/fhir/R5/ResearchStudy.html]", - "links": [ { - "href": "ResearchStudy/{id}", - "rel": "partOf", + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", "targetHints": { "backref": [ - "partOf_research_study" + "annotation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudy" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/partOf/-/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" ] }, { - "href": "ResearchStudy/{id}", - "rel": "site_ResearchStudy", + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", "targetHints": { "backref": [ - "site_research_study" + "annotation" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudy" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/site/-/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" @@ -17833,6 +23038,31 @@ "id" ] }, + { + "$comment": "From Annotation/note", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/note/-/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From RelatedArtifact/relatedArtifact", "href": "Resource/{id}", @@ -18428,6 +23658,7 @@ "$id": "http://graph-fhir.io/schema/0.0.2/EncounterReason", "additionalProperties": false, "description": "The list of medical reasons that are expected to be addressed during the episode of care. [See https://hl7.org/fhir/R5/EncounterReason.html]", + "links": [], "properties": { "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", @@ -18460,6 +23691,12 @@ "title": "Unique id for inter-element referencing", "type": "string" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -18507,24 +23744,168 @@ "items": { "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableReference" }, - "title": "Reason the encounter takes place (core or reference)", - "type": "array" - } - }, - "title": "EncounterReason", - "type": "object" - }, - "Signature": { - "$id": "http://graph-fhir.io/schema/0.0.2/Signature", - "additionalProperties": false, - "description": "A Signature - XML DigSig, JWS, Graphical image of signature, etc.. A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities. [See https://hl7.org/fhir/R5/Signature.html]", - "links": [ + "title": "Reason the encounter takes place (core or reference)", + "type": "array" + } + }, + "title": "EncounterReason", + "type": "object" + }, + "Signature": { + "$id": "http://graph-fhir.io/schema/0.0.2/Signature", + "additionalProperties": false, + "description": "A Signature - XML DigSig, JWS, Graphical image of signature, etc.. A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities. [See https://hl7.org/fhir/R5/Signature.html]", + "links": [ + { + "href": "Practitioner/{id}", + "rel": "onBehalfOf_Practitioner", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "onBehalfOf_PractitionerRole", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "onBehalfOf_Patient", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Organization/{id}", + "rel": "onBehalfOf_Organization", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Practitioner/{id}", + "rel": "who_Practitioner", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/who/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "PractitionerRole/{id}", + "rel": "who_PractitionerRole", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/who/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Patient/{id}", - "rel": "onBehalfOf_Patient", + "rel": "who_Patient", "targetHints": { "backref": [ - "onBehalfOf_signature" + "who_signature" ], "direction": [ "outbound" @@ -18537,15 +23918,15 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/onBehalfOf/reference" + "id": "/who/reference" }, "templateRequired": [ "id" ] }, { - "href": "Patient/{id}", - "rel": "who_Patient", + "href": "Organization/{id}", + "rel": "who_Organization", "targetHints": { "backref": [ "who_signature" @@ -18558,7 +23939,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { "id": "/who/reference" @@ -18901,89 +24282,6 @@ "title": "Dosage", "type": "object" }, - "ImmunizationPerformer": { - "$id": "http://graph-fhir.io/schema/0.0.2/ImmunizationPerformer", - "additionalProperties": false, - "description": "Who performed event. Indicates who performed the immunization event. [See https://hl7.org/fhir/R5/ImmunizationPerformer.html]", - "properties": { - "actor": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Reference", - "backref": "immunization_performer", - "description": "The practitioner or organization who performed the action.", - "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "Patient", - "RelatedPerson" - ], - "title": "Individual or organization who was performing" - }, - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "function": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-function", - "binding_version": null, - "description": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).", - "element_property": true, - "title": "What type of performance was done" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "resourceType": { - "const": "ImmunizationPerformer", - "default": "ImmunizationPerformer", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "required": [ - "actor" - ], - "title": "ImmunizationPerformer", - "type": "object" - }, "PatientCommunication": { "$id": "http://graph-fhir.io/schema/0.0.2/PatientCommunication", "additionalProperties": false, @@ -19056,55 +24354,204 @@ "title": "Language preference indicator", "type": "boolean" }, - "resourceType": { - "const": "PatientCommunication", - "default": "PatientCommunication", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "required": [ - "language" - ], - "title": "PatientCommunication", - "type": "object" - }, - "Specimen": { - "$id": "http://graph-fhir.io/schema/0.0.2/Specimen", - "additionalProperties": false, - "description": "Sample for analysis. A sample to be used for analysis. [See https://hl7.org/fhir/R5/Specimen.html]", - "links": [ + "resourceType": { + "const": "PatientCommunication", + "default": "PatientCommunication", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "required": [ + "language" + ], + "title": "PatientCommunication", + "type": "object" + }, + "Specimen": { + "$id": "http://graph-fhir.io/schema/0.0.2/Specimen", + "additionalProperties": false, + "description": "Sample for analysis. A sample to be used for analysis. [See https://hl7.org/fhir/R5/Specimen.html]", + "links": [ + { + "href": "Specimen/{id}", + "rel": "parent", + "targetHints": { + "backref": [ + "parent_specimen" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" + }, + "templatePointers": { + "id": "/parent/-/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Patient/{id}", + "rel": "subject_Patient", + "targetHints": { + "backref": [ + "specimen" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "href": "Substance/{id}", + "rel": "subject_Substance", + "targetHints": { + "backref": [ + "specimen" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Substance" + }, + "templatePointers": { + "id": "/subject/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From SpecimenCollection/collection", + "href": "Practitioner/{id}", + "rel": "collection_collector_Practitioner", + "targetHints": { + "backref": [ + "specimen_collection" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/collection/collector/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From SpecimenCollection/collection", + "href": "PractitionerRole/{id}", + "rel": "collection_collector_PractitionerRole", + "targetHints": { + "backref": [ + "specimen_collection" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/collection/collector/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From SpecimenCollection/collection", + "href": "Patient/{id}", + "rel": "collection_collector_Patient", + "targetHints": { + "backref": [ + "specimen_collection" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/collection/collector/reference" + }, + "templateRequired": [ + "id" + ] + }, { - "href": "Specimen/{id}", - "rel": "parent", + "$comment": "From SpecimenCollection/collection", + "href": "Procedure/{id}", + "rel": "collection_procedure", "targetHints": { "backref": [ - "parent_specimen" + "specimen_collection" ], "direction": [ "outbound" ], "multiplicity": [ - "has_many" + "has_one" ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Specimen" + "$ref": "http://graph-fhir.io/schema/0.0.2/Procedure" }, "templatePointers": { - "id": "/parent/-/reference" + "id": "/collection/procedure/reference" }, "templateRequired": [ "id" ] }, { - "href": "Patient/{id}", - "rel": "subject_Patient", + "$comment": "From Annotation/note", + "href": "Practitioner/{id}", + "rel": "note_authorReference_Practitioner", "targetHints": { "backref": [ - "specimen" + "annotation" ], "direction": [ "outbound" @@ -19114,21 +24561,22 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/subject/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" ] }, { - "href": "Substance/{id}", - "rel": "subject_Substance", + "$comment": "From Annotation/note", + "href": "PractitionerRole/{id}", + "rel": "note_authorReference_PractitionerRole", "targetHints": { "backref": [ - "specimen" + "annotation" ], "direction": [ "outbound" @@ -19138,22 +24586,22 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Substance" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/subject/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From SpecimenCollection/collection", + "$comment": "From Annotation/note", "href": "Patient/{id}", - "rel": "collection_collector_Patient", + "rel": "note_authorReference_Patient", "targetHints": { "backref": [ - "specimen_collection" + "annotation" ], "direction": [ "outbound" @@ -19166,7 +24614,7 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" }, "templatePointers": { - "id": "/collection/collector/reference" + "id": "/note/-/authorReference/reference" }, "templateRequired": [ "id" @@ -19174,8 +24622,8 @@ }, { "$comment": "From Annotation/note", - "href": "Patient/{id}", - "rel": "note_authorReference_Patient", + "href": "Organization/{id}", + "rel": "note_authorReference_Organization", "targetHints": { "backref": [ "annotation" @@ -19188,7 +24636,7 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { "id": "/note/-/authorReference/reference" @@ -19737,13 +25185,238 @@ "additionalProperties": false, "description": "Optional Extensions Element. Optional Extension Element - found in all resources. [See https://hl7.org/fhir/R5/Extension.html]", "links": [ + { + "$comment": "From Annotation/valueAnnotation", + "href": "Practitioner/{id}", + "rel": "valueAnnotation_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/valueAnnotation", + "href": "PractitionerRole/{id}", + "rel": "valueAnnotation_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From Annotation/valueAnnotation", "href": "Patient/{id}", "rel": "valueAnnotation_authorReference_Patient", "targetHints": { "backref": [ - "annotation" + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/valueAnnotation", + "href": "Organization/{id}", + "rel": "valueAnnotation_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ExtendedContactDetail/valueExtendedContactDetail", + "href": "Organization/{id}", + "rel": "valueExtendedContactDetail_organization", + "targetHints": { + "backref": [ + "extended_contact_detail" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueExtendedContactDetail/organization/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From RelatedArtifact/valueRelatedArtifact", + "href": "Resource/{id}", + "rel": "valueRelatedArtifact_resourceReference", + "targetHints": { + "backref": [ + "related_artifact" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + }, + "templatePointers": { + "id": "/valueRelatedArtifact/resourceReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "Practitioner/{id}", + "rel": "valueSignature_onBehalfOf_Practitioner", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/valueSignature/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "PractitionerRole/{id}", + "rel": "valueSignature_onBehalfOf_PractitionerRole", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/valueSignature/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "Patient/{id}", + "rel": "valueSignature_onBehalfOf_Patient", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/valueSignature/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "Organization/{id}", + "rel": "valueSignature_onBehalfOf_Organization", + "targetHints": { + "backref": [ + "onBehalfOf_signature" ], "direction": [ "outbound" @@ -19753,22 +25426,22 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" }, "templatePointers": { - "id": "/valueAnnotation/authorReference/reference" + "id": "/valueSignature/onBehalfOf/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From RelatedArtifact/valueRelatedArtifact", - "href": "Resource/{id}", - "rel": "valueRelatedArtifact_resourceReference", + "$comment": "From Signature/valueSignature", + "href": "Practitioner/{id}", + "rel": "valueSignature_who_Practitioner", "targetHints": { "backref": [ - "related_artifact" + "who_signature" ], "direction": [ "outbound" @@ -19778,10 +25451,10 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/valueRelatedArtifact/resourceReference/reference" + "id": "/valueSignature/who/reference" }, "templateRequired": [ "id" @@ -19789,11 +25462,11 @@ }, { "$comment": "From Signature/valueSignature", - "href": "Patient/{id}", - "rel": "valueSignature_onBehalfOf_Patient", + "href": "PractitionerRole/{id}", + "rel": "valueSignature_who_PractitionerRole", "targetHints": { "backref": [ - "onBehalfOf_signature" + "who_signature" ], "direction": [ "outbound" @@ -19803,10 +25476,10 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/valueSignature/onBehalfOf/reference" + "id": "/valueSignature/who/reference" }, "templateRequired": [ "id" @@ -19837,6 +25510,31 @@ "id" ] }, + { + "$comment": "From Signature/valueSignature", + "href": "Organization/{id}", + "rel": "valueSignature_who_Organization", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueSignature/who/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From UsageContext/valueUsageContext", "href": "ResearchStudy/{id}", @@ -19861,6 +25559,31 @@ "templateRequired": [ "id" ] + }, + { + "$comment": "From UsageContext/valueUsageContext", + "href": "Organization/{id}", + "rel": "valueUsageContext_valueReference_Organization", + "targetHints": { + "backref": [ + "usage_context" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueUsageContext/valueReference/reference" + }, + "templateRequired": [ + "id" + ] } ], "properties": { @@ -20950,6 +26673,32 @@ "$id": "http://graph-fhir.io/schema/0.0.2/DiagnosticReportMedia", "additionalProperties": false, "description": "Key images or data associated with this report. A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). [See https://hl7.org/fhir/R5/DiagnosticReportMedia.html]", + "links": [ + { + "href": "DocumentReference/{id}", + "rel": "link", + "targetHints": { + "backref": [ + "diagnostic_report_media" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DocumentReference" + }, + "templatePointers": { + "id": "/link/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "_comment": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -21002,6 +26751,12 @@ ], "title": "Reference to the image or data source" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -21029,7 +26784,32 @@ "$id": "http://graph-fhir.io/schema/0.0.2/Identifier", "additionalProperties": false, "description": "An identifier intended for computation. An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. [See https://hl7.org/fhir/R5/Identifier.html]", - "links": [], + "links": [ + { + "href": "Organization/{id}", + "rel": "assigner", + "targetHints": { + "backref": [ + "identifier" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/assigner/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "_system": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -21243,6 +27023,7 @@ "$id": "http://graph-fhir.io/schema/0.0.2/BodyStructureIncludedStructure", "additionalProperties": false, "description": "Included anatomic location(s). The anatomical location(s) or region(s) of the specimen, lesion, or body structure. [See https://hl7.org/fhir/R5/BodyStructureIncludedStructure.html]", + "links": [], "properties": { "bodyLandmarkOrientation": { "description": "Body locations in relation to a specific body landmark (tatoo, scar, other body structure).", @@ -21293,6 +27074,12 @@ "element_property": true, "title": "Code that represents the included structure laterality" }, + "links": { + "items": { + "$ref": "https://json-schema.org/draft/2020-12/links" + }, + "type": "array" + }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "element_property": true, @@ -21356,12 +27143,162 @@ "description": "Information used to perform task. Additional information that may be needed in the execution of the task. [See https://hl7.org/fhir/R5/TaskInput.html]", "links": [ { - "$comment": "From Annotation/valueAnnotation", - "href": "Patient/{id}", - "rel": "valueAnnotation_authorReference_Patient", + "$comment": "From Annotation/valueAnnotation", + "href": "Practitioner/{id}", + "rel": "valueAnnotation_authorReference_Practitioner", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/valueAnnotation", + "href": "PractitionerRole/{id}", + "rel": "valueAnnotation_authorReference_PractitionerRole", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/valueAnnotation", + "href": "Patient/{id}", + "rel": "valueAnnotation_authorReference_Patient", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Annotation/valueAnnotation", + "href": "Organization/{id}", + "rel": "valueAnnotation_authorReference_Organization", + "targetHints": { + "backref": [ + "annotation" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueAnnotation/authorReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From ExtendedContactDetail/valueExtendedContactDetail", + "href": "Organization/{id}", + "rel": "valueExtendedContactDetail_organization", + "targetHints": { + "backref": [ + "extended_contact_detail" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueExtendedContactDetail/organization/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From RelatedArtifact/valueRelatedArtifact", + "href": "Resource/{id}", + "rel": "valueRelatedArtifact_resourceReference", + "targetHints": { + "backref": [ + "related_artifact" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + }, + "templatePointers": { + "id": "/valueRelatedArtifact/resourceReference/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "Practitioner/{id}", + "rel": "valueSignature_onBehalfOf_Practitioner", "targetHints": { "backref": [ - "annotation" + "onBehalfOf_signature" ], "direction": [ "outbound" @@ -21371,22 +27308,22 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Patient" + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" }, "templatePointers": { - "id": "/valueAnnotation/authorReference/reference" + "id": "/valueSignature/onBehalfOf/reference" }, "templateRequired": [ "id" ] }, { - "$comment": "From RelatedArtifact/valueRelatedArtifact", - "href": "Resource/{id}", - "rel": "valueRelatedArtifact_resourceReference", + "$comment": "From Signature/valueSignature", + "href": "PractitionerRole/{id}", + "rel": "valueSignature_onBehalfOf_PractitionerRole", "targetHints": { "backref": [ - "related_artifact" + "onBehalfOf_signature" ], "direction": [ "outbound" @@ -21396,10 +27333,10 @@ ] }, "targetSchema": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" }, "templatePointers": { - "id": "/valueRelatedArtifact/resourceReference/reference" + "id": "/valueSignature/onBehalfOf/reference" }, "templateRequired": [ "id" @@ -21430,6 +27367,81 @@ "id" ] }, + { + "$comment": "From Signature/valueSignature", + "href": "Organization/{id}", + "rel": "valueSignature_onBehalfOf_Organization", + "targetHints": { + "backref": [ + "onBehalfOf_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueSignature/onBehalfOf/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "Practitioner/{id}", + "rel": "valueSignature_who_Practitioner", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Practitioner" + }, + "templatePointers": { + "id": "/valueSignature/who/reference" + }, + "templateRequired": [ + "id" + ] + }, + { + "$comment": "From Signature/valueSignature", + "href": "PractitionerRole/{id}", + "rel": "valueSignature_who_PractitionerRole", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/PractitionerRole" + }, + "templatePointers": { + "id": "/valueSignature/who/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From Signature/valueSignature", "href": "Patient/{id}", @@ -21455,6 +27467,31 @@ "id" ] }, + { + "$comment": "From Signature/valueSignature", + "href": "Organization/{id}", + "rel": "valueSignature_who_Organization", + "targetHints": { + "backref": [ + "who_signature" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueSignature/who/reference" + }, + "templateRequired": [ + "id" + ] + }, { "$comment": "From UsageContext/valueUsageContext", "href": "ResearchStudy/{id}", @@ -21479,6 +27516,31 @@ "templateRequired": [ "id" ] + }, + { + "$comment": "From UsageContext/valueUsageContext", + "href": "Organization/{id}", + "rel": "valueUsageContext_valueReference_Organization", + "targetHints": { + "backref": [ + "usage_context" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/valueUsageContext/valueReference/reference" + }, + "templateRequired": [ + "id" + ] } ], "properties": { @@ -22089,7 +28151,32 @@ "$id": "http://graph-fhir.io/schema/0.0.2/Medication", "additionalProperties": false, "description": "Definition of a Medication. This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. [See https://hl7.org/fhir/R5/Medication.html]", - "links": [], + "links": [ + { + "href": "Organization/{id}", + "rel": "marketingAuthorizationHolder", + "targetHints": { + "backref": [ + "medication" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_one" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/Organization" + }, + "templatePointers": { + "id": "/marketingAuthorizationHolder/reference" + }, + "templateRequired": [ + "id" + ] + } + ], "properties": { "_implicitRules": { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension", @@ -22920,86 +29007,6 @@ "title": "ContactPoint", "type": "object" }, - "ImmunizationProgramEligibility": { - "$id": "http://graph-fhir.io/schema/0.0.2/ImmunizationProgramEligibility", - "additionalProperties": false, - "description": "Patient eligibility for a specific vaccination program. Indicates a patient's eligibility for a funding program. [See https://hl7.org/fhir/R5/ImmunizationProgramEligibility.html]", - "properties": { - "extension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "fhir_comments": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], - "element_property": false, - "title": "Fhir Comments" - }, - "id": { - "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Unique id for inter-element referencing", - "type": "string" - }, - "modifierExtension": { - "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", - "element_property": true, - "items": { - "$ref": "http://graph-fhir.io/schema/0.0.2/Extension" - }, - "title": "Extensions that cannot be ignored even if unrecognized", - "type": "array" - }, - "program": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program", - "binding_version": null, - "description": "Indicates which program the patient had their eligility evaluated for.", - "element_property": true, - "title": "The program that eligibility is declared for" - }, - "programStatus": { - "$ref": "http://graph-fhir.io/schema/0.0.2/CodeableConcept", - "binding_description": "x", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/immunization-program-eligibility", - "binding_version": null, - "description": "Indicates the patient's eligility status for for a specific payment program.", - "element_property": true, - "title": "The patient's eligibility status for the program" - }, - "resourceType": { - "const": "ImmunizationProgramEligibility", - "default": "ImmunizationProgramEligibility", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - } - }, - "required": [ - "program", - "programStatus" - ], - "title": "ImmunizationProgramEligibility", - "type": "object" - }, "Age": { "$id": "http://graph-fhir.io/schema/0.0.2/Age", "additionalProperties": false, @@ -23124,6 +29131,30 @@ "additionalProperties": false, "description": "Stage/grade, usually assessed formally. A simple summary of the stage such as \"Stage 3\" or \"Early Onset\". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease. [See https://hl7.org/fhir/R5/ConditionStage.html]", "links": [ + { + "href": "DiagnosticReport/{id}", + "rel": "assessment_DiagnosticReport", + "targetHints": { + "backref": [ + "assessment_condition_stage" + ], + "direction": [ + "outbound" + ], + "multiplicity": [ + "has_many" + ] + }, + "targetSchema": { + "$ref": "http://graph-fhir.io/schema/0.0.2/DiagnosticReport" + }, + "templatePointers": { + "id": "/assessment/-/reference" + }, + "templateRequired": [ + "id" + ] + }, { "href": "Observation/{id}", "rel": "assessment_Observation", @@ -24120,6 +30151,9 @@ { "$ref": "http://graph-fhir.io/schema/0.0.2/DocumentReference" }, + { + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeriesPerformer" + }, { "$ref": "http://graph-fhir.io/schema/0.0.2/TaskPerformer" }, @@ -24204,9 +30238,6 @@ { "$ref": "http://graph-fhir.io/schema/0.0.2/ConditionParticipant" }, - { - "$ref": "http://graph-fhir.io/schema/0.0.2/Immunization" - }, { "$ref": "http://graph-fhir.io/schema/0.0.2/FHIRPrimitiveExtension" }, @@ -24217,10 +30248,10 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementValueFilter" }, { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationReaction" + "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementSort" }, { - "$ref": "http://graph-fhir.io/schema/0.0.2/DataRequirementSort" + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeries" }, { "$ref": "http://graph-fhir.io/schema/0.0.2/MedicationStatement" @@ -24258,9 +30289,6 @@ { "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudyRecruitment" }, - { - "$ref": "http://graph-fhir.io/schema/0.0.2/Location" - }, { "$ref": "http://graph-fhir.io/schema/0.0.2/SpecimenCollection" }, @@ -24297,6 +30325,9 @@ { "$ref": "http://graph-fhir.io/schema/0.0.2/FamilyMemberHistoryCondition" }, + { + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudySeriesInstance" + }, { "$ref": "http://graph-fhir.io/schema/0.0.2/Resource" }, @@ -24321,9 +30352,6 @@ { "$ref": "http://graph-fhir.io/schema/0.0.2/ResearchStudyLabel" }, - { - "$ref": "http://graph-fhir.io/schema/0.0.2/LocationPosition" - }, { "$ref": "http://graph-fhir.io/schema/0.0.2/DocumentReferenceContentProfile" }, @@ -24343,13 +30371,13 @@ "$ref": "http://graph-fhir.io/schema/0.0.2/Distance" }, { - "$ref": "http://graph-fhir.io/schema/0.0.2/BodyStructure" + "$ref": "http://graph-fhir.io/schema/0.0.2/ImagingStudy" }, { - "$ref": "http://graph-fhir.io/schema/0.0.2/ObservationComponent" + "$ref": "http://graph-fhir.io/schema/0.0.2/BodyStructure" }, { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationProtocolApplied" + "$ref": "http://graph-fhir.io/schema/0.0.2/ObservationComponent" }, { "$ref": "http://graph-fhir.io/schema/0.0.2/Address" @@ -24417,9 +30445,6 @@ { "$ref": "http://graph-fhir.io/schema/0.0.2/Dosage" }, - { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationPerformer" - }, { "$ref": "http://graph-fhir.io/schema/0.0.2/PatientCommunication" }, @@ -24477,9 +30502,6 @@ { "$ref": "http://graph-fhir.io/schema/0.0.2/ContactPoint" }, - { - "$ref": "http://graph-fhir.io/schema/0.0.2/ImmunizationProgramEligibility" - }, { "$ref": "http://graph-fhir.io/schema/0.0.2/Age" }, diff --git a/schemas/simplified/body_structure.yaml b/schemas/simplified/body_structure.yaml new file mode 100644 index 0000000..425d9e0 --- /dev/null +++ b/schemas/simplified/body_structure.yaml @@ -0,0 +1,162 @@ +$schema: http://json-schema.org/draft-04/schema# +additionalProperties: true +category: Clinical +description: Specific and identified anatomical structure. Record details about an + anatomical structure. This resource may be used when a coded concept does not provide + the necessary detail needed for the use case. [See https://hl7.org/fhir/R5/BodyStructure.html] +id: body_structure +links: +- backref: body_structure + label: BodyStructure_patient_Patient_body_structure + multiplicity: many_to_many + name: patient + required: false + target_type: patient +program: '*' +project: '*' +properties: + active: + description: Whether this body site is in active use. + element_property: true + title: Whether this record is in active use + type: boolean + description: + description: A summary, characterization or explanation of the body structure. + element_property: true + pattern: \s*(\S|\s)* + title: Text description + type: string + excludedStructure: + description: '[Text representation of BodyStructureIncludedStructure] The anatomical + location(s) or region(s) not occupied or represented by the specimen, lesion, + or body structure.' + element_property: true + items: + type: string + title: Excluded anatomic locations(s) + type: array + extension: + description: '[Text representation of Extension] May be used to represent additional + information that is not part of the basic definition of the resource. To make + the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension.' + element_property: true + items: + type: string + title: Additional content defined by implementations + type: array + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: Identifier for this instance of the anatomical structure. + element_property: true + items: + type: string + title: Bodystructure identifier + type: array + identifier_coding: + description: '[system#code representation of identifier] Identifier for this instance + of the anatomical structure.' + element_property: true + items: + type: string + title: Bodystructure identifier + type: array + identifier_text_coding: + description: '[system#code representation of identifier.text] Identifier for this + instance of the anatomical structure.' + element_property: true + items: + type: string + title: Bodystructure identifier + type: array + image: + description: '[Text representation of Attachment] Image or images used to identify + a location.' + element_property: true + items: + type: string + title: Attached images + type: array + includedStructure: + description: '[Text representation of BodyStructureIncludedStructure] The anatomical + location(s) or region(s) of the specimen, lesion, or body structure.' + element_property: true + items: + type: string + title: Included anatomic location(s) + type: array + morphology: + binding_description: Codes describing anatomic morphology. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/bodystructure-code + binding_version: null + description: text representation. The kind of structure being represented by the + body structure at `BodyStructure.location`. This can define both normal and + abnormal morphologies. + element_property: true + term: + description: Codes describing anatomic morphology. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/bodystructure-code + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/bodystructure-code + term_url: http://hl7.org/fhir/ValueSet/bodystructure-code + title: Kind of Structure + type: string + morphology_coding: &id001 + binding_description: Codes describing anatomic morphology. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/bodystructure-code + binding_version: null + description: '[system#code representation.] The kind of structure being represented + by the body structure at `BodyStructure.location`. This can define both normal + and abnormal morphologies.' + element_property: true + term: + description: Codes describing anatomic morphology. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/bodystructure-code + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/bodystructure-code + term_url: http://hl7.org/fhir/ValueSet/bodystructure-code + title: Kind of Structure + type: string + morphology_text: *id001 + patient: + backref: body_structure + description: '[Text representation of Reference] The person to which the body + site belongs.' + element_property: true + enum_reference_types: + - Patient + title: Who this is about + type: string + project_id: + term: + $ref: _terms.yaml#/project_id + type: string + resourceType: + const: BodyStructure + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string +systemProperties: +- id +title: BodyStructure +type: object +uniqueKeys: +- - id diff --git a/schemas/simplified/diagnostic_report.yaml b/schemas/simplified/diagnostic_report.yaml new file mode 100644 index 0000000..de392d7 --- /dev/null +++ b/schemas/simplified/diagnostic_report.yaml @@ -0,0 +1,474 @@ +$schema: http://json-schema.org/draft-04/schema# +additionalProperties: true +category: Clinical +description: A Diagnostic report - a combination of request information, atomic results, + images, interpretation, as well as formatted reports. The findings and interpretation + of diagnostic tests performed on patients, groups of patients, products, substances, + devices, and locations, and/or specimens derived from these. The report includes + clinical context such as requesting provider information, and some mix of atomic + results, images, textual and coded interpretations, and formatted representation + of diagnostic reports. The report also includes non-clinical context such as batch + analysis and stability reporting of products and substances. [See https://hl7.org/fhir/R5/DiagnosticReport.html] +id: diagnostic_report +links: +- backref: subject_diagnostic_report + label: DiagnosticReport_subject_Patient_subject_diagnostic_report + multiplicity: many_to_many + name: subject_Patient + required: false + target_type: patient +- backref: subject_diagnostic_report + label: DiagnosticReport_subject_Organization_subject_diagnostic_report + multiplicity: many_to_many + name: subject_Organization + required: false + target_type: organization +- backref: subject_diagnostic_report + label: DiagnosticReport_subject_Practitioner_subject_diagnostic_report + multiplicity: many_to_many + name: subject_Practitioner + required: false + target_type: practitioner +- backref: subject_diagnostic_report + label: DiagnosticReport_subject_Medication_subject_diagnostic_report + multiplicity: many_to_many + name: subject_Medication + required: false + target_type: medication +- backref: subject_diagnostic_report + label: DiagnosticReport_subject_Substance_subject_diagnostic_report + multiplicity: many_to_many + name: subject_Substance + required: false + target_type: substance +- backref: performer_diagnostic_report + label: DiagnosticReport_performer_PractitionerRole_performer_diagnostic_report + multiplicity: many_to_many + name: performer_PractitionerRole + required: false + target_type: practitioner_role +- backref: result_diagnostic_report + label: DiagnosticReport_result_Observation_result_diagnostic_report + multiplicity: many_to_many + name: result + required: false + target_type: observation +- backref: specimen_diagnostic_report + label: DiagnosticReport_specimen_Specimen_specimen_diagnostic_report + multiplicity: many_to_many + name: specimen + required: false + target_type: specimen +- backref: study_diagnostic_report + label: DiagnosticReport_study_ImagingStudy_study_diagnostic_report + multiplicity: many_to_many + name: study_ImagingStudy + required: false + target_type: imaging_study +program: '*' +project: '*' +properties: + basedOn: + backref: basedOn_diagnostic_report + description: '[Text representation of Reference] Details concerning a service + requested.' + element_property: true + enum_reference_types: + - CarePlan + - ImmunizationRecommendation + - MedicationRequest + - NutritionOrder + - ServiceRequest + items: + type: string + title: What was requested + type: array + category: + binding_description: HL7 V2 table 0074 + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + binding_version: null + description: text representation. A code that classifies the clinical discipline, + department or diagnostic service that created the report (e.g. cardiology, biochemistry, + hematology, MRI). This is used for searching, sorting and display purposes. + element_property: true + items: + type: string + term: + description: HL7 V2 table 0074 + termDef: + cde_id: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + term_url: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + title: Service category + type: array + category_coding: &id001 + binding_description: HL7 V2 table 0074 + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + binding_version: null + description: '[system#code representation.] A code that classifies the clinical + discipline, department or diagnostic service that created the report (e.g. cardiology, + biochemistry, hematology, MRI). This is used for searching, sorting and display + purposes.' + element_property: true + items: + type: string + term: + description: HL7 V2 table 0074 + termDef: + cde_id: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + term_url: http://hl7.org/fhir/ValueSet/diagnostic-service-sections + title: Service category + type: array + category_text: *id001 + code: + binding_description: LOINC Codes for Diagnostic Reports + binding_strength: preferred + binding_uri: http://hl7.org/fhir/ValueSet/report-codes + binding_version: null + description: text representation. A code or name that describes this diagnostic + report. + element_property: true + term: + description: LOINC Codes for Diagnostic Reports + termDef: + cde_id: http://hl7.org/fhir/ValueSet/report-codes + cde_version: null + source: fhir + strength: preferred + term: http://hl7.org/fhir/ValueSet/report-codes + term_url: http://hl7.org/fhir/ValueSet/report-codes + title: Name/Code for this diagnostic report + type: string + code_coding: &id002 + binding_description: LOINC Codes for Diagnostic Reports + binding_strength: preferred + binding_uri: http://hl7.org/fhir/ValueSet/report-codes + binding_version: null + description: '[system#code representation.] A code or name that describes this + diagnostic report.' + element_property: true + term: + description: LOINC Codes for Diagnostic Reports + termDef: + cde_id: http://hl7.org/fhir/ValueSet/report-codes + cde_version: null + source: fhir + strength: preferred + term: http://hl7.org/fhir/ValueSet/report-codes + term_url: http://hl7.org/fhir/ValueSet/report-codes + title: Name/Code for this diagnostic report + type: string + code_text: *id002 + composition: + backref: diagnostic_report + description: '[Text representation of Reference] Reference to a Composition resource + instance that provides structure for organizing the contents of the DiagnosticReport.' + element_property: true + enum_reference_types: + - Composition + title: Reference to a Composition resource for the DiagnosticReport structure + type: string + conclusion: + description: Concise and clinically contextualized summary conclusion (interpretation/impression) + of the diagnostic report. + element_property: true + pattern: \s*(\S|\s)* + title: Clinical conclusion (interpretation) of test results + type: string + conclusionCode: + binding_description: SNOMED CT Clinical Findings + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/clinical-findings + binding_version: null + description: text representation. One or more codes that represent the summary + conclusion (interpretation/impression) of the diagnostic report. + element_property: true + items: + type: string + term: + description: SNOMED CT Clinical Findings + termDef: + cde_id: http://hl7.org/fhir/ValueSet/clinical-findings + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/clinical-findings + term_url: http://hl7.org/fhir/ValueSet/clinical-findings + title: Codes for the clinical conclusion of test results + type: array + conclusionCode_coding: &id003 + binding_description: SNOMED CT Clinical Findings + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/clinical-findings + binding_version: null + description: '[system#code representation.] One or more codes that represent the + summary conclusion (interpretation/impression) of the diagnostic report.' + element_property: true + items: + type: string + term: + description: SNOMED CT Clinical Findings + termDef: + cde_id: http://hl7.org/fhir/ValueSet/clinical-findings + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/clinical-findings + term_url: http://hl7.org/fhir/ValueSet/clinical-findings + title: Codes for the clinical conclusion of test results + type: array + conclusionCode_text: *id003 + effectiveDateTime: + description: The time or time-period the observed values are related to. When + the subject of the report is a patient, this is usually either the time of the + procedure or of specimen collection(s), but very often the source of the date/time + is not known, only the date/time itself. + element_property: true + format: date-time + one_of_many: effective + one_of_many_required: false + title: Clinically relevant time/time-period for report + type: string + effectivePeriod: + description: '[Text representation of Period] The time or time-period the observed + values are related to. When the subject of the report is a patient, this is + usually either the time of the procedure or of specimen collection(s), but very + often the source of the date/time is not known, only the date/time itself.' + element_property: true + one_of_many: effective + one_of_many_required: false + title: Clinically relevant time/time-period for report + type: string + encounter: + backref: diagnostic_report + description: '[Text representation of Reference] The healthcare event (e.g. a + patient and healthcare provider interaction) which this DiagnosticReport is + about.' + element_property: true + enum_reference_types: + - Encounter + title: Health care event when test ordered + type: string + extension: + description: '[Text representation of Extension] May be used to represent additional + information that is not part of the basic definition of the resource. To make + the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension.' + element_property: true + items: + type: string + title: Additional content defined by implementations + type: array + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: Identifiers assigned to this report by the performer or other systems. + element_property: true + items: + type: string + title: Business identifier for report + type: array + identifier_coding: + description: '[system#code representation of identifier] Identifiers assigned + to this report by the performer or other systems.' + element_property: true + items: + type: string + title: Business identifier for report + type: array + identifier_text_coding: + description: '[system#code representation of identifier.text] Identifiers assigned + to this report by the performer or other systems.' + element_property: true + items: + type: string + title: Business identifier for report + type: array + issued: + description: The date and time that this version of the report was made available + to providers, typically after the report was reviewed and verified. + element_property: true + format: date-time + title: DateTime this version was made + type: string + media: + description: '[Text representation of DiagnosticReportMedia] A list of key images + or data associated with this report. The images or data are generally created + during the diagnostic process, and may be directly of the patient, or of treated + specimens (i.e. slides of interest).' + element_property: true + items: + type: string + title: Key images or data associated with this report + type: array + note: + description: '[Text representation of Annotation] Comments about the diagnostic + report' + element_property: true + items: + type: string + title: Comments about the diagnostic report + type: array + performer: + backref: performer_diagnostic_report + description: '[Text representation of Reference] The diagnostic service that is + responsible for issuing the report.' + element_property: true + enum_reference_types: + - Practitioner + - PractitionerRole + - Organization + - CareTeam + items: + type: string + title: Responsible Diagnostic Service + type: array + presentedForm: + description: '[Text representation of Attachment] Rich text representation of + the entire result as issued by the diagnostic service. Multiple formats are + allowed but they SHALL be semantically equivalent.' + element_property: true + items: + type: string + title: Entire report as issued + type: array + project_id: + term: + $ref: _terms.yaml#/project_id + type: string + resourceType: + const: DiagnosticReport + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + result: + backref: result_diagnostic_report + description: '[Text representation of Reference] [Observations](observation.html) that + are part of this diagnostic report.' + element_property: true + enum_reference_types: + - Observation + items: + type: string + title: Observations + type: array + resultsInterpreter: + backref: resultsInterpreter_diagnostic_report + description: '[Text representation of Reference] The practitioner or organization + that is responsible for the report''s conclusions and interpretations.' + element_property: true + enum_reference_types: + - Practitioner + - PractitionerRole + - Organization + - CareTeam + items: + type: string + title: Primary result interpreter + type: array + specimen: + backref: specimen_diagnostic_report + description: '[Text representation of Reference] Details about the specimens on + which this diagnostic report is based.' + element_property: true + enum_reference_types: + - Specimen + items: + type: string + title: Specimens this report is based on + type: array + status: + binding_description: The status of the diagnostic report. + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/diagnostic-report-status + binding_version: 5.0.0 + description: The status of the diagnostic report. + element_property: true + element_required: true + enum_values: + - registered + - partial + - preliminary + - modified + - final + - amended + - corrected + - appended + - cancelled + - entered-in-error + - unknown + pattern: ^[^\s]+(\s[^\s]+)*$ + title: registered | partial | preliminary | modified | final | amended | corrected + | appended | cancelled | entered-in-error | unknown + type: string + study: + backref: study_diagnostic_report + description: '[Text representation of Reference] One or more links to full details + of any study performed during the diagnostic investigation. An ImagingStudy + might comprise a set of radiologic images obtained via a procedure that are + analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, + but this is not required. A fully enabled PACS viewer can use this information + to provide views of the source images. A GenomicStudy might comprise one or + more analyses, each serving a specific purpose. These analyses may vary in method + (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, + or regions targeted.' + element_property: true + enum_reference_types: + - GenomicStudy + - ImagingStudy + items: + type: string + title: Reference to full details of an analysis associated with the diagnostic + report + type: array + subject: + backref: subject_diagnostic_report + description: '[Text representation of Reference] The subject of the report. Usually, + but not always, this is a patient. However, diagnostic services also perform + analyses on specimens collected from a variety of other sources.' + element_property: true + enum_reference_types: + - Patient + - Group + - Device + - Location + - Organization + - Practitioner + - Medication + - Substance + - BiologicallyDerivedProduct + title: The subject of the report - usually, but not always, the patient + type: string + supportingInfo: + description: '[Text representation of DiagnosticReportSupportingInfo] This backbone + element contains supporting information that was used in the creation of the + report not included in the results already included in the report.' + element_property: true + items: + type: string + title: Additional information supporting the diagnostic report + type: array +systemProperties: +- id +title: DiagnosticReport +type: object +uniqueKeys: +- - id diff --git a/schemas/simplified/document_reference.yaml b/schemas/simplified/document_reference.yaml index 4133c05..8e3760a 100644 --- a/schemas/simplified/document_reference.yaml +++ b/schemas/simplified/document_reference.yaml @@ -468,6 +468,11 @@ properties: patient_id: description: Denormalized patient id type: string + patient_identifier: + description: Denormalized patient identifier + items: + type: string + type: array period: description: '[Text representation of Period] The time period over which the service that is described by the document was provided.' @@ -597,6 +602,11 @@ properties: title: Document security-tags type: array securityLabel_text: *id007 + specimen_identifier: + description: Denormalized specimen identifier + items: + type: string + type: array status: binding_description: The status of the document reference. binding_strength: required @@ -623,6 +633,11 @@ properties: - Observation title: The item that this DocumentReference is about. type: string + task_identifier: + description: Denormalized task identifier + items: + type: string + type: array type: binding_description: Precise type of clinical document. binding_strength: preferred diff --git a/schemas/simplified/family_member_history.yaml b/schemas/simplified/family_member_history.yaml index 04539ae..d50e26f 100644 --- a/schemas/simplified/family_member_history.yaml +++ b/schemas/simplified/family_member_history.yaml @@ -12,24 +12,6 @@ links: name: patient required: false target_type: patient -- backref: reason_family_member_history - label: FamilyMemberHistory_reason_Condition_reason_family_member_history - multiplicity: many_to_many - name: reason_Condition - required: false - target_type: condition -- backref: reason_family_member_history - label: FamilyMemberHistory_reason_Observation_reason_family_member_history - multiplicity: many_to_many - name: reason_Observation - required: false - target_type: observation -- backref: reason_family_member_history - label: FamilyMemberHistory_reason_DocumentReference_reason_family_member_history - multiplicity: many_to_many - name: reason_DocumentReference - required: false - target_type: document_reference program: '*' project: '*' properties: diff --git a/schemas/simplified/imaging_study.yaml b/schemas/simplified/imaging_study.yaml new file mode 100644 index 0000000..c2cd950 --- /dev/null +++ b/schemas/simplified/imaging_study.yaml @@ -0,0 +1,427 @@ +$schema: http://json-schema.org/draft-04/schema# +additionalProperties: true +category: Clinical +description: A set of images produced in single study (one or more series of references + images). Representation of the content produced in a DICOM imaging study. A study + comprises a set of series, each of which includes a set of Service-Object Pair Instances + (SOP Instances - images or other data) acquired or produced in a common context. A + series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may + have multiple series of different modalities. [See https://hl7.org/fhir/R5/ImagingStudy.html] +id: imaging_study +links: +- backref: imaging_study + label: ImagingStudy_subject_Patient_imaging_study + multiplicity: many_to_many + name: subject_Patient + required: false + target_type: patient +- backref: basedOn_imaging_study + label: ImagingStudy_basedOn_Task_basedOn_imaging_study + multiplicity: many_to_many + name: basedOn_Task + required: false + target_type: task +- backref: partOf_imaging_study + label: ImagingStudy_partOf_Procedure_partOf_imaging_study + multiplicity: many_to_many + name: partOf + required: false + target_type: procedure +- backref: reason_imaging_study + label: ImagingStudy_reason_Condition_reason_imaging_study + multiplicity: many_to_many + name: reason_Condition + required: false + target_type: condition +- backref: reason_imaging_study + label: ImagingStudy_reason_Observation_reason_imaging_study + multiplicity: many_to_many + name: reason_Observation + required: false + target_type: observation +- backref: reason_imaging_study + label: ImagingStudy_reason_DiagnosticReport_reason_imaging_study + multiplicity: many_to_many + name: reason_DiagnosticReport + required: false + target_type: diagnostic_report +- backref: reason_imaging_study + label: ImagingStudy_reason_DocumentReference_reason_imaging_study + multiplicity: many_to_many + name: reason_DocumentReference + required: false + target_type: document_reference +- backref: imaging_study + label: ImagingStudy_referrer_Practitioner_imaging_study + multiplicity: many_to_many + name: referrer_Practitioner + required: false + target_type: practitioner +- backref: imaging_study + label: ImagingStudy_referrer_PractitionerRole_imaging_study + multiplicity: many_to_many + name: referrer_PractitionerRole + required: false + target_type: practitioner_role +program: '*' +project: '*' +properties: + basedOn: + backref: basedOn_imaging_study + description: '[Text representation of Reference] A list of the diagnostic requests + that resulted in this imaging study being performed.' + element_property: true + enum_reference_types: + - CarePlan + - ServiceRequest + - Appointment + - AppointmentResponse + - Task + items: + type: string + title: Request fulfilled + type: array + description: + description: The Imaging Manager description of the study. Institution-generated + description or classification of the Study (component) performed. + element_property: true + pattern: '[ \r\n\t\S]+' + title: Institution-generated description + type: string + encounter: + backref: imaging_study + description: '[Text representation of Reference] The healthcare event (e.g. a + patient and healthcare provider interaction) during which this ImagingStudy + is made.' + element_property: true + enum_reference_types: + - Encounter + title: Encounter with which this imaging study is associated + type: string + endpoint: + backref: endpoint_imaging_study + description: '[Text representation of Reference] The network service providing + access (e.g., query, view, or retrieval) for the study. See implementation notes + for information about using DICOM endpoints. A study-level endpoint applies + to each series in the study, unless overridden by a series-level endpoint with + the same Endpoint.connectionType.' + element_property: true + enum_reference_types: + - Endpoint + items: + type: string + title: Study access endpoint + type: array + extension: + description: '[Text representation of Extension] May be used to represent additional + information that is not part of the basic definition of the resource. To make + the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension.' + element_property: true + items: + type: string + title: Additional content defined by implementations + type: array + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: Identifiers for the ImagingStudy such as DICOM Study Instance UID. + element_property: true + items: + type: string + title: Identifiers for the whole study + type: array + identifier_coding: + description: '[system#code representation of identifier] Identifiers for the ImagingStudy + such as DICOM Study Instance UID.' + element_property: true + items: + type: string + title: Identifiers for the whole study + type: array + identifier_text_coding: + description: '[system#code representation of identifier.text] Identifiers for + the ImagingStudy such as DICOM Study Instance UID.' + element_property: true + items: + type: string + title: Identifiers for the whole study + type: array + location: + backref: imaging_study + description: '[Text representation of Reference] The principal physical location + where the ImagingStudy was performed.' + element_property: true + enum_reference_types: + - Location + title: Where ImagingStudy occurred + type: string + modality: + binding_description: Type of acquired data in the instance. + binding_strength: extensible + binding_uri: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + binding_version: null + description: text representation. A list of all the distinct values of series.modality. + This may include both acquisition and non-acquisition modalities. + element_property: true + items: + type: string + term: + description: Type of acquired data in the instance. + termDef: + cde_id: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + cde_version: null + source: fhir + strength: extensible + term: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + term_url: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + title: All of the distinct values for series' modalities + type: array + modality_coding: &id001 + binding_description: Type of acquired data in the instance. + binding_strength: extensible + binding_uri: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + binding_version: null + description: '[system#code representation.] A list of all the distinct values + of series.modality. This may include both acquisition and non-acquisition modalities.' + element_property: true + items: + type: string + term: + description: Type of acquired data in the instance. + termDef: + cde_id: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + cde_version: null + source: fhir + strength: extensible + term: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + term_url: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html + title: All of the distinct values for series' modalities + type: array + modality_text: *id001 + note: + description: '[Text representation of Annotation] Per the recommended DICOM mapping, + this element is derived from the Study Description attribute (0008,1030). Observations + or findings about the imaging study should be recorded in another resource, + e.g. Observation, and not in this element.' + element_property: true + items: + type: string + title: User-defined comments + type: array + numberOfInstances: + description: Number of SOP Instances in Study. This value given may be larger + than the number of instance elements this resource contains due to resource + availability, security, or other factors. This element should be present if + any instance elements are present. + element_property: true + minimum: 0 + title: Number of Study Related Instances + type: integer + numberOfSeries: + description: Number of Series in the Study. This value given may be larger than + the number of series elements this Resource contains due to resource availability, + security, or other factors. This element should be present if any series elements + are present. + element_property: true + minimum: 0 + title: Number of Study Related Series + type: integer + partOf: + backref: partOf_imaging_study + description: '[Text representation of Reference] A larger event of which this + particular ImagingStudy is a component or step. For example, an ImagingStudy + as part of a procedure.' + element_property: true + enum_reference_types: + - Procedure + items: + type: string + title: Part of referenced event + type: array + procedure: + backref: procedure_imaging_study + binding_description: Use of RadLex is preferred + binding_strength: preferred + binding_uri: http://loinc.org/vs/loinc-rsna-radiology-playbook + binding_version: null + description: text representation. This field corresponds to the DICOM Procedure + Code Sequence (0008,1032). This is different from the FHIR Procedure resource + that may include the ImagingStudy. + element_property: true + enum_reference_types: + - PlanDefinition + - ActivityDefinition + items: + type: string + term: + description: Use of RadLex is preferred + termDef: + cde_id: http://loinc.org/vs/loinc-rsna-radiology-playbook + cde_version: null + source: fhir + strength: preferred + term: http://loinc.org/vs/loinc-rsna-radiology-playbook + term_url: http://loinc.org/vs/loinc-rsna-radiology-playbook + title: The performed procedure or code + type: array + procedure_coding: &id002 + backref: procedure_imaging_study + binding_description: Use of RadLex is preferred + binding_strength: preferred + binding_uri: http://loinc.org/vs/loinc-rsna-radiology-playbook + binding_version: null + description: '[system#code representation.] This field corresponds to the DICOM + Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure + resource that may include the ImagingStudy.' + element_property: true + enum_reference_types: + - PlanDefinition + - ActivityDefinition + items: + type: string + term: + description: Use of RadLex is preferred + termDef: + cde_id: http://loinc.org/vs/loinc-rsna-radiology-playbook + cde_version: null + source: fhir + strength: preferred + term: http://loinc.org/vs/loinc-rsna-radiology-playbook + term_url: http://loinc.org/vs/loinc-rsna-radiology-playbook + title: The performed procedure or code + type: array + procedure_text: *id002 + project_id: + term: + $ref: _terms.yaml#/project_id + type: string + reason: + backref: reason_imaging_study + binding_description: The reason for the study. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-reason + binding_version: null + description: text representation. Description of clinical condition indicating + why the ImagingStudy was requested, and/or Indicates another resource whose + existence justifies this Study. + element_property: true + enum_reference_types: + - Condition + - Observation + - DiagnosticReport + - DocumentReference + items: + type: string + term: + description: The reason for the study. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-reason + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-reason + term_url: http://hl7.org/fhir/ValueSet/procedure-reason + title: Why the study was requested / performed + type: array + reason_coding: &id003 + backref: reason_imaging_study + binding_description: The reason for the study. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-reason + binding_version: null + description: '[system#code representation.] Description of clinical condition + indicating why the ImagingStudy was requested, and/or Indicates another resource + whose existence justifies this Study.' + element_property: true + enum_reference_types: + - Condition + - Observation + - DiagnosticReport + - DocumentReference + items: + type: string + term: + description: The reason for the study. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-reason + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-reason + term_url: http://hl7.org/fhir/ValueSet/procedure-reason + title: Why the study was requested / performed + type: array + reason_text: *id003 + referrer: + backref: imaging_study + description: '[Text representation of Reference] The requesting/referring physician.' + element_property: true + enum_reference_types: + - Practitioner + - PractitionerRole + title: Referring physician + type: string + resourceType: + const: ImagingStudy + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + series: + description: '[Text representation of ImagingStudySeries] Each study has one or + more series of images or other content.' + element_property: true + items: + type: string + title: Each study has one or more series of instances + type: array + started: + description: Date and time the study started. + element_property: true + format: date-time + title: When the study was started + type: string + status: + binding_description: The status of the ImagingStudy. + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/imagingstudy-status + binding_version: 5.0.0 + description: The current state of the ImagingStudy resource. This is not the status + of any ServiceRequest or Task resources associated with the ImagingStudy. + element_property: true + element_required: true + enum_values: + - registered + - available + - cancelled + - entered-in-error + - unknown + pattern: ^[^\s]+(\s[^\s]+)*$ + title: registered | available | cancelled | entered-in-error | unknown + type: string + subject: + backref: imaging_study + description: '[Text representation of Reference] The subject, typically a patient, + of the imaging study.' + element_property: true + enum_reference_types: + - Patient + - Device + - Group + title: Who or what is the subject of the study + type: string +systemProperties: +- id +title: ImagingStudy +type: object +uniqueKeys: +- - id diff --git a/schemas/simplified/medication.yaml b/schemas/simplified/medication.yaml index 67d094c..eb16335 100644 --- a/schemas/simplified/medication.yaml +++ b/schemas/simplified/medication.yaml @@ -6,7 +6,25 @@ description: Definition of a Medication. This resource is primarily used for the dispensing, and administering a medication as well as for making statements about medication use. [See https://hl7.org/fhir/R5/Medication.html] id: medication -links: [] +links: +- backref: medication + label: Medication_marketingAuthorizationHolder_Organization_medication + multiplicity: many_to_many + name: marketingAuthorizationHolder + required: false + target_type: organization +- backref: medication_ingredient + label: Medication_ingredient_item_Substance_medication_ingredient + multiplicity: many_to_many + name: ingredient_item_Substance + required: false + target_type: substance +- backref: medication_ingredient + label: Medication_ingredient_item_Medication_medication_ingredient + multiplicity: many_to_many + name: ingredient_item_Medication + required: false + target_type: medication program: '*' project: '*' properties: @@ -153,14 +171,32 @@ properties: type: string title: Business identifier for this medication type: array - ingredient: - description: '[Text representation of MedicationIngredient] Identifies a particular - constituent of interest in the product.' + ingredient_item: + backref: medication_ingredient + binding_description: null + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/medication-codes + binding_version: null + description: text representation. [Plucked from Medication.ingredient] The ingredient + (substance or medication) that the ingredient.strength relates to. This is + represented as a concept from a code system or described in another resource + (Substance or Medication). element_property: true - items: - type: string - title: Active or inactive ingredient - type: array + enum_reference_types: + - Substance + - Medication + term: + description: null + termDef: + cde_id: http://hl7.org/fhir/ValueSet/medication-codes + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/medication-codes + term_url: http://hl7.org/fhir/ValueSet/medication-codes + title: The ingredient (substance or medication) that the ingredient.strength relates + to + type: string marketingAuthorizationHolder: backref: medication description: '[Text representation of Reference] The company or other legal entity diff --git a/schemas/simplified/medication_administration.yaml b/schemas/simplified/medication_administration.yaml index 2f40d1a..00bf299 100644 --- a/schemas/simplified/medication_administration.yaml +++ b/schemas/simplified/medication_administration.yaml @@ -20,30 +20,6 @@ links: name: medication required: false target_type: medication -- backref: partOf_medication_administration - label: MedicationAdministration_partOf_MedicationAdministration_partOf_medication_administration - multiplicity: many_to_many - name: partOf_MedicationAdministration - required: false - target_type: medication_administration -- backref: reason_medication_administration - label: MedicationAdministration_reason_Condition_reason_medication_administration - multiplicity: many_to_many - name: reason_Condition - required: false - target_type: condition -- backref: reason_medication_administration - label: MedicationAdministration_reason_Observation_reason_medication_administration - multiplicity: many_to_many - name: reason_Observation - required: false - target_type: observation -- backref: medication_administration - label: MedicationAdministration_request_MedicationRequest_medication_administration - multiplicity: many_to_many - name: request - required: false - target_type: medication_request program: '*' project: '*' properties: diff --git a/schemas/simplified/observation.yaml b/schemas/simplified/observation.yaml index ad440a4..2ef7652 100644 --- a/schemas/simplified/observation.yaml +++ b/schemas/simplified/observation.yaml @@ -184,6 +184,11 @@ properties: type: string title: Component results type: array + condition_identifier: + description: Denormalized condition identifier + items: + type: string + type: array dataAbsentReason: binding_description: Codes specifying why the result (`Observation.value[x]`) is missing. @@ -518,6 +523,11 @@ properties: type: string title: Part of referenced event type: array + patient_identifier: + description: Denormalized patient identifier + items: + type: string + type: array performer: backref: performer_observation description: '[Text representation of Reference] Who was responsible for asserting @@ -563,6 +573,11 @@ properties: - Group title: Specimen used for this observation type: string + specimen_identifier: + description: Denormalized specimen identifier + items: + type: string + type: array status: binding_description: Codes providing the status of an observation. binding_strength: required diff --git a/schemas/simplified/organization.yaml b/schemas/simplified/organization.yaml new file mode 100644 index 0000000..6e872f7 --- /dev/null +++ b/schemas/simplified/organization.yaml @@ -0,0 +1,193 @@ +$schema: http://json-schema.org/draft-04/schema# +additionalProperties: true +category: Administrative +description: A grouping of people or organizations with a common purpose. A formally + or informally recognized grouping of people or organizations formed for the purpose + of achieving some form of collective action. Includes companies, institutions, corporations, + departments, community groups, healthcare practice groups, payer/insurer, etc. [See + https://hl7.org/fhir/R5/Organization.html] +id: organization +links: +- backref: organization + label: Organization_partOf_Organization_organization + multiplicity: many_to_many + name: partOf + required: false + target_type: organization +program: '*' +project: '*' +properties: + active: + description: Whether the organization's record is still in active use + element_property: true + title: Whether the organization's record is still in active use + type: boolean + alias: + description: A list of alternate names that the organization is known as, or was + known as in the past + element_property: true + items: + pattern: '[ \r\n\t\S]+' + type: string + title: A list of alternate names that the organization is known as, or was known + as in the past + type: array + contact: + description: '[Text representation of ExtendedContactDetail] The contact details + of communication devices available relevant to the specific Organization. This + can include addresses, phone numbers, fax numbers, mobile numbers, email addresses + and web sites.' + element_property: true + items: + type: string + title: Official contact details for the Organization + type: array + description: + description: Description of the organization, which helps provide additional general + context on the organization to ensure that the correct organization is selected. + element_property: true + pattern: \s*(\S|\s)* + title: Additional details about the Organization that could be displayed as further + information to identify the Organization beyond its name + type: string + endpoint: + backref: endpoint_organization + description: '[Text representation of Reference] Technical endpoints providing + access to services operated for the organization' + element_property: true + enum_reference_types: + - Endpoint + items: + type: string + title: Technical endpoints providing access to services operated for the organization + type: array + extension: + description: '[Text representation of Extension] May be used to represent additional + information that is not part of the basic definition of the resource. To make + the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension.' + element_property: true + items: + type: string + title: Additional content defined by implementations + type: array + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: Identifier for the organization that is used to identify the organization + across multiple disparate systems. + element_property: true + items: + type: string + title: Identifies this organization across multiple systems + type: array + identifier_coding: + description: '[system#code representation of identifier] Identifier for the organization + that is used to identify the organization across multiple disparate systems.' + element_property: true + items: + type: string + title: Identifies this organization across multiple systems + type: array + identifier_text_coding: + description: '[system#code representation of identifier.text] Identifier for the + organization that is used to identify the organization across multiple disparate + systems.' + element_property: true + items: + type: string + title: Identifies this organization across multiple systems + type: array + name: + description: A name associated with the organization. + element_property: true + pattern: '[ \r\n\t\S]+' + title: Name used for the organization + type: string + partOf: + backref: organization + description: '[Text representation of Reference] The organization of which this + organization forms a part' + element_property: true + enum_reference_types: + - Organization + title: The organization of which this organization forms a part + type: string + project_id: + term: + $ref: _terms.yaml#/project_id + type: string + qualification: + description: '[Text representation of OrganizationQualification] The official + certifications, accreditations, training, designations and licenses that authorize + and/or otherwise endorse the provision of care by the organization. For example, + an approval to provide a type of services issued by a certifying body (such + as the US Joint Commission) to an organization.' + element_property: true + items: + type: string + title: Qualifications, certifications, accreditations, licenses, training, etc. + pertaining to the provision of care + type: array + resourceType: + const: Organization + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + type: + binding_description: Used to categorize the organization. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/organization-type + binding_version: null + description: text representation. The kind(s) of organization that this is. + element_property: true + items: + type: string + term: + description: Used to categorize the organization. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/organization-type + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/organization-type + term_url: http://hl7.org/fhir/ValueSet/organization-type + title: Kind of organization + type: array + type_coding: &id001 + binding_description: Used to categorize the organization. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/organization-type + binding_version: null + description: '[system#code representation.] The kind(s) of organization that this + is.' + element_property: true + items: + type: string + term: + description: Used to categorize the organization. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/organization-type + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/organization-type + term_url: http://hl7.org/fhir/ValueSet/organization-type + title: Kind of organization + type: array + type_text: *id001 +systemProperties: +- id +title: Organization +type: object +uniqueKeys: +- - id diff --git a/schemas/simplified/patient.yaml b/schemas/simplified/patient.yaml index 4ef4f2c..11e39bb 100644 --- a/schemas/simplified/patient.yaml +++ b/schemas/simplified/patient.yaml @@ -5,7 +5,25 @@ description: Information about an individual or animal receiving health care ser Demographics and other administrative information about an individual or animal receiving care or other health-related services. [See https://hl7.org/fhir/R5/Patient.html] id: patient -links: [] +links: +- backref: generalPractitioner_patient + label: Patient_generalPractitioner_Organization_generalPractitioner_patient + multiplicity: many_to_many + name: generalPractitioner_Organization + required: false + target_type: organization +- backref: generalPractitioner_patient + label: Patient_generalPractitioner_Practitioner_generalPractitioner_patient + multiplicity: many_to_many + name: generalPractitioner_Practitioner + required: false + target_type: practitioner +- backref: generalPractitioner_patient + label: Patient_generalPractitioner_PractitionerRole_generalPractitioner_patient + multiplicity: many_to_many + name: generalPractitioner_PractitionerRole + required: false + target_type: practitioner_role program: '*' project: '*' properties: @@ -225,6 +243,18 @@ properties: The registered place of birth of the patient. A sytem may use the address.text if they don''t store the birthPlace address in discrete elements.' type: string + patient_birthPlace_city: + description: nested + type: string + patient_birthPlace_country: + description: nested + type: string + patient_birthPlace_resourceType: + description: nested + type: string + patient_birthPlace_state: + description: nested + type: string patient_mothersMaidenName: description: '[extension patient_mothersMaidenName] Mother''s maiden (unmarried) name, commonly collected to help verify patient identity.' @@ -331,6 +361,14 @@ properties: term: http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category term_url: http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category type: string + us_core_ethnicity_ombCategory_coding: + description: extension + items: + type: string + type: array + us_core_ethnicity_text: + description: nested + type: string us_core_genderIdentity: binding_description: null binding_strength: extensible @@ -439,6 +477,14 @@ properties: term: http://hl7.org/fhir/us/core/ValueSet/omb-race-category term_url: http://hl7.org/fhir/us/core/ValueSet/omb-race-category type: string + us_core_race_ombCategory_coding: + description: extension + items: + type: string + type: array + us_core_race_text: + description: extension + type: string us_core_tribal_affiliation_isEnrolled: description: '[extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they diff --git a/schemas/simplified/practitioner.yaml b/schemas/simplified/practitioner.yaml new file mode 100644 index 0000000..e8f37a6 --- /dev/null +++ b/schemas/simplified/practitioner.yaml @@ -0,0 +1,169 @@ +$schema: http://json-schema.org/draft-04/schema# +additionalProperties: true +category: Administrative +description: A person with a formal responsibility in the provisioning of healthcare + or related services. A person who is directly or indirectly involved in the provisioning + of healthcare or related services. [See https://hl7.org/fhir/R5/Practitioner.html] +id: practitioner +links: [] +program: '*' +project: '*' +properties: + active: + description: Whether this practitioner's record is in active use + element_property: true + title: Whether this practitioner's record is in active use + type: boolean + address: + description: '[Text representation of Address] Address(es) of the practitioner + that are not role specific (typically home address). Work addresses are not + typically entered in this property as they are usually role dependent.' + element_property: true + items: + type: string + title: Address(es) of the practitioner that are not role specific (typically home + address) + type: array + birthDate: + description: The date of birth for the practitioner. + element_property: true + format: date + title: The date on which the practitioner was born + type: string + communication: + description: '[Text representation of PractitionerCommunication] A language which + may be used to communicate with the practitioner, often for correspondence/administrative + purposes. The `PractitionerRole.communication` property should be used for + publishing the languages that a practitioner is able to communicate with patients + (on a per Organization/Role basis).' + element_property: true + items: + type: string + title: A language which may be used to communicate with the practitioner + type: array + deceasedBoolean: + description: Indicates if the practitioner is deceased or not + element_property: true + one_of_many: deceased + one_of_many_required: false + title: Indicates if the practitioner is deceased or not + type: boolean + deceasedDateTime: + description: Indicates if the practitioner is deceased or not + element_property: true + format: date-time + one_of_many: deceased + one_of_many_required: false + title: Indicates if the practitioner is deceased or not + type: string + extension: + description: '[Text representation of Extension] May be used to represent additional + information that is not part of the basic definition of the resource. To make + the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension.' + element_property: true + items: + type: string + title: Additional content defined by implementations + type: array + gender: + binding_description: The gender of a person used for administrative purposes. + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/administrative-gender + binding_version: 5.0.0 + description: Administrative Gender - the gender that the person is considered + to have for administration and record keeping purposes. + element_property: true + enum_values: + - male + - female + - other + - unknown + pattern: ^[^\s]+(\s[^\s]+)*$ + title: male | female | other | unknown + type: string + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: An identifier that applies to this person in this role. + element_property: true + items: + type: string + title: An identifier for the person as this agent + type: array + identifier_coding: + description: '[system#code representation of identifier] An identifier that applies + to this person in this role.' + element_property: true + items: + type: string + title: An identifier for the person as this agent + type: array + identifier_text_coding: + description: '[system#code representation of identifier.text] An identifier that + applies to this person in this role.' + element_property: true + items: + type: string + title: An identifier for the person as this agent + type: array + name: + description: '[Text representation of HumanName] The name(s) associated with the + practitioner' + element_property: true + items: + type: string + title: The name(s) associated with the practitioner + type: array + photo: + description: '[Text representation of Attachment] Image of the person' + element_property: true + items: + type: string + title: Image of the person + type: array + project_id: + term: + $ref: _terms.yaml#/project_id + type: string + qualification: + description: '[Text representation of PractitionerQualification] The official + qualifications, certifications, accreditations, training, licenses (and other + types of educations/skills/capabilities) that authorize or otherwise pertain + to the provision of care by the practitioner. For example, a medical license + issued by a medical board of licensure authorizing the practitioner to practice + medicine within a certain locality.' + element_property: true + items: + type: string + title: Qualifications, certifications, accreditations, licenses, training, etc. + pertaining to the provision of care + type: array + resourceType: + const: Practitioner + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + telecom: + description: '[Text representation of ContactPoint] A contact detail for the practitioner, + e.g. a telephone number or an email address.' + element_property: true + items: + type: string + title: A contact detail for the practitioner (that apply to all roles) + type: array +systemProperties: +- id +title: Practitioner +type: object +uniqueKeys: +- - id diff --git a/schemas/simplified/practitioner_role.yaml b/schemas/simplified/practitioner_role.yaml new file mode 100644 index 0000000..f1819b0 --- /dev/null +++ b/schemas/simplified/practitioner_role.yaml @@ -0,0 +1,346 @@ +$schema: http://json-schema.org/draft-04/schema# +additionalProperties: true +category: Administrative +description: Roles/organizations the practitioner is associated with. A specific set + of Roles/Locations/specialties/services that a practitioner may perform at an organization + for a period of time. [See https://hl7.org/fhir/R5/PractitionerRole.html] +id: practitioner_role +links: +- backref: practitioner_role + label: PractitionerRole_organization_Organization_practitioner_role + multiplicity: many_to_many + name: organization + required: false + target_type: organization +- backref: practitioner_role + label: PractitionerRole_practitioner_Practitioner_practitioner_role + multiplicity: many_to_many + name: practitioner + required: false + target_type: practitioner +program: '*' +project: '*' +properties: + active: + description: ' Whether this practitioner role record is in active use. Some systems + may use this property to mark non-active practitioners, such as those that are + not currently employed.' + element_property: true + title: Whether this practitioner role record is in active use + type: boolean + availability: + description: '[Text representation of Availability] A collection of times the + practitioner is available or performing this role at the location and/or healthcareservice.' + element_property: true + items: + type: string + title: Times the Practitioner is available at this location and/or healthcare + service (including exceptions) + type: array + characteristic: + binding_description: A custom attribute that could be provided at a service (e.g. + Wheelchair accessibility). + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/service-mode + binding_version: null + description: text representation. Collection of characteristics (attributes) + element_property: true + items: + type: string + term: + description: A custom attribute that could be provided at a service (e.g. Wheelchair + accessibility). + termDef: + cde_id: http://hl7.org/fhir/ValueSet/service-mode + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/service-mode + term_url: http://hl7.org/fhir/ValueSet/service-mode + title: Collection of characteristics (attributes) + type: array + characteristic_coding: &id001 + binding_description: A custom attribute that could be provided at a service (e.g. + Wheelchair accessibility). + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/service-mode + binding_version: null + description: '[system#code representation.] Collection of characteristics (attributes)' + element_property: true + items: + type: string + term: + description: A custom attribute that could be provided at a service (e.g. Wheelchair + accessibility). + termDef: + cde_id: http://hl7.org/fhir/ValueSet/service-mode + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/service-mode + term_url: http://hl7.org/fhir/ValueSet/service-mode + title: Collection of characteristics (attributes) + type: array + characteristic_text: *id001 + code: + binding_description: The role a person plays representing an organization. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/practitioner-role + binding_version: null + description: text representation. Roles which this practitioner is authorized + to perform for the organization. + element_property: true + items: + type: string + term: + description: The role a person plays representing an organization. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/practitioner-role + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/practitioner-role + term_url: http://hl7.org/fhir/ValueSet/practitioner-role + title: Roles which this practitioner may perform + type: array + code_coding: &id002 + binding_description: The role a person plays representing an organization. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/practitioner-role + binding_version: null + description: '[system#code representation.] Roles which this practitioner is authorized + to perform for the organization.' + element_property: true + items: + type: string + term: + description: The role a person plays representing an organization. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/practitioner-role + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/practitioner-role + term_url: http://hl7.org/fhir/ValueSet/practitioner-role + title: Roles which this practitioner may perform + type: array + code_text: *id002 + communication: + binding_description: IETF language tag for a human language + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/all-languages + binding_version: 5.0.0 + description: text representation. A language the practitioner can use in patient + communication. The practitioner may know several languages (listed in practitioner.communication), + however these are the languages that could be advertised in a directory for + a patient to search. + element_property: true + items: + type: string + term: + description: IETF language tag for a human language + termDef: + cde_id: http://hl7.org/fhir/ValueSet/all-languages + cde_version: null + source: fhir + strength: required + term: http://hl7.org/fhir/ValueSet/all-languages + term_url: http://hl7.org/fhir/ValueSet/all-languages + title: A language the practitioner (in this role) can use in patient communication + type: array + communication_coding: &id003 + binding_description: IETF language tag for a human language + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/all-languages + binding_version: 5.0.0 + description: '[system#code representation.] A language the practitioner can use + in patient communication. The practitioner may know several languages (listed + in practitioner.communication), however these are the languages that could be + advertised in a directory for a patient to search.' + element_property: true + items: + type: string + term: + description: IETF language tag for a human language + termDef: + cde_id: http://hl7.org/fhir/ValueSet/all-languages + cde_version: null + source: fhir + strength: required + term: http://hl7.org/fhir/ValueSet/all-languages + term_url: http://hl7.org/fhir/ValueSet/all-languages + title: A language the practitioner (in this role) can use in patient communication + type: array + communication_text: *id003 + contact: + description: '[Text representation of ExtendedContactDetail] The contact details + of communication devices available relevant to the specific PractitionerRole. + This can include addresses, phone numbers, fax numbers, mobile numbers, email + addresses and web sites.' + element_property: true + items: + type: string + title: Official contact details relating to this PractitionerRole + type: array + endpoint: + backref: endpoint_practitioner_role + description: '[Text representation of Reference] Technical endpoints providing + access to services operated for the practitioner with this role. Commonly used + for locating scheduling services, or identifying where to send referrals electronically.' + element_property: true + enum_reference_types: + - Endpoint + items: + type: string + title: Endpoints for interacting with the practitioner in this role + type: array + extension: + description: '[Text representation of Extension] May be used to represent additional + information that is not part of the basic definition of the resource. To make + the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension.' + element_property: true + items: + type: string + title: Additional content defined by implementations + type: array + healthcareService: + backref: healthcareService_practitioner_role + description: '[Text representation of Reference] The list of healthcare services + that this worker provides for this role''s Organization/Location(s).' + element_property: true + enum_reference_types: + - HealthcareService + items: + type: string + title: Healthcare services provided for this role's Organization/Location(s) + type: array + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: Business Identifiers that are specific to a role/location. + element_property: true + items: + type: string + title: Identifiers for a role/location + type: array + identifier_coding: + description: '[system#code representation of identifier] Business Identifiers + that are specific to a role/location.' + element_property: true + items: + type: string + title: Identifiers for a role/location + type: array + identifier_text_coding: + description: '[system#code representation of identifier.text] Business Identifiers + that are specific to a role/location.' + element_property: true + items: + type: string + title: Identifiers for a role/location + type: array + location: + backref: location_practitioner_role + description: '[Text representation of Reference] The location(s) at which this + practitioner provides care.' + element_property: true + enum_reference_types: + - Location + items: + type: string + title: Location(s) where the practitioner provides care + type: array + organization: + backref: practitioner_role + description: '[Text representation of Reference] The organization where the Practitioner + performs the roles associated.' + element_property: true + enum_reference_types: + - Organization + title: Organization where the roles are available + type: string + period: + description: '[Text representation of Period] The period during which the person + is authorized to act as a practitioner in these role(s) for the organization.' + element_property: true + title: The period during which the practitioner is authorized to perform in these + role(s) + type: string + practitioner: + backref: practitioner_role + description: '[Text representation of Reference] Practitioner that is able to + provide the defined services for the organization.' + element_property: true + enum_reference_types: + - Practitioner + title: Practitioner that provides services for the organization + type: string + project_id: + term: + $ref: _terms.yaml#/project_id + type: string + resourceType: + const: PractitionerRole + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + specialty: + binding_description: Specific specialty associated with the agency. + binding_strength: preferred + binding_uri: http://hl7.org/fhir/ValueSet/c80-practice-codes + binding_version: null + description: text representation. The specialty of a practitioner that describes + the functional role they are practicing at a given organization or location. + element_property: true + items: + type: string + term: + description: Specific specialty associated with the agency. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/c80-practice-codes + cde_version: null + source: fhir + strength: preferred + term: http://hl7.org/fhir/ValueSet/c80-practice-codes + term_url: http://hl7.org/fhir/ValueSet/c80-practice-codes + title: Specific specialty of the practitioner + type: array + specialty_coding: &id004 + binding_description: Specific specialty associated with the agency. + binding_strength: preferred + binding_uri: http://hl7.org/fhir/ValueSet/c80-practice-codes + binding_version: null + description: '[system#code representation.] The specialty of a practitioner that + describes the functional role they are practicing at a given organization or + location.' + element_property: true + items: + type: string + term: + description: Specific specialty associated with the agency. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/c80-practice-codes + cde_version: null + source: fhir + strength: preferred + term: http://hl7.org/fhir/ValueSet/c80-practice-codes + term_url: http://hl7.org/fhir/ValueSet/c80-practice-codes + title: Specific specialty of the practitioner + type: array + specialty_text: *id004 +systemProperties: +- id +title: PractitionerRole +type: object +uniqueKeys: +- - id diff --git a/schemas/simplified/procedure.yaml b/schemas/simplified/procedure.yaml new file mode 100644 index 0000000..2b0fae3 --- /dev/null +++ b/schemas/simplified/procedure.yaml @@ -0,0 +1,814 @@ +$schema: http://json-schema.org/draft-04/schema# +additionalProperties: true +category: Clinical +description: An action that is being or was performed on an individual or entity. + An action that is or was performed on or for a patient, practitioner, device, organization, + or location. For example, this can be a physical intervention on a patient like + an operation, or less invasive like long term services, counseling, or hypnotherapy. This + can be a quality or safety inspection for a location, organization, or device. This + can be an accreditation procedure on a practitioner for licensing. [See https://hl7.org/fhir/R5/Procedure.html] +id: procedure +links: +- backref: subject_procedure + label: Procedure_subject_Patient_subject_procedure + multiplicity: many_to_many + name: subject_Patient + required: false + target_type: patient +- backref: subject_procedure + label: Procedure_subject_Practitioner_subject_procedure + multiplicity: many_to_many + name: subject_Practitioner + required: false + target_type: practitioner +- backref: partOf_procedure + label: Procedure_partOf_Procedure_partOf_procedure + multiplicity: many_to_many + name: partOf_Procedure + required: false + target_type: procedure +program: '*' +project: '*' +properties: + basedOn: + backref: basedOn_procedure + description: '[Text representation of Reference] A reference to a resource that + contains details of the request for this procedure.' + element_property: true + enum_reference_types: + - CarePlan + - ServiceRequest + items: + type: string + title: A request for this procedure + type: array + bodySite: + binding_description: SNOMED CT Body site concepts + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/body-site + binding_version: null + description: text representation. Detailed and structured anatomical location + information. Multiple locations are allowed - e.g. multiple punch biopsies of + a lesion. + element_property: true + items: + type: string + term: + description: SNOMED CT Body site concepts + termDef: + cde_id: http://hl7.org/fhir/ValueSet/body-site + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/body-site + term_url: http://hl7.org/fhir/ValueSet/body-site + title: Target body sites + type: array + bodySite_coding: &id001 + binding_description: SNOMED CT Body site concepts + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/body-site + binding_version: null + description: '[system#code representation.] Detailed and structured anatomical + location information. Multiple locations are allowed - e.g. multiple punch biopsies + of a lesion.' + element_property: true + items: + type: string + term: + description: SNOMED CT Body site concepts + termDef: + cde_id: http://hl7.org/fhir/ValueSet/body-site + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/body-site + term_url: http://hl7.org/fhir/ValueSet/body-site + title: Target body sites + type: array + bodySite_text: *id001 + category: + binding_description: A code that classifies a procedure for searching, sorting + and display purposes. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-category + binding_version: null + description: text representation. A code that classifies the procedure for searching, + sorting and display purposes (e.g. "Surgical Procedure"). + element_property: true + items: + type: string + term: + description: A code that classifies a procedure for searching, sorting and display + purposes. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-category + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-category + term_url: http://hl7.org/fhir/ValueSet/procedure-category + title: Classification of the procedure + type: array + category_coding: &id002 + binding_description: A code that classifies a procedure for searching, sorting + and display purposes. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-category + binding_version: null + description: '[system#code representation.] A code that classifies the procedure + for searching, sorting and display purposes (e.g. "Surgical Procedure").' + element_property: true + items: + type: string + term: + description: A code that classifies a procedure for searching, sorting and display + purposes. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-category + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-category + term_url: http://hl7.org/fhir/ValueSet/procedure-category + title: Classification of the procedure + type: array + category_text: *id002 + code: + binding_description: A code to identify a specific procedure . + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-code + binding_version: null + description: text representation. The specific procedure that is performed. Use + text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic + Appendectomy"). + element_property: true + term: + description: A code to identify a specific procedure . + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-code + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-code + term_url: http://hl7.org/fhir/ValueSet/procedure-code + title: Identification of the procedure + type: string + code_coding: &id003 + binding_description: A code to identify a specific procedure . + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-code + binding_version: null + description: '[system#code representation.] The specific procedure that is performed. + Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic + Appendectomy").' + element_property: true + term: + description: A code to identify a specific procedure . + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-code + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-code + term_url: http://hl7.org/fhir/ValueSet/procedure-code + title: Identification of the procedure + type: string + code_text: *id003 + complication: + backref: complication_procedure + binding_description: Codes describing complications that resulted from a procedure. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/condition-code + binding_version: null + description: text representation. Any complications that occurred during the procedure, + or in the immediate post-performance period. These are generally tracked separately + from the notes, which will typically describe the procedure itself rather than + any 'post procedure' issues. + element_property: true + enum_reference_types: + - Condition + items: + type: string + term: + description: Codes describing complications that resulted from a procedure. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/condition-code + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/condition-code + term_url: http://hl7.org/fhir/ValueSet/condition-code + title: Complication following the procedure + type: array + complication_coding: &id004 + backref: complication_procedure + binding_description: Codes describing complications that resulted from a procedure. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/condition-code + binding_version: null + description: '[system#code representation.] Any complications that occurred during + the procedure, or in the immediate post-performance period. These are generally + tracked separately from the notes, which will typically describe the procedure + itself rather than any ''post procedure'' issues.' + element_property: true + enum_reference_types: + - Condition + items: + type: string + term: + description: Codes describing complications that resulted from a procedure. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/condition-code + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/condition-code + term_url: http://hl7.org/fhir/ValueSet/condition-code + title: Complication following the procedure + type: array + complication_text: *id004 + encounter: + backref: procedure + description: '[Text representation of Reference] The Encounter during which this + Procedure was created or performed or to which the creation of this record is + tightly associated.' + element_property: true + enum_reference_types: + - Encounter + title: The Encounter during which this Procedure was created + type: string + extension: + description: '[Text representation of Extension] May be used to represent additional + information that is not part of the basic definition of the resource. To make + the use of extensions safe and managable, there is a strict set of governance + applied to the definition and use of extensions. Though any implementer can + define an extension, there is a set of requirements that SHALL be met as part + of the definition of the extension.' + element_property: true + items: + type: string + title: Additional content defined by implementations + type: array + focalDevice: + description: '[Text representation of ProcedureFocalDevice] A device that is implanted, + removed or otherwise manipulated (calibration, battery replacement, fitting + a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.' + element_property: true + items: + type: string + title: Manipulated, implanted, or removed device + type: array + focus: + backref: focus_procedure + description: '[Text representation of Reference] Who is the target of the procedure + when it is not the subject of record only. If focus is not present, then subject + is the focus. If focus is present and the subject is one of the targets of + the procedure, include subject as a focus as well. If focus is present and the + subject is not included in focus, it implies that the procedure was only targeted + on the focus. For example, when a caregiver is given education for a patient, + the caregiver would be the focus and the procedure record is associated with + the subject (e.g. patient). For example, use focus when recording the target + of the education, training, or counseling is the parent or relative of a patient.' + element_property: true + enum_reference_types: + - Patient + - Group + - RelatedPerson + - Practitioner + - Organization + - CareTeam + - PractitionerRole + - Specimen + title: Who is the target of the procedure when it is not the subject of record + only + type: string + followUp: + binding_description: Specific follow up required for a procedure e.g. removal + of sutures. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-followup + binding_version: null + description: text representation. If the procedure required specific follow up + - e.g. removal of sutures. The follow up may be represented as a simple note + or could potentially be more complex, in which case the CarePlan resource can + be used. + element_property: true + items: + type: string + term: + description: Specific follow up required for a procedure e.g. removal of sutures. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-followup + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-followup + term_url: http://hl7.org/fhir/ValueSet/procedure-followup + title: Instructions for follow up + type: array + followUp_coding: &id005 + binding_description: Specific follow up required for a procedure e.g. removal + of sutures. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-followup + binding_version: null + description: '[system#code representation.] If the procedure required specific + follow up - e.g. removal of sutures. The follow up may be represented as a simple + note or could potentially be more complex, in which case the CarePlan resource + can be used.' + element_property: true + items: + type: string + term: + description: Specific follow up required for a procedure e.g. removal of sutures. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-followup + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-followup + term_url: http://hl7.org/fhir/ValueSet/procedure-followup + title: Instructions for follow up + type: array + followUp_text: *id005 + id: + description: The logical id of the resource, as used in the URL for the resource. + Once assigned, this value never changes. + element_property: true + maxLength: 64 + minLength: 1 + pattern: ^[A-Za-z0-9\-.]+$ + title: Logical id of this artifact + type: string + identifier: + description: Business identifiers assigned to this procedure by the performer + or other systems which remain constant as the resource is updated and is propagated + from server to server. + element_property: true + items: + type: string + title: External Identifiers for this procedure + type: array + identifier_coding: + description: '[system#code representation of identifier] Business identifiers + assigned to this procedure by the performer or other systems which remain constant + as the resource is updated and is propagated from server to server.' + element_property: true + items: + type: string + title: External Identifiers for this procedure + type: array + identifier_text_coding: + description: '[system#code representation of identifier.text] Business identifiers + assigned to this procedure by the performer or other systems which remain constant + as the resource is updated and is propagated from server to server.' + element_property: true + items: + type: string + title: External Identifiers for this procedure + type: array + instantiatesCanonical: + description: The URL pointing to a FHIR-defined protocol, guideline, order set + or other definition that is adhered to in whole or in part by this Procedure. + element_property: true + enum_reference_types: + - PlanDefinition + - ActivityDefinition + - Measure + - OperationDefinition + - Questionnaire + items: + pattern: \S* + type: string + title: Instantiates FHIR protocol or definition + type: array + instantiatesUri: + description: The URL pointing to an externally maintained protocol, guideline, + order set or other definition that is adhered to in whole or in part by this + Procedure. + element_property: true + items: + pattern: \S* + type: string + title: Instantiates external protocol or definition + type: array + location: + backref: location_procedure + description: '[Text representation of Reference] The location where the procedure + actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.' + element_property: true + enum_reference_types: + - Location + title: Where the procedure happened + type: string + note: + description: '[Text representation of Annotation] Any other notes and comments + about the procedure.' + element_property: true + items: + type: string + title: Additional information about the procedure + type: array + occurrenceAge: + description: '[Text representation of Age] Estimated or actual date, date-time, + period, or age when the procedure did occur or is occurring. Allows a period + to support complex procedures that span more than one date, and also allows + for the length of the procedure to be captured.' + element_property: true + one_of_many: occurrence + one_of_many_required: false + title: When the procedure occurred or is occurring + type: string + occurrenceDateTime: + description: Estimated or actual date, date-time, period, or age when the procedure + did occur or is occurring. Allows a period to support complex procedures that + span more than one date, and also allows for the length of the procedure to + be captured. + element_property: true + format: date-time + one_of_many: occurrence + one_of_many_required: false + title: When the procedure occurred or is occurring + type: string + occurrencePeriod: + description: '[Text representation of Period] Estimated or actual date, date-time, + period, or age when the procedure did occur or is occurring. Allows a period + to support complex procedures that span more than one date, and also allows + for the length of the procedure to be captured.' + element_property: true + one_of_many: occurrence + one_of_many_required: false + title: When the procedure occurred or is occurring + type: string + occurrenceRange: + description: '[Text representation of Range] Estimated or actual date, date-time, + period, or age when the procedure did occur or is occurring. Allows a period + to support complex procedures that span more than one date, and also allows + for the length of the procedure to be captured.' + element_property: true + one_of_many: occurrence + one_of_many_required: false + title: When the procedure occurred or is occurring + type: string + occurrenceString: + description: Estimated or actual date, date-time, period, or age when the procedure + did occur or is occurring. Allows a period to support complex procedures that + span more than one date, and also allows for the length of the procedure to + be captured. + element_property: true + one_of_many: occurrence + one_of_many_required: false + pattern: '[ \r\n\t\S]+' + title: When the procedure occurred or is occurring + type: string + occurrenceTiming: + description: '[Text representation of Timing] Estimated or actual date, date-time, + period, or age when the procedure did occur or is occurring. Allows a period + to support complex procedures that span more than one date, and also allows + for the length of the procedure to be captured.' + element_property: true + one_of_many: occurrence + one_of_many_required: false + title: When the procedure occurred or is occurring + type: string + outcome: + binding_description: An outcome of a procedure - whether it was resolved or otherwise. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-outcome + binding_version: null + description: text representation. The outcome of the procedure - did it resolve + the reasons for the procedure being performed? + element_property: true + term: + description: An outcome of a procedure - whether it was resolved or otherwise. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-outcome + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-outcome + term_url: http://hl7.org/fhir/ValueSet/procedure-outcome + title: The result of procedure + type: string + outcome_coding: &id006 + binding_description: An outcome of a procedure - whether it was resolved or otherwise. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-outcome + binding_version: null + description: '[system#code representation.] The outcome of the procedure - did + it resolve the reasons for the procedure being performed?' + element_property: true + term: + description: An outcome of a procedure - whether it was resolved or otherwise. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-outcome + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-outcome + term_url: http://hl7.org/fhir/ValueSet/procedure-outcome + title: The result of procedure + type: string + outcome_text: *id006 + partOf: + backref: partOf_procedure + description: '[Text representation of Reference] A larger event of which this + particular procedure is a component or step.' + element_property: true + enum_reference_types: + - Procedure + - Observation + - MedicationAdministration + items: + type: string + title: Part of referenced event + type: array + performer: + description: '[Text representation of ProcedurePerformer] Indicates who or what + performed the procedure and how they were involved.' + element_property: true + items: + type: string + title: Who performed the procedure and what they did + type: array + project_id: + term: + $ref: _terms.yaml#/project_id + type: string + reason: + backref: reason_procedure + binding_description: A code that identifies the reason a procedure is required. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-reason + binding_version: null + description: text representation. The coded reason or reference why the procedure + was performed. This may be a coded entity of some type, be present as text, + or be a reference to one of several resources that justify the procedure. + element_property: true + enum_reference_types: + - Condition + - Observation + - Procedure + - DiagnosticReport + - DocumentReference + items: + type: string + term: + description: A code that identifies the reason a procedure is required. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-reason + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-reason + term_url: http://hl7.org/fhir/ValueSet/procedure-reason + title: The justification that the procedure was performed + type: array + reason_coding: &id007 + backref: reason_procedure + binding_description: A code that identifies the reason a procedure is required. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-reason + binding_version: null + description: '[system#code representation.] The coded reason or reference why + the procedure was performed. This may be a coded entity of some type, be present + as text, or be a reference to one of several resources that justify the procedure.' + element_property: true + enum_reference_types: + - Condition + - Observation + - Procedure + - DiagnosticReport + - DocumentReference + items: + type: string + term: + description: A code that identifies the reason a procedure is required. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-reason + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-reason + term_url: http://hl7.org/fhir/ValueSet/procedure-reason + title: The justification that the procedure was performed + type: array + reason_text: *id007 + recorded: + description: The date the occurrence of the procedure was first captured in the + record regardless of Procedure.status (potentially after the occurrence of the + event). + element_property: true + format: date-time + title: When the procedure was first captured in the subject's record + type: string + recorder: + backref: recorder_procedure + description: '[Text representation of Reference] Individual who recorded the record + and takes responsibility for its content.' + element_property: true + enum_reference_types: + - Patient + - RelatedPerson + - Practitioner + - PractitionerRole + title: Who recorded the procedure + type: string + report: + backref: report_procedure + description: '[Text representation of Reference] This could be a histology result, + pathology report, surgical report, etc.' + element_property: true + enum_reference_types: + - DiagnosticReport + - DocumentReference + - Composition + items: + type: string + title: Any report resulting from the procedure + type: array + reportedBoolean: + description: Indicates if this record was captured as a secondary 'reported' record + rather than as an original primary source-of-truth record. It may also indicate + the source of the report. + element_property: true + one_of_many: reported + one_of_many_required: false + title: Reported rather than primary record + type: boolean + reportedReference: + backref: reportedReference_procedure + description: '[Text representation of Reference] Indicates if this record was + captured as a secondary ''reported'' record rather than as an original primary + source-of-truth record. It may also indicate the source of the report.' + element_property: true + enum_reference_types: + - Patient + - RelatedPerson + - Practitioner + - PractitionerRole + - Organization + one_of_many: reported + one_of_many_required: false + title: Reported rather than primary record + type: string + resourceType: + const: Procedure + description: One of the resource types defined as part of FHIR + title: Resource Type + type: string + status: + binding_description: A code specifying the state of the procedure. + binding_strength: required + binding_uri: http://hl7.org/fhir/ValueSet/event-status + binding_version: 5.0.0 + description: A code specifying the state of the procedure. Generally, this will + be the in-progress or completed state. + element_property: true + element_required: true + enum_values: + - preparation + - in-progress + - not-done + - on-hold + - stopped + - completed + - entered-in-error + - unknown + pattern: ^[^\s]+(\s[^\s]+)*$ + title: preparation | in-progress | not-done | on-hold | stopped | completed | + entered-in-error | unknown + type: string + statusReason: + binding_description: A code that identifies the reason a procedure was not performed. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + binding_version: null + description: text representation. Captures the reason for the current state of + the procedure. + element_property: true + term: + description: A code that identifies the reason a procedure was not performed. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + term_url: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + title: Reason for current status + type: string + statusReason_coding: &id008 + binding_description: A code that identifies the reason a procedure was not performed. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + binding_version: null + description: '[system#code representation.] Captures the reason for the current + state of the procedure.' + element_property: true + term: + description: A code that identifies the reason a procedure was not performed. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + term_url: http://hl7.org/fhir/ValueSet/procedure-not-performed-reason + title: Reason for current status + type: string + statusReason_text: *id008 + subject: + backref: subject_procedure + description: '[Text representation of Reference] On whom or on what the procedure + was performed. This is usually an individual human, but can also be performed + on animals, groups of humans or animals, organizations or practitioners (for + licensing), locations or devices (for safety inspections or regulatory authorizations). If + the actual focus of the procedure is different from the subject, the focus element + specifies the actual focus of the procedure.' + element_property: true + enum_reference_types: + - Patient + - Group + - Device + - Practitioner + - Organization + - Location + title: Individual or entity the procedure was performed on + type: string + supportingInfo: + backref: supportingInfo_procedure + description: '[Text representation of Reference] Other resources from the patient + record that may be relevant to the procedure. The information from these resources + was either used to create the instance or is provided to help with its interpretation. + This extension should not be used if more specific inline elements or extensions + are available.' + element_property: true + enum_reference_types: + - Resource + items: + type: string + title: Extra information relevant to the procedure + type: array + used: + backref: used_procedure + binding_description: Codes describing items used during a procedure. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/device-type + binding_version: null + description: text representation. Identifies medications, devices and any other + substance used as part of the procedure. + element_property: true + enum_reference_types: + - Device + - Medication + - Substance + - BiologicallyDerivedProduct + items: + type: string + term: + description: Codes describing items used during a procedure. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/device-type + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/device-type + term_url: http://hl7.org/fhir/ValueSet/device-type + title: Items used during procedure + type: array + used_coding: &id009 + backref: used_procedure + binding_description: Codes describing items used during a procedure. + binding_strength: example + binding_uri: http://hl7.org/fhir/ValueSet/device-type + binding_version: null + description: '[system#code representation.] Identifies medications, devices and + any other substance used as part of the procedure.' + element_property: true + enum_reference_types: + - Device + - Medication + - Substance + - BiologicallyDerivedProduct + items: + type: string + term: + description: Codes describing items used during a procedure. + termDef: + cde_id: http://hl7.org/fhir/ValueSet/device-type + cde_version: null + source: fhir + strength: example + term: http://hl7.org/fhir/ValueSet/device-type + term_url: http://hl7.org/fhir/ValueSet/device-type + title: Items used during procedure + type: array + used_text: *id009 +systemProperties: +- id +title: Procedure +type: object +uniqueKeys: +- - id diff --git a/schemas/simplified/research_study.yaml b/schemas/simplified/research_study.yaml index 2959819..6419d0f 100644 --- a/schemas/simplified/research_study.yaml +++ b/schemas/simplified/research_study.yaml @@ -9,12 +9,6 @@ description: Investigation to increase healthcare-related patient-independent kn at data collected in the past or future. [See https://hl7.org/fhir/R5/ResearchStudy.html] id: research_study links: -- backref: focus_research_study - label: ResearchStudy_focus_Medication_focus_research_study - multiplicity: many_to_many - name: focus_Medication - required: false - target_type: medication - backref: partOf_research_study label: ResearchStudy_partOf_ResearchStudy_partOf_research_study multiplicity: many_to_many diff --git a/schemas/simplified/simplified-fhir.json b/schemas/simplified/simplified-fhir.json index 1a789f2..c54eddc 100644 --- a/schemas/simplified/simplified-fhir.json +++ b/schemas/simplified/simplified-fhir.json @@ -624,449 +624,307 @@ ] ] }, - "observation.yaml": { + "practitioner_role.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, - "category": "Clinical", - "description": "Measurements and simple assertions. Measurements and simple assertions made about a patient, device or other subject. [See https://hl7.org/fhir/R5/Observation.html]", - "id": "observation", + "category": "Administrative", + "description": "Roles/organizations the practitioner is associated with. A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. [See https://hl7.org/fhir/R5/PractitionerRole.html]", + "id": "practitioner_role", "links": [ { - "backref": "subject_observation", - "label": "Observation_subject_Patient_subject_observation", - "multiplicity": "many_to_many", - "name": "subject_Patient", - "required": false, - "target_type": "patient" - }, - { - "backref": "focus_observation", - "label": "Observation_focus_ResearchStudy_focus_observation", + "backref": "practitioner_role", + "label": "PractitionerRole_organization_Organization_practitioner_role", "multiplicity": "many_to_many", - "name": "focus", + "name": "organization", "required": false, - "target_type": "research_study" + "target_type": "organization" }, { - "backref": "specimen_observation", - "label": "Observation_specimen_Specimen_specimen_observation", + "backref": "practitioner_role", + "label": "PractitionerRole_practitioner_Practitioner_practitioner_role", "multiplicity": "many_to_many", - "name": "specimen_Specimen", + "name": "practitioner", "required": false, - "target_type": "specimen" + "target_type": "practitioner" } ], "program": "*", "project": "*", "properties": { - "basedOn": { - "backref": "basedOn_observation", - "description": "[Text representation of Reference] A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.", + "active": { + "description": " Whether this practitioner role record is in active use. Some systems may use this property to mark non-active practitioners, such as those that are not currently employed.", + "element_property": true, + "title": "Whether this practitioner role record is in active use", + "type": "boolean" + }, + "availability": { + "description": "[Text representation of Availability] A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.", "element_property": true, - "enum_reference_types": [ - "CarePlan", - "DeviceRequest", - "ImmunizationRecommendation", - "MedicationRequest", - "NutritionOrder", - "ServiceRequest" - ], "items": { "type": "string" }, - "title": "Fulfills plan, proposal or order", + "title": "Times the Practitioner is available at this location and/or healthcare service (including exceptions)", "type": "array" }, - "bodySite": { - "binding_description": "SNOMED CT Body site concepts", + "characteristic": { + "binding_description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://hl7.org/fhir/ValueSet/service-mode", "binding_version": null, - "description": "text representation. Indicates the site on the subject's body where the observation was made (i.e. the target site).", + "description": "text representation. Collection of characteristics (attributes)", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/service-mode", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://hl7.org/fhir/ValueSet/service-mode", + "term_url": "http://hl7.org/fhir/ValueSet/service-mode" } }, - "title": "Observed body part", - "type": "string" + "title": "Collection of characteristics (attributes)", + "type": "array" }, - "bodySite_coding": { - "binding_description": "SNOMED CT Body site concepts", + "characteristic_coding": { + "binding_description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://hl7.org/fhir/ValueSet/service-mode", "binding_version": null, - "description": "[system#code representation.] Indicates the site on the subject's body where the observation was made (i.e. the target site).", + "description": "[system#code representation.] Collection of characteristics (attributes)", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/service-mode", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://hl7.org/fhir/ValueSet/service-mode", + "term_url": "http://hl7.org/fhir/ValueSet/service-mode" } }, - "title": "Observed body part", - "type": "string" + "title": "Collection of characteristics (attributes)", + "type": "array" }, - "bodySite_text": { - "binding_description": "SNOMED CT Body site concepts", + "characteristic_text": { + "binding_description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://hl7.org/fhir/ValueSet/service-mode", "binding_version": null, - "description": "[system#code representation.] Indicates the site on the subject's body where the observation was made (i.e. the target site).", + "description": "[system#code representation.] Collection of characteristics (attributes)", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/service-mode", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://hl7.org/fhir/ValueSet/service-mode", + "term_url": "http://hl7.org/fhir/ValueSet/service-mode" } }, - "title": "Observed body part", - "type": "string" - }, - "bodyStructure": { - "backref": "observation", - "description": "[Text representation of Reference] Indicates the body structure on the subject's body where the observation was made (i.e. the target site).", - "element_property": true, - "enum_reference_types": [ - "BodyStructure" - ], - "title": "Observed body structure", - "type": "string" + "title": "Collection of characteristics (attributes)", + "type": "array" }, - "category": { - "binding_description": "Codes for high level observation categories.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-category", + "code": { + "binding_description": "The role a person plays representing an organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/practitioner-role", "binding_version": null, - "description": "text representation. A code that classifies the general type of observation being made.", + "description": "text representation. Roles which this practitioner is authorized to perform for the organization.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes for high level observation categories.", + "description": "The role a person plays representing an organization.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-category", + "cde_id": "http://hl7.org/fhir/ValueSet/practitioner-role", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/observation-category", - "term_url": "http://hl7.org/fhir/ValueSet/observation-category" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/practitioner-role", + "term_url": "http://hl7.org/fhir/ValueSet/practitioner-role" } }, - "title": "Classification of type of observation", + "title": "Roles which this practitioner may perform", "type": "array" }, - "category_coding": { - "binding_description": "Codes for high level observation categories.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-category", + "code_coding": { + "binding_description": "The role a person plays representing an organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/practitioner-role", "binding_version": null, - "description": "[system#code representation.] A code that classifies the general type of observation being made.", + "description": "[system#code representation.] Roles which this practitioner is authorized to perform for the organization.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes for high level observation categories.", + "description": "The role a person plays representing an organization.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-category", + "cde_id": "http://hl7.org/fhir/ValueSet/practitioner-role", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/observation-category", - "term_url": "http://hl7.org/fhir/ValueSet/observation-category" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/practitioner-role", + "term_url": "http://hl7.org/fhir/ValueSet/practitioner-role" } }, - "title": "Classification of type of observation", + "title": "Roles which this practitioner may perform", "type": "array" }, - "category_text": { - "binding_description": "Codes for high level observation categories.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-category", + "code_text": { + "binding_description": "The role a person plays representing an organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/practitioner-role", "binding_version": null, - "description": "[system#code representation.] A code that classifies the general type of observation being made.", + "description": "[system#code representation.] Roles which this practitioner is authorized to perform for the organization.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes for high level observation categories.", + "description": "The role a person plays representing an organization.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-category", + "cde_id": "http://hl7.org/fhir/ValueSet/practitioner-role", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/observation-category", - "term_url": "http://hl7.org/fhir/ValueSet/observation-category" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/practitioner-role", + "term_url": "http://hl7.org/fhir/ValueSet/practitioner-role" } }, - "title": "Classification of type of observation", + "title": "Roles which this practitioner may perform", "type": "array" }, - "code": { - "binding_description": "LDL Cholesterol codes - measured or calculated.", + "communication": { + "binding_description": "IETF language tag for a human language", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", - "binding_version": null, - "description": "text representation. Describes what was observed. Sometimes this is called the observation \"name\".", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "text representation. A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "LDL Cholesterol codes - measured or calculated.", + "description": "IETF language tag for a human language", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/all-languages", "cde_version": null, "source": "fhir", "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", - "term_url": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes" + "term": "http://hl7.org/fhir/ValueSet/all-languages", + "term_url": "http://hl7.org/fhir/ValueSet/all-languages" } }, - "title": "Type of observation (code / type)", - "type": "string" + "title": "A language the practitioner (in this role) can use in patient communication", + "type": "array" }, - "code_coding": { - "binding_description": "LDL Cholesterol codes - measured or calculated.", + "communication_coding": { + "binding_description": "IETF language tag for a human language", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", - "binding_version": null, - "description": "[system#code representation.] Describes what was observed. Sometimes this is called the observation \"name\".", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "[system#code representation.] A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "LDL Cholesterol codes - measured or calculated.", + "description": "IETF language tag for a human language", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/all-languages", "cde_version": null, "source": "fhir", "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", - "term_url": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes" + "term": "http://hl7.org/fhir/ValueSet/all-languages", + "term_url": "http://hl7.org/fhir/ValueSet/all-languages" } }, - "title": "Type of observation (code / type)", - "type": "string" + "title": "A language the practitioner (in this role) can use in patient communication", + "type": "array" }, - "code_text": { - "binding_description": "LDL Cholesterol codes - measured or calculated.", + "communication_text": { + "binding_description": "IETF language tag for a human language", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", - "binding_version": null, - "description": "[system#code representation.] Describes what was observed. Sometimes this is called the observation \"name\".", + "binding_uri": "http://hl7.org/fhir/ValueSet/all-languages", + "binding_version": "5.0.0", + "description": "[system#code representation.] A language the practitioner can use in patient communication. The practitioner may know several languages (listed in practitioner.communication), however these are the languages that could be advertised in a directory for a patient to search.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "LDL Cholesterol codes - measured or calculated.", + "description": "IETF language tag for a human language", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/all-languages", "cde_version": null, "source": "fhir", "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", - "term_url": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes" + "term": "http://hl7.org/fhir/ValueSet/all-languages", + "term_url": "http://hl7.org/fhir/ValueSet/all-languages" } }, - "title": "Type of observation (code / type)", - "type": "string" + "title": "A language the practitioner (in this role) can use in patient communication", + "type": "array" }, - "component": { - "description": "[Text representation of ObservationComponent] Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.", + "contact": { + "description": "[Text representation of ExtendedContactDetail] The contact details of communication devices available relevant to the specific PractitionerRole. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.", "element_property": true, "items": { "type": "string" }, - "title": "Component results", + "title": "Official contact details relating to this PractitionerRole", "type": "array" }, - "dataAbsentReason": { - "binding_description": "Codes specifying why the result (`Observation.value[x]`) is missing.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "binding_version": null, - "description": "text representation. Provides a reason why the expected value in the element Observation.value[x] is missing.", + "endpoint": { + "backref": "endpoint_practitioner_role", + "description": "[Text representation of Reference] Technical endpoints providing access to services operated for the practitioner with this role. Commonly used for locating scheduling services, or identifying where to send referrals electronically.", "element_property": true, - "term": { - "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/data-absent-reason" - } + "enum_reference_types": [ + "Endpoint" + ], + "items": { + "type": "string" }, - "title": "Why the result is missing", - "type": "string" + "title": "Endpoints for interacting with the practitioner in this role", + "type": "array" }, - "dataAbsentReason_coding": { - "binding_description": "Codes specifying why the result (`Observation.value[x]`) is missing.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "binding_version": null, - "description": "[system#code representation.] Provides a reason why the expected value in the element Observation.value[x] is missing.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, - "term": { - "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/data-absent-reason" - } + "items": { + "type": "string" }, - "title": "Why the result is missing", - "type": "string" + "title": "Additional content defined by implementations", + "type": "array" }, - "dataAbsentReason_text": { - "binding_description": "Codes specifying why the result (`Observation.value[x]`) is missing.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "binding_version": null, - "description": "[system#code representation.] Provides a reason why the expected value in the element Observation.value[x] is missing.", + "healthcareService": { + "backref": "healthcareService_practitioner_role", + "description": "[Text representation of Reference] The list of healthcare services that this worker provides for this role's Organization/Location(s).", "element_property": true, - "term": { - "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/data-absent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/data-absent-reason" - } + "enum_reference_types": [ + "HealthcareService" + ], + "items": { + "type": "string" }, - "title": "Why the result is missing", - "type": "string" - }, - "derivedFrom": { - "backref": "derivedFrom_observation", - "description": "[Text representation of Reference] The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.", - "element_property": true, - "enum_reference_types": [ - "DocumentReference", - "ImagingStudy", - "ImagingSelection", - "QuestionnaireResponse", - "Observation", - "MolecularSequence", - "GenomicStudy" - ], - "items": { - "type": "string" - }, - "title": "Related resource from which the observation is made", - "type": "array" - }, - "device": { - "backref": "device_observation", - "description": "[Text representation of Reference] A reference to the device that generates the measurements or the device settings for the device", - "element_property": true, - "enum_reference_types": [ - "Device", - "DeviceMetric" - ], - "title": "A reference to the device that generates the measurements or the device settings for the device", - "type": "string" - }, - "effectiveDateTime": { - "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "element_property": true, - "format": "date-time", - "one_of_many": "effective", - "one_of_many_required": false, - "title": "Clinically relevant time/time-period for observation", - "type": "string" - }, - "effectiveInstant": { - "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "element_property": true, - "format": "date-time", - "one_of_many": "effective", - "one_of_many_required": false, - "title": "Clinically relevant time/time-period for observation", - "type": "string" - }, - "effectivePeriod": { - "description": "[Text representation of Period] The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "element_property": true, - "one_of_many": "effective", - "one_of_many_required": false, - "title": "Clinically relevant time/time-period for observation", - "type": "string" - }, - "effectiveTiming": { - "description": "[Text representation of Timing] The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", - "element_property": true, - "one_of_many": "effective", - "one_of_many_required": false, - "title": "Clinically relevant time/time-period for observation", - "type": "string" - }, - "encounter": { - "backref": "observation", - "description": "[Text representation of Reference] The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", - "element_property": true, - "enum_reference_types": [ - "Encounter" - ], - "title": "Healthcare event during which this observation is made", - "type": "string" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "focus": { - "backref": "focus_observation", - "description": "[Text representation of Reference] The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor.", - "element_property": true, - "enum_reference_types": [ - "ResearchStudy" - ], - "items": { - "type": "string" - }, - "title": "What the observation is about, when it is not about the subject of record", - "type": "array" - }, - "hasMember": { - "backref": "hasMember_observation", - "description": "[Text representation of Reference] This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.", - "element_property": true, - "enum_reference_types": [ - "Observation", - "QuestionnaireResponse", - "MolecularSequence" - ], - "items": { - "type": "string" - }, - "title": "Related resource that belongs to the Observation group", - "type": "array" + "title": "Healthcare services provided for this role's Organization/Location(s)", + "type": "array" }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", @@ -1078,1909 +936,2009 @@ "type": "string" }, "identifier": { - "description": "A unique identifier assigned to this observation.", + "description": "Business Identifiers that are specific to a role/location.", "element_property": true, "items": { "type": "string" }, - "title": "Business Identifier for observation", + "title": "Identifiers for a role/location", "type": "array" }, "identifier_coding": { - "description": "[system#code representation of identifier] A unique identifier assigned to this observation.", + "description": "[system#code representation of identifier] Business Identifiers that are specific to a role/location.", "element_property": true, "items": { "type": "string" }, - "title": "Business Identifier for observation", + "title": "Identifiers for a role/location", "type": "array" }, "identifier_text_coding": { - "description": "[system#code representation of identifier.text] A unique identifier assigned to this observation.", + "description": "[system#code representation of identifier.text] Business Identifiers that are specific to a role/location.", "element_property": true, "items": { "type": "string" }, - "title": "Business Identifier for observation", + "title": "Identifiers for a role/location", "type": "array" }, - "instantiatesCanonical": { - "description": "The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.", + "location": { + "backref": "location_practitioner_role", + "description": "[Text representation of Reference] The location(s) at which this practitioner provides care.", "element_property": true, "enum_reference_types": [ - "ObservationDefinition" + "Location" ], - "one_of_many": "instantiates", - "one_of_many_required": false, - "pattern": "\\S*", - "title": "Instantiates FHIR ObservationDefinition", + "items": { + "type": "string" + }, + "title": "Location(s) where the practitioner provides care", + "type": "array" + }, + "organization": { + "backref": "practitioner_role", + "description": "[Text representation of Reference] The organization where the Practitioner performs the roles associated.", + "element_property": true, + "enum_reference_types": [ + "Organization" + ], + "title": "Organization where the roles are available", "type": "string" }, - "instantiatesReference": { - "backref": "observation", - "description": "[Text representation of Reference] The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.", + "period": { + "description": "[Text representation of Period] The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", + "element_property": true, + "title": "The period during which the practitioner is authorized to perform in these role(s)", + "type": "string" + }, + "practitioner": { + "backref": "practitioner_role", + "description": "[Text representation of Reference] Practitioner that is able to provide the defined services for the organization.", "element_property": true, "enum_reference_types": [ - "ObservationDefinition" + "Practitioner" ], - "one_of_many": "instantiates", - "one_of_many_required": false, - "title": "Instantiates FHIR ObservationDefinition", + "title": "Practitioner that provides services for the organization", "type": "string" }, - "interpretation": { - "binding_description": "Codes identifying interpretations of observations.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "resourceType": { + "const": "PractitionerRole", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "specialty": { + "binding_description": "Specific specialty associated with the agency.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "binding_version": null, - "description": "text representation. A categorical assessment of an observation value. For example, high, low, normal.", + "description": "text representation. The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes identifying interpretations of observations.", + "description": "Specific specialty associated with the agency.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/observation-interpretation", - "term_url": "http://hl7.org/fhir/ValueSet/observation-interpretation" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, - "title": "High, low, normal, etc", + "title": "Specific specialty of the practitioner", "type": "array" }, - "interpretation_coding": { - "binding_description": "Codes identifying interpretations of observations.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "specialty_coding": { + "binding_description": "Specific specialty associated with the agency.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "binding_version": null, - "description": "[system#code representation.] A categorical assessment of an observation value. For example, high, low, normal.", + "description": "[system#code representation.] The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes identifying interpretations of observations.", + "description": "Specific specialty associated with the agency.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/observation-interpretation", - "term_url": "http://hl7.org/fhir/ValueSet/observation-interpretation" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, - "title": "High, low, normal, etc", + "title": "Specific specialty of the practitioner", "type": "array" }, - "interpretation_text": { - "binding_description": "Codes identifying interpretations of observations.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "specialty_text": { + "binding_description": "Specific specialty associated with the agency.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "binding_version": null, - "description": "[system#code representation.] A categorical assessment of an observation value. For example, high, low, normal.", + "description": "[system#code representation.] The specialty of a practitioner that describes the functional role they are practicing at a given organization or location.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes identifying interpretations of observations.", + "description": "Specific specialty associated with the agency.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/observation-interpretation", - "term_url": "http://hl7.org/fhir/ValueSet/observation-interpretation" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, - "title": "High, low, normal, etc", + "title": "Specific specialty of the practitioner", "type": "array" + } + }, + "systemProperties": [ + "id" + ], + "title": "PractitionerRole", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "observation.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Clinical", + "description": "Measurements and simple assertions. Measurements and simple assertions made about a patient, device or other subject. [See https://hl7.org/fhir/R5/Observation.html]", + "id": "observation", + "links": [ + { + "backref": "subject_observation", + "label": "Observation_subject_Patient_subject_observation", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" }, - "issued": { - "description": "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", - "element_property": true, - "format": "date-time", - "title": "Date/Time this version was made available", - "type": "string" + { + "backref": "focus_observation", + "label": "Observation_focus_ResearchStudy_focus_observation", + "multiplicity": "many_to_many", + "name": "focus", + "required": false, + "target_type": "research_study" }, - "method": { - "binding_description": "Methods for simple observations.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-methods", - "binding_version": null, - "description": "text representation. Indicates the mechanism used to perform the observation.", - "element_property": true, - "term": { - "description": "Methods for simple observations.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-methods", + { + "backref": "specimen_observation", + "label": "Observation_specimen_Specimen_specimen_observation", + "multiplicity": "many_to_many", + "name": "specimen_Specimen", + "required": false, + "target_type": "specimen" + } + ], + "program": "*", + "project": "*", + "properties": { + "basedOn": { + "backref": "basedOn_observation", + "description": "[Text representation of Reference] A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.", + "element_property": true, + "enum_reference_types": [ + "CarePlan", + "DeviceRequest", + "ImmunizationRecommendation", + "MedicationRequest", + "NutritionOrder", + "ServiceRequest" + ], + "items": { + "type": "string" + }, + "title": "Fulfills plan, proposal or order", + "type": "array" + }, + "bodySite": { + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "text representation. Indicates the site on the subject's body where the observation was made (i.e. the target site).", + "element_property": true, + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/observation-methods", - "term_url": "http://hl7.org/fhir/ValueSet/observation-methods" + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" } }, - "title": "How it was done", + "title": "Observed body part", "type": "string" }, - "method_coding": { - "binding_description": "Methods for simple observations.", + "bodySite_coding": { + "binding_description": "SNOMED CT Body site concepts", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-methods", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", "binding_version": null, - "description": "[system#code representation.] Indicates the mechanism used to perform the observation.", + "description": "[system#code representation.] Indicates the site on the subject's body where the observation was made (i.e. the target site).", "element_property": true, "term": { - "description": "Methods for simple observations.", + "description": "SNOMED CT Body site concepts", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-methods", + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/observation-methods", - "term_url": "http://hl7.org/fhir/ValueSet/observation-methods" + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" } }, - "title": "How it was done", + "title": "Observed body part", "type": "string" }, - "method_text": { - "binding_description": "Methods for simple observations.", + "bodySite_text": { + "binding_description": "SNOMED CT Body site concepts", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-methods", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", "binding_version": null, - "description": "[system#code representation.] Indicates the mechanism used to perform the observation.", + "description": "[system#code representation.] Indicates the site on the subject's body where the observation was made (i.e. the target site).", "element_property": true, "term": { - "description": "Methods for simple observations.", + "description": "SNOMED CT Body site concepts", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/observation-methods", + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/observation-methods", - "term_url": "http://hl7.org/fhir/ValueSet/observation-methods" + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" } }, - "title": "How it was done", + "title": "Observed body part", "type": "string" }, - "note": { - "description": "[Text representation of Annotation] Comments about the observation or the results.", + "bodyStructure": { + "backref": "observation", + "description": "[Text representation of Reference] Indicates the body structure on the subject's body where the observation was made (i.e. the target site).", + "element_property": true, + "enum_reference_types": [ + "BodyStructure" + ], + "title": "Observed body structure", + "type": "string" + }, + "category": { + "binding_description": "Codes for high level observation categories.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-category", + "binding_version": null, + "description": "text representation. A code that classifies the general type of observation being made.", "element_property": true, "items": { "type": "string" }, - "title": "Comments about the observation", + "term": { + "description": "Codes for high level observation categories.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/observation-category", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/observation-category", + "term_url": "http://hl7.org/fhir/ValueSet/observation-category" + } + }, + "title": "Classification of type of observation", "type": "array" }, - "partOf": { - "backref": "partOf_observation", - "description": "[Text representation of Reference] A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", + "category_coding": { + "binding_description": "Codes for high level observation categories.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-category", + "binding_version": null, + "description": "[system#code representation.] A code that classifies the general type of observation being made.", "element_property": true, - "enum_reference_types": [ - "MedicationAdministration", - "MedicationDispense", - "MedicationStatement", - "Procedure", - "Immunization", - "ImagingStudy", - "GenomicStudy" - ], "items": { "type": "string" }, - "title": "Part of referenced event", + "term": { + "description": "Codes for high level observation categories.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/observation-category", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/observation-category", + "term_url": "http://hl7.org/fhir/ValueSet/observation-category" + } + }, + "title": "Classification of type of observation", "type": "array" }, - "performer": { - "backref": "performer_observation", - "description": "[Text representation of Reference] Who was responsible for asserting the observed value as \"true\".", + "category_text": { + "binding_description": "Codes for high level observation categories.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-category", + "binding_version": null, + "description": "[system#code representation.] A code that classifies the general type of observation being made.", "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "CareTeam", - "Patient", - "RelatedPerson" - ], "items": { "type": "string" }, - "title": "Who is responsible for the observation", + "term": { + "description": "Codes for high level observation categories.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/observation-category", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/observation-category", + "term_url": "http://hl7.org/fhir/ValueSet/observation-category" + } + }, + "title": "Classification of type of observation", "type": "array" }, - "project_id": { + "code": { + "binding_description": "LDL Cholesterol codes - measured or calculated.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "binding_version": null, + "description": "text representation. Describes what was observed. Sometimes this is called the observation \"name\".", + "element_property": true, "term": { - "$ref": "_terms.yaml#/project_id" + "description": "LDL Cholesterol codes - measured or calculated.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "term_url": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes" + } }, + "title": "Type of observation (code / type)", "type": "string" }, - "referenceRange": { - "description": "[Text representation of ObservationReferenceRange] Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.", + "code_coding": { + "binding_description": "LDL Cholesterol codes - measured or calculated.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "binding_version": null, + "description": "[system#code representation.] Describes what was observed. Sometimes this is called the observation \"name\".", "element_property": true, - "items": { - "type": "string" + "term": { + "description": "LDL Cholesterol codes - measured or calculated.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "term_url": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes" + } }, - "title": "Provides guide for interpretation", - "type": "array" - }, - "resourceType": { - "const": "Observation", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", + "title": "Type of observation (code / type)", "type": "string" }, - "specimen": { - "backref": "specimen_observation", - "description": "[Text representation of Reference] The specimen that was used when this observation was made.", + "code_text": { + "binding_description": "LDL Cholesterol codes - measured or calculated.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "binding_version": null, + "description": "[system#code representation.] Describes what was observed. Sometimes this is called the observation \"name\".", "element_property": true, - "enum_reference_types": [ - "Specimen", - "Group" - ], - "title": "Specimen used for this observation", + "term": { + "description": "LDL Cholesterol codes - measured or calculated.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes", + "term_url": "http://hl7.org/fhir/ValueSet/lipid-ldl-codes" + } + }, + "title": "Type of observation (code / type)", "type": "string" }, - "status": { - "binding_description": "Codes providing the status of an observation.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/observation-status", - "binding_version": "5.0.0", - "description": "The status of the result value.", - "element_property": true, - "element_required": true, - "enum_values": [ - "registered", - "preliminary", - "final", - "amended", - "+" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "registered | preliminary | final | amended +", - "type": "string" - }, - "subject": { - "backref": "subject_observation", - "description": "[Text representation of Reference] The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.", + "component": { + "description": "[Text representation of ObservationComponent] Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.", "element_property": true, - "enum_reference_types": [ - "Patient", - "Group", - "Device", - "Location", - "Organization", - "Procedure", - "Practitioner", - "Medication", - "Substance", - "BiologicallyDerivedProduct", - "NutritionProduct" - ], - "title": "Who and/or what the observation is about", - "type": "string" + "items": { + "type": "string" + }, + "title": "Component results", + "type": "array" }, - "triggeredBy": { - "description": "[Text representation of ObservationTriggeredBy] Identifies the observation(s) that triggered the performance of this observation.", - "element_property": true, + "condition_identifier": { + "description": "Denormalized condition identifier", "items": { "type": "string" }, - "title": "Triggering observation(s)", "type": "array" }, - "valueAttachment": { - "description": "[Text representation of Attachment] The information determined as a result of making the observation, if the information has a simple value.", + "dataAbsentReason": { + "binding_description": "Codes specifying why the result (`Observation.value[x]`) is missing.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "binding_version": null, + "description": "text representation. Provides a reason why the expected value in the element Observation.value[x] is missing.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", + "term": { + "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/data-absent-reason" + } + }, + "title": "Why the result is missing", "type": "string" }, - "valueBoolean": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", + "dataAbsentReason_coding": { + "binding_description": "Codes specifying why the result (`Observation.value[x]`) is missing.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "binding_version": null, + "description": "[system#code representation.] Provides a reason why the expected value in the element Observation.value[x] is missing.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", - "type": "boolean" + "term": { + "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/data-absent-reason" + } + }, + "title": "Why the result is missing", + "type": "string" }, - "valueCodeableConcept": { - "description": "text representation. The information determined as a result of making the observation, if the information has a simple value.", + "dataAbsentReason_text": { + "binding_description": "Codes specifying why the result (`Observation.value[x]`) is missing.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "binding_version": null, + "description": "[system#code representation.] Provides a reason why the expected value in the element Observation.value[x] is missing.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", + "term": { + "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/data-absent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/data-absent-reason" + } + }, + "title": "Why the result is missing", "type": "string" }, - "valueCodeableConcept_coding": { - "description": "[system#code representation.] The information determined as a result of making the observation, if the information has a simple value.", + "derivedFrom": { + "backref": "derivedFrom_observation", + "description": "[Text representation of Reference] The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", - "type": "string" + "enum_reference_types": [ + "DocumentReference", + "ImagingStudy", + "ImagingSelection", + "QuestionnaireResponse", + "Observation", + "MolecularSequence", + "GenomicStudy" + ], + "items": { + "type": "string" + }, + "title": "Related resource from which the observation is made", + "type": "array" }, - "valueCodeableConcept_text": { - "description": "[system#code representation.] The information determined as a result of making the observation, if the information has a simple value.", + "device": { + "backref": "device_observation", + "description": "[Text representation of Reference] A reference to the device that generates the measurements or the device settings for the device", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", + "enum_reference_types": [ + "Device", + "DeviceMetric" + ], + "title": "A reference to the device that generates the measurements or the device settings for the device", "type": "string" }, - "valueDateTime": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", + "effectiveDateTime": { + "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", "element_property": true, "format": "date-time", - "one_of_many": "value", + "one_of_many": "effective", "one_of_many_required": false, - "title": "Actual result", + "title": "Clinically relevant time/time-period for observation", "type": "string" }, - "valueInteger": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", + "effectiveInstant": { + "description": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", "element_property": true, - "one_of_many": "value", + "format": "date-time", + "one_of_many": "effective", "one_of_many_required": false, - "title": "Actual result", - "type": "integer" + "title": "Clinically relevant time/time-period for observation", + "type": "string" }, - "valuePeriod": { - "description": "[Text representation of Period] The information determined as a result of making the observation, if the information has a simple value.", + "effectivePeriod": { + "description": "[Text representation of Period] The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", "element_property": true, - "one_of_many": "value", + "one_of_many": "effective", "one_of_many_required": false, - "title": "Actual result", + "title": "Clinically relevant time/time-period for observation", "type": "string" }, - "valueQuantity": { - "description": "[Text representation of Quantity] text representation. The information determined as a result of making the observation, if the information has a simple value.", + "effectiveTiming": { + "description": "[Text representation of Timing] The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.", "element_property": true, - "one_of_many": "value", + "one_of_many": "effective", "one_of_many_required": false, - "title": "Actual result", + "title": "Clinically relevant time/time-period for observation", "type": "string" }, - "valueQuantity_unit": { - "title": "Unit representation. Actual result", + "encounter": { + "backref": "observation", + "description": "[Text representation of Reference] The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "Healthcare event during which this observation is made", "type": "string" }, - "valueQuantity_value": { - "title": "Numerical value (with implicit precision) representation. Actual result", - "type": "number" - }, - "valueRange": { - "description": "[Text representation of Range] The information determined as a result of making the observation, if the information has a simple value.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", - "type": "string" + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" }, - "valueRatio": { - "description": "[Text representation of Ratio] The information determined as a result of making the observation, if the information has a simple value.", + "focus": { + "backref": "focus_observation", + "description": "[Text representation of Reference] The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", - "type": "string" + "enum_reference_types": [ + "ResearchStudy" + ], + "items": { + "type": "string" + }, + "title": "What the observation is about, when it is not about the subject of record", + "type": "array" }, - "valueReference": { - "backref": "valueReference_observation", - "description": "[Text representation of Reference] The information determined as a result of making the observation, if the information has a simple value.", + "hasMember": { + "backref": "hasMember_observation", + "description": "[Text representation of Reference] This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.", "element_property": true, "enum_reference_types": [ + "Observation", + "QuestionnaireResponse", "MolecularSequence" ], - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", - "type": "string" + "items": { + "type": "string" + }, + "title": "Related resource that belongs to the Observation group", + "type": "array" }, - "valueSampledData": { - "description": "[Text representation of SampledData] The information determined as a result of making the observation, if the information has a simple value.", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", "type": "string" }, - "valueString": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", + "identifier": { + "description": "A unique identifier assigned to this observation.", "element_property": true, - "one_of_many": "value", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Actual result", - "type": "string" + "items": { + "type": "string" + }, + "title": "Business Identifier for observation", + "type": "array" }, - "valueTime": { - "description": "The information determined as a result of making the observation, if the information has a simple value.", + "identifier_coding": { + "description": "[system#code representation of identifier] A unique identifier assigned to this observation.", "element_property": true, - "format": "time", - "one_of_many": "value", - "one_of_many_required": false, - "title": "Actual result", - "type": "string" - } - }, - "systemProperties": [ - "id" - ], - "title": "Observation", - "type": "object", - "uniqueKeys": [ - [ - "id" - ] - ] - }, - "research_study.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": true, - "category": "Administrative", - "description": "Investigation to increase healthcare-related patient-independent knowledge. A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future. [See https://hl7.org/fhir/R5/ResearchStudy.html]", - "id": "research_study", - "links": [ - { - "backref": "focus_research_study", - "label": "ResearchStudy_focus_Medication_focus_research_study", - "multiplicity": "many_to_many", - "name": "focus_Medication", - "required": false, - "target_type": "medication" - }, - { - "backref": "partOf_research_study", - "label": "ResearchStudy_partOf_ResearchStudy_partOf_research_study", - "multiplicity": "many_to_many", - "name": "partOf", - "required": false, - "target_type": "research_study" + "items": { + "type": "string" + }, + "title": "Business Identifier for observation", + "type": "array" }, - { - "backref": "research_study", - "label": "ResearchStudy_gen3_project_Project_research_study", - "multiplicity": "many_to_many", - "name": "gen3_project", - "required": false, - "target_type": "project" - } - ], - "program": "*", - "project": "*", - "properties": { - "associatedParty": { - "description": "[Text representation of ResearchStudyAssociatedParty] Sponsors, collaborators, and other parties", + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] A unique identifier assigned to this observation.", "element_property": true, "items": { "type": "string" }, - "title": "Sponsors, collaborators, and other parties", + "title": "Business Identifier for observation", "type": "array" }, - "classifier": { - "binding_description": "desc.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "instantiatesCanonical": { + "description": "The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.", + "element_property": true, + "enum_reference_types": [ + "ObservationDefinition" + ], + "one_of_many": "instantiates", + "one_of_many_required": false, + "pattern": "\\S*", + "title": "Instantiates FHIR ObservationDefinition", + "type": "string" + }, + "instantiatesReference": { + "backref": "observation", + "description": "[Text representation of Reference] The reference to a FHIR ObservationDefinition resource that provides the definition that is adhered to in whole or in part by this Observation instance.", + "element_property": true, + "enum_reference_types": [ + "ObservationDefinition" + ], + "one_of_many": "instantiates", + "one_of_many_required": false, + "title": "Instantiates FHIR ObservationDefinition", + "type": "string" + }, + "interpretation": { + "binding_description": "Codes identifying interpretations of observations.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-interpretation", "binding_version": null, - "description": "text representation. Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.", + "description": "text representation. A categorical assessment of an observation value. For example, high, low, normal.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "desc.", + "description": "Codes identifying interpretations of observations.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "cde_id": "http://hl7.org/fhir/ValueSet/observation-interpretation", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-classifiers", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-classifiers" + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "term_url": "http://hl7.org/fhir/ValueSet/observation-interpretation" } }, - "title": "Classification for the study", + "title": "High, low, normal, etc", "type": "array" }, - "classifier_coding": { - "binding_description": "desc.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "interpretation_coding": { + "binding_description": "Codes identifying interpretations of observations.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-interpretation", "binding_version": null, - "description": "[system#code representation.] Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.", + "description": "[system#code representation.] A categorical assessment of an observation value. For example, high, low, normal.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "desc.", + "description": "Codes identifying interpretations of observations.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "cde_id": "http://hl7.org/fhir/ValueSet/observation-interpretation", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-classifiers", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-classifiers" + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "term_url": "http://hl7.org/fhir/ValueSet/observation-interpretation" } }, - "title": "Classification for the study", + "title": "High, low, normal, etc", "type": "array" }, - "classifier_text": { - "binding_description": "desc.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "interpretation_text": { + "binding_description": "Codes identifying interpretations of observations.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-interpretation", "binding_version": null, - "description": "[system#code representation.] Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.", + "description": "[system#code representation.] A categorical assessment of an observation value. For example, high, low, normal.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "desc.", + "description": "Codes identifying interpretations of observations.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "cde_id": "http://hl7.org/fhir/ValueSet/observation-interpretation", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-classifiers", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-classifiers" + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/observation-interpretation", + "term_url": "http://hl7.org/fhir/ValueSet/observation-interpretation" } }, - "title": "Classification for the study", + "title": "High, low, normal, etc", "type": "array" }, - "comparisonGroup": { - "description": "[Text representation of ResearchStudyComparisonGroup] Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.", + "issued": { + "description": "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Defined path through the study for a subject", - "type": "array" + "format": "date-time", + "title": "Date/Time this version was made available", + "type": "string" }, - "condition": { - "binding_description": "Identification of the condition or diagnosis.", + "method": { + "binding_description": "Methods for simple observations.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-methods", "binding_version": null, - "description": "text representation. The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.", + "description": "text representation. Indicates the mechanism used to perform the observation.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "Identification of the condition or diagnosis.", + "description": "Methods for simple observations.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_id": "http://hl7.org/fhir/ValueSet/observation-methods", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + "term": "http://hl7.org/fhir/ValueSet/observation-methods", + "term_url": "http://hl7.org/fhir/ValueSet/observation-methods" } }, - "title": "Condition being studied", - "type": "array" + "title": "How it was done", + "type": "string" }, - "condition_coding": { - "binding_description": "Identification of the condition or diagnosis.", + "method_coding": { + "binding_description": "Methods for simple observations.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-methods", "binding_version": null, - "description": "[system#code representation.] The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.", + "description": "[system#code representation.] Indicates the mechanism used to perform the observation.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "Identification of the condition or diagnosis.", + "description": "Methods for simple observations.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_id": "http://hl7.org/fhir/ValueSet/observation-methods", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + "term": "http://hl7.org/fhir/ValueSet/observation-methods", + "term_url": "http://hl7.org/fhir/ValueSet/observation-methods" } }, - "title": "Condition being studied", - "type": "array" + "title": "How it was done", + "type": "string" }, - "condition_text": { - "binding_description": "Identification of the condition or diagnosis.", + "method_text": { + "binding_description": "Methods for simple observations.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-methods", "binding_version": null, - "description": "[system#code representation.] The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.", + "description": "[system#code representation.] Indicates the mechanism used to perform the observation.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "Identification of the condition or diagnosis.", + "description": "Methods for simple observations.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_id": "http://hl7.org/fhir/ValueSet/observation-methods", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + "term": "http://hl7.org/fhir/ValueSet/observation-methods", + "term_url": "http://hl7.org/fhir/ValueSet/observation-methods" } }, - "title": "Condition being studied", - "type": "array" - }, - "date": { - "description": "The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.", - "element_property": true, - "format": "date-time", - "title": "Date the resource last changed", + "title": "How it was done", "type": "string" }, - "description": { - "description": "A detailed and human-readable narrative of the study. E.g., study abstract.", - "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Detailed narrative of the study", - "type": "string" - }, - "descriptionSummary": { - "description": "A brief text for explaining the study.", - "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Brief text explaining the study", - "type": "string" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "note": { + "description": "[Text representation of Annotation] Comments about the observation or the results.", "element_property": true, "items": { "type": "string" }, - "title": "Additional content defined by implementations", + "title": "Comments about the observation", "type": "array" }, - "focus": { - "backref": "focus_research_study", - "binding_description": "Common codes of research study focus", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "binding_version": null, - "description": "text representation. The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", + "partOf": { + "backref": "partOf_observation", + "description": "[Text representation of Reference] A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.", "element_property": true, "enum_reference_types": [ - "Medication", - "MedicinalProductDefinition", - "SubstanceDefinition", - "EvidenceVariable" + "MedicationAdministration", + "MedicationDispense", + "MedicationStatement", + "Procedure", + "Immunization", + "ImagingStudy", + "GenomicStudy" ], "items": { "type": "string" }, - "term": { - "description": "Common codes of research study focus", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-focus-type" - } + "title": "Part of referenced event", + "type": "array" + }, + "patient_identifier": { + "description": "Denormalized patient identifier", + "items": { + "type": "string" }, - "title": "Drugs, devices, etc. under study", "type": "array" }, - "focus_coding": { - "backref": "focus_research_study", - "binding_description": "Common codes of research study focus", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "binding_version": null, - "description": "[system#code representation.] The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", + "performer": { + "backref": "performer_observation", + "description": "[Text representation of Reference] Who was responsible for asserting the observed value as \"true\".", "element_property": true, "enum_reference_types": [ - "Medication", - "MedicinalProductDefinition", - "SubstanceDefinition", - "EvidenceVariable" + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam", + "Patient", + "RelatedPerson" ], "items": { "type": "string" }, + "title": "Who is responsible for the observation", + "type": "array" + }, + "project_id": { "term": { - "description": "Common codes of research study focus", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-focus-type" - } + "$ref": "_terms.yaml#/project_id" }, - "title": "Drugs, devices, etc. under study", - "type": "array" + "type": "string" }, - "focus_text": { - "backref": "focus_research_study", - "binding_description": "Common codes of research study focus", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "binding_version": null, - "description": "[system#code representation.] The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", + "referenceRange": { + "description": "[Text representation of ObservationReferenceRange] Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an \"OR\". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.", "element_property": true, - "enum_reference_types": [ - "Medication", - "MedicinalProductDefinition", - "SubstanceDefinition", - "EvidenceVariable" - ], "items": { "type": "string" }, - "term": { - "description": "Common codes of research study focus", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-focus-type", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-focus-type" - } - }, - "title": "Drugs, devices, etc. under study", + "title": "Provides guide for interpretation", "type": "array" }, - "gen3_project": { - "backref": "research_study", - "description": "[Text representation of Reference] The Gen3 project this study belongs to. Used to generate link.", - "enum_reference_types": [ - "Project" - ], - "title": "The Gen3 project this study belongs to.", + "resourceType": { + "const": "Observation", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "specimen": { + "backref": "specimen_observation", + "description": "[Text representation of Reference] The specimen that was used when this observation was made.", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", + "enum_reference_types": [ + "Specimen", + "Group" + ], + "title": "Specimen used for this observation", "type": "string" }, - "identifier": { - "description": "Identifiers assigned to this research study by the sponsor or other systems.", - "element_property": true, + "specimen_identifier": { + "description": "Denormalized specimen identifier", "items": { "type": "string" }, - "title": "Business Identifier for study", "type": "array" }, - "identifier_coding": { - "description": "[system#code representation of identifier] Identifiers assigned to this research study by the sponsor or other systems.", + "status": { + "binding_description": "Codes providing the status of an observation.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/observation-status", + "binding_version": "5.0.0", + "description": "The status of the result value.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Business Identifier for study", - "type": "array" + "element_required": true, + "enum_values": [ + "registered", + "preliminary", + "final", + "amended", + "+" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "registered | preliminary | final | amended +", + "type": "string" }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Identifiers assigned to this research study by the sponsor or other systems.", + "subject": { + "backref": "subject_observation", + "description": "[Text representation of Reference] The patient, or group of patients, location, device, organization, procedure or practitioner this observation is about and into whose or what record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Business Identifier for study", - "type": "array" + "enum_reference_types": [ + "Patient", + "Group", + "Device", + "Location", + "Organization", + "Procedure", + "Practitioner", + "Medication", + "Substance", + "BiologicallyDerivedProduct", + "NutritionProduct" + ], + "title": "Who and/or what the observation is about", + "type": "string" }, - "keyword": { - "description": "text representation. Key terms to aid in searching for or filtering the study.", + "triggeredBy": { + "description": "[Text representation of ObservationTriggeredBy] Identifies the observation(s) that triggered the performance of this observation.", "element_property": true, "items": { "type": "string" }, - "title": "Used to search for the study", + "title": "Triggering observation(s)", "type": "array" }, - "keyword_coding": { - "description": "[system#code representation.] Key terms to aid in searching for or filtering the study.", + "valueAttachment": { + "description": "[Text representation of Attachment] The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Used to search for the study", - "type": "array" + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" }, - "keyword_text": { - "description": "[system#code representation.] Key terms to aid in searching for or filtering the study.", + "valueBoolean": { + "description": "The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Used to search for the study", - "type": "array" + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "boolean" }, - "label_": { - "description": "[Text representation of ResearchStudyLabel] Additional names for the study", + "valueCodeableConcept": { + "description": "text representation. The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Additional names for the study", - "type": "array" + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" }, - "name": { - "description": "Name for this study (computer friendly)", + "valueCodeableConcept_coding": { + "description": "[system#code representation.] The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Name for this study (computer friendly)", + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", "type": "string" }, - "note": { - "description": "[Text representation of Annotation] Comments made about the study by the performer, subject or other participants.", + "valueCodeableConcept_text": { + "description": "[system#code representation.] The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Comments made about the study", - "type": "array" + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" }, - "objective": { - "description": "[Text representation of ResearchStudyObjective] A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.", + "valueDateTime": { + "description": "The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, - "items": { - "type": "string" - }, - "title": "A goal for the study", - "type": "array" + "format": "date-time", + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" }, - "outcomeMeasure": { - "description": "[Text representation of ResearchStudyOutcomeMeasure] An \"outcome measure\", \"endpoint\", \"effect measure\" or \"measure of effect\" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.", + "valueInteger": { + "description": "The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, - "items": { - "type": "string" - }, - "title": "A variable measured during the study", - "type": "array" + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "integer" }, - "partOf": { - "backref": "partOf_research_study", - "description": "[Text representation of Reference] A larger research study of which this particular study is a component or step.", + "valuePeriod": { + "description": "[Text representation of Period] The information determined as a result of making the observation, if the information has a simple value.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" + }, + "valueQuantity": { + "description": "[Text representation of Quantity] text representation. The information determined as a result of making the observation, if the information has a simple value.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" + }, + "valueQuantity_unit": { + "title": "Unit representation. Actual result", + "type": "string" + }, + "valueQuantity_value": { + "title": "Numerical value (with implicit precision) representation. Actual result", + "type": "number" + }, + "valueRange": { + "description": "[Text representation of Range] The information determined as a result of making the observation, if the information has a simple value.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" + }, + "valueRatio": { + "description": "[Text representation of Ratio] The information determined as a result of making the observation, if the information has a simple value.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" + }, + "valueReference": { + "backref": "valueReference_observation", + "description": "[Text representation of Reference] The information determined as a result of making the observation, if the information has a simple value.", "element_property": true, "enum_reference_types": [ - "ResearchStudy" + "MolecularSequence" ], + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" + }, + "valueSampledData": { + "description": "[Text representation of SampledData] The information determined as a result of making the observation, if the information has a simple value.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" + }, + "valueString": { + "description": "The information determined as a result of making the observation, if the information has a simple value.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Actual result", + "type": "string" + }, + "valueTime": { + "description": "The information determined as a result of making the observation, if the information has a simple value.", + "element_property": true, + "format": "time", + "one_of_many": "value", + "one_of_many_required": false, + "title": "Actual result", + "type": "string" + } + }, + "systemProperties": [ + "id" + ], + "title": "Observation", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "research_study.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Administrative", + "description": "Investigation to increase healthcare-related patient-independent knowledge. A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future. [See https://hl7.org/fhir/R5/ResearchStudy.html]", + "id": "research_study", + "links": [ + { + "backref": "partOf_research_study", + "label": "ResearchStudy_partOf_ResearchStudy_partOf_research_study", + "multiplicity": "many_to_many", + "name": "partOf", + "required": false, + "target_type": "research_study" + }, + { + "backref": "research_study", + "label": "ResearchStudy_gen3_project_Project_research_study", + "multiplicity": "many_to_many", + "name": "gen3_project", + "required": false, + "target_type": "project" + } + ], + "program": "*", + "project": "*", + "properties": { + "associatedParty": { + "description": "[Text representation of ResearchStudyAssociatedParty] Sponsors, collaborators, and other parties", + "element_property": true, "items": { "type": "string" }, - "title": "Part of larger study", + "title": "Sponsors, collaborators, and other parties", "type": "array" }, - "period": { - "description": "[Text representation of Period] Identifies the start date and the expected (or actual, depending on status) end date for the study.", - "element_property": true, - "title": "When the study began and ended", - "type": "string" - }, - "phase": { - "binding_description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "classifier": { + "binding_description": "desc.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-phase", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-classifiers", "binding_version": null, - "description": "text representation. The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "description": "text representation. Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "description": "desc.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-phase", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-classifiers", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-phase", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-phase" + "term": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-classifiers" } }, - "title": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4", - "type": "string" + "title": "Classification for the study", + "type": "array" }, - "phase_coding": { - "binding_description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "classifier_coding": { + "binding_description": "desc.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-phase", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-classifiers", "binding_version": null, - "description": "[system#code representation.] The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "description": "[system#code representation.] Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "description": "desc.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-phase", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-classifiers", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-phase", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-phase" + "term": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-classifiers" } }, - "title": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4", - "type": "string" + "title": "Classification for the study", + "type": "array" }, - "phase_text": { - "binding_description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "classifier_text": { + "binding_description": "desc.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-phase", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-classifiers", "binding_version": null, - "description": "[system#code representation.] The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "description": "[system#code representation.] Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", + "description": "desc.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-phase", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-classifiers", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-phase", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-phase" + "term": "http://hl7.org/fhir/ValueSet/research-study-classifiers", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-classifiers" } }, - "title": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4", - "type": "string" + "title": "Classification for the study", + "type": "array" }, - "primaryPurposeType": { - "binding_description": "Codes for the main intent of the study.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "comparisonGroup": { + "description": "[Text representation of ResearchStudyComparisonGroup] Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Defined path through the study for a subject", + "type": "array" + }, + "condition": { + "binding_description": "Identification of the condition or diagnosis.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", "binding_version": null, - "description": "text representation. The type of study based upon the intent of the study activities. A classification of the intent of the study.", + "description": "text representation. The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "Codes for the main intent of the study.", + "description": "Identification of the condition or diagnosis.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" } }, - "title": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility", - "type": "string" + "title": "Condition being studied", + "type": "array" }, - "primaryPurposeType_coding": { - "binding_description": "Codes for the main intent of the study.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "condition_coding": { + "binding_description": "Identification of the condition or diagnosis.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", "binding_version": null, - "description": "[system#code representation.] The type of study based upon the intent of the study activities. A classification of the intent of the study.", + "description": "[system#code representation.] The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "Codes for the main intent of the study.", + "description": "Identification of the condition or diagnosis.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" } }, - "title": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility", - "type": "string" + "title": "Condition being studied", + "type": "array" }, - "primaryPurposeType_text": { - "binding_description": "Codes for the main intent of the study.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "condition_text": { + "binding_description": "Identification of the condition or diagnosis.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", "binding_version": null, - "description": "[system#code representation.] The type of study based upon the intent of the study activities. A classification of the intent of the study.", + "description": "[system#code representation.] The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion \"healthy volunteer\", but the target condition code would be a Lupus SNOMED code.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "Codes for the main intent of the study.", + "description": "Identification of the condition or diagnosis.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" } }, - "title": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility", + "title": "Condition being studied", + "type": "array" + }, + "date": { + "description": "The date (and optionally time) when the ResearchStudy Resource was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ResearchStudy Resource changes.", + "element_property": true, + "format": "date-time", + "title": "Date the resource last changed", "type": "string" }, - "progressStatus": { - "description": "[Text representation of ResearchStudyProgressStatus] Status of study with time for that status", + "description": { + "description": "A detailed and human-readable narrative of the study. E.g., study abstract.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Status of study with time for that status", - "type": "array" + "pattern": "\\s*(\\S|\\s)*", + "title": "Detailed narrative of the study", + "type": "string" }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" - }, + "descriptionSummary": { + "description": "A brief text for explaining the study.", + "element_property": true, + "pattern": "\\s*(\\S|\\s)*", + "title": "Brief text explaining the study", "type": "string" }, - "protocol": { - "backref": "protocol_research_study", - "description": "[Text representation of Reference] The set of steps expected to be performed as part of the execution of the study.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, - "enum_reference_types": [ - "PlanDefinition" - ], "items": { "type": "string" }, - "title": "Steps followed in executing study", + "title": "Additional content defined by implementations", "type": "array" }, - "recruitment": { - "description": "[Text representation of ResearchStudyRecruitment] Target or actual group of participants enrolled in study", - "element_property": true, - "title": "Target or actual group of participants enrolled in study", - "type": "string" - }, - "region": { - "binding_description": "Countries and regions within which this artifact is targeted for use.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/jurisdiction", + "focus": { + "backref": "focus_research_study", + "binding_description": "Common codes of research study focus", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-focus-type", "binding_version": null, - "description": "text representation. A country, state or other area where the study is taking place rather than its precise geographic location or address.", + "description": "text representation. The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", "element_property": true, + "enum_reference_types": [ + "Medication", + "MedicinalProductDefinition", + "SubstanceDefinition", + "EvidenceVariable" + ], "items": { "type": "string" }, "term": { - "description": "Countries and regions within which this artifact is targeted for use.", + "description": "Common codes of research study focus", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/jurisdiction", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-focus-type", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/jurisdiction", - "term_url": "http://hl7.org/fhir/ValueSet/jurisdiction" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/research-study-focus-type", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-focus-type" } }, - "title": "Geographic area for the study", + "title": "Drugs, devices, etc. under study", "type": "array" }, - "region_coding": { - "binding_description": "Countries and regions within which this artifact is targeted for use.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/jurisdiction", + "focus_coding": { + "backref": "focus_research_study", + "binding_description": "Common codes of research study focus", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-focus-type", "binding_version": null, - "description": "[system#code representation.] A country, state or other area where the study is taking place rather than its precise geographic location or address.", + "description": "[system#code representation.] The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", "element_property": true, + "enum_reference_types": [ + "Medication", + "MedicinalProductDefinition", + "SubstanceDefinition", + "EvidenceVariable" + ], "items": { "type": "string" }, "term": { - "description": "Countries and regions within which this artifact is targeted for use.", + "description": "Common codes of research study focus", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/jurisdiction", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-focus-type", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/jurisdiction", - "term_url": "http://hl7.org/fhir/ValueSet/jurisdiction" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/research-study-focus-type", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-focus-type" } }, - "title": "Geographic area for the study", + "title": "Drugs, devices, etc. under study", "type": "array" }, - "region_text": { - "binding_description": "Countries and regions within which this artifact is targeted for use.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/jurisdiction", + "focus_text": { + "backref": "focus_research_study", + "binding_description": "Common codes of research study focus", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-focus-type", "binding_version": null, - "description": "[system#code representation.] A country, state or other area where the study is taking place rather than its precise geographic location or address.", + "description": "[system#code representation.] The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.", "element_property": true, + "enum_reference_types": [ + "Medication", + "MedicinalProductDefinition", + "SubstanceDefinition", + "EvidenceVariable" + ], "items": { "type": "string" }, "term": { - "description": "Countries and regions within which this artifact is targeted for use.", + "description": "Common codes of research study focus", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/jurisdiction", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-focus-type", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/jurisdiction", - "term_url": "http://hl7.org/fhir/ValueSet/jurisdiction" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/research-study-focus-type", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-focus-type" } }, - "title": "Geographic area for the study", + "title": "Drugs, devices, etc. under study", "type": "array" }, - "relatedArtifact": { - "description": "[Text representation of RelatedArtifact] Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of \"documentation\" or \"supported-with\" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.", + "gen3_project": { + "backref": "research_study", + "description": "[Text representation of Reference] The Gen3 project this study belongs to. Used to generate link.", + "enum_reference_types": [ + "Project" + ], + "title": "The Gen3 project this study belongs to.", + "type": "string" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Identifiers assigned to this research study by the sponsor or other systems.", "element_property": true, "items": { "type": "string" }, - "title": "References, URLs, and attachments", + "title": "Business Identifier for study", "type": "array" }, - "resourceType": { - "const": "ResearchStudy", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "result": { - "backref": "result_research_study", - "description": "[Text representation of Reference] Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov.", + "identifier_coding": { + "description": "[system#code representation of identifier] Identifiers assigned to this research study by the sponsor or other systems.", "element_property": true, - "enum_reference_types": [ - "EvidenceReport", - "Citation", - "DiagnosticReport" - ], "items": { "type": "string" }, - "title": "Link to results generated during the study", + "title": "Business Identifier for study", "type": "array" }, - "site": { - "backref": "site_research_study", - "description": "[Text representation of Reference] A facility in which study activities are conducted.", + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Identifiers assigned to this research study by the sponsor or other systems.", "element_property": true, - "enum_reference_types": [ - "Location", - "ResearchStudy", - "Organization" - ], "items": { "type": "string" }, - "title": "Facility where study activities are conducted", + "title": "Business Identifier for study", "type": "array" }, - "status": { - "binding_description": "Codes that convey the current publication status of the research study resource.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/publication-status", - "binding_version": "5.0.0", - "description": "The publication state of the resource (not of the study).", + "keyword": { + "description": "text representation. Key terms to aid in searching for or filtering the study.", "element_property": true, - "element_required": true, - "enum_values": [ - "draft", - "active", - "retired", - "unknown" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "draft | active | retired | unknown", - "type": "string" + "items": { + "type": "string" + }, + "title": "Used to search for the study", + "type": "array" }, - "studyDesign": { - "binding_description": "This is a set of terms for study design characteristics.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/study-design", - "binding_version": null, - "description": "text representation. Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", + "keyword_coding": { + "description": "[system#code representation.] Key terms to aid in searching for or filtering the study.", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "This is a set of terms for study design characteristics.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/study-design", - "cde_version": null, - "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/study-design", - "term_url": "http://hl7.org/fhir/ValueSet/study-design" - } - }, - "title": "Classifications of the study design characteristics", + "title": "Used to search for the study", "type": "array" }, - "studyDesign_coding": { - "binding_description": "This is a set of terms for study design characteristics.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/study-design", - "binding_version": null, - "description": "[system#code representation.] Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", + "keyword_text": { + "description": "[system#code representation.] Key terms to aid in searching for or filtering the study.", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "This is a set of terms for study design characteristics.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/study-design", - "cde_version": null, - "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/study-design", - "term_url": "http://hl7.org/fhir/ValueSet/study-design" - } - }, - "title": "Classifications of the study design characteristics", + "title": "Used to search for the study", "type": "array" }, - "studyDesign_text": { - "binding_description": "This is a set of terms for study design characteristics.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/study-design", - "binding_version": null, - "description": "[system#code representation.] Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", + "label_": { + "description": "[Text representation of ResearchStudyLabel] Additional names for the study", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "This is a set of terms for study design characteristics.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/study-design", - "cde_version": null, - "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/study-design", - "term_url": "http://hl7.org/fhir/ValueSet/study-design" - } - }, - "title": "Classifications of the study design characteristics", + "title": "Additional names for the study", "type": "array" }, - "title": { - "description": "The human readable name of the research study.", + "name": { + "description": "Name for this study (computer friendly)", "element_property": true, "pattern": "[ \\r\\n\\t\\S]+", - "title": "Human readable name of the study", + "title": "Name for this study (computer friendly)", "type": "string" }, - "url": { - "description": "Canonical identifier for this study resource, represented as a globally unique URI.", + "note": { + "description": "[Text representation of Annotation] Comments made about the study by the performer, subject or other participants.", "element_property": true, - "pattern": "\\S*", - "title": "Canonical identifier for this study resource", - "type": "string" + "items": { + "type": "string" + }, + "title": "Comments made about the study", + "type": "array" }, - "version": { - "description": "The business version for the study record", + "objective": { + "description": "[Text representation of ResearchStudyObjective] A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "The business version for the study record", + "items": { + "type": "string" + }, + "title": "A goal for the study", + "type": "array" + }, + "outcomeMeasure": { + "description": "[Text representation of ResearchStudyOutcomeMeasure] An \"outcome measure\", \"endpoint\", \"effect measure\" or \"measure of effect\" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "A variable measured during the study", + "type": "array" + }, + "partOf": { + "backref": "partOf_research_study", + "description": "[Text representation of Reference] A larger research study of which this particular study is a component or step.", + "element_property": true, + "enum_reference_types": [ + "ResearchStudy" + ], + "items": { + "type": "string" + }, + "title": "Part of larger study", + "type": "array" + }, + "period": { + "description": "[Text representation of Period] Identifies the start date and the expected (or actual, depending on status) end date for the study.", + "element_property": true, + "title": "When the study began and ended", "type": "string" }, - "whyStopped": { - "binding_description": "Codes for why the study ended prematurely.", + "phase": { + "binding_description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-phase", "binding_version": null, - "description": "text representation. A description and/or code explaining the premature termination of the study.", + "description": "text representation. The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "element_property": true, "term": { - "description": "Codes for why the study ended prematurely.", + "description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-phase", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped" + "term": "http://hl7.org/fhir/ValueSet/research-study-phase", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-phase" } }, - "title": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design", + "title": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4", "type": "string" }, - "whyStopped_coding": { - "binding_description": "Codes for why the study ended prematurely.", + "phase_coding": { + "binding_description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-phase", "binding_version": null, - "description": "[system#code representation.] A description and/or code explaining the premature termination of the study.", + "description": "[system#code representation.] The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "element_property": true, "term": { - "description": "Codes for why the study ended prematurely.", + "description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-phase", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped" + "term": "http://hl7.org/fhir/ValueSet/research-study-phase", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-phase" } }, - "title": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design", + "title": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4", "type": "string" }, - "whyStopped_text": { - "binding_description": "Codes for why the study ended prematurely.", + "phase_text": { + "binding_description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-phase", "binding_version": null, - "description": "[system#code representation.] A description and/or code explaining the premature termination of the study.", + "description": "[system#code representation.] The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "element_property": true, "term": { - "description": "Codes for why the study ended prematurely.", + "description": "Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-phase", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", - "term_url": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped" + "term": "http://hl7.org/fhir/ValueSet/research-study-phase", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-phase" } }, - "title": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design", - "type": "string" - } - }, - "systemProperties": [ - "id" - ], - "title": "ResearchStudy", - "type": "object", - "uniqueKeys": [ - [ - "id" - ] - ] - }, - "patient.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": true, - "category": "Administrative", - "description": "Information about an individual or animal receiving health care services. Demographics and other administrative information about an individual or animal receiving care or other health-related services. [See https://hl7.org/fhir/R5/Patient.html]", - "id": "patient", - "links": [], - "program": "*", - "project": "*", - "properties": { - "active": { - "description": "Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.", - "element_property": true, - "title": "Whether this patient's record is in active use", - "type": "boolean" - }, - "address_postalCode": { - "description": "[Plucked from Patient.address] A postal code designating a region defined by the postal service.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Postal code for area", + "title": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4", "type": "string" }, - "birthDate": { - "description": "The date of birth for the individual", + "primaryPurposeType": { + "binding_description": "Codes for the main intent of the study.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "binding_version": null, + "description": "text representation. The type of study based upon the intent of the study activities. A classification of the intent of the study.", "element_property": true, - "format": "date", - "title": "The date of birth for the individual", + "term": { + "description": "Codes for the main intent of the study.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type" + } + }, + "title": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility", "type": "string" }, - "communication": { - "description": "[Text representation of PatientCommunication] A language which may be used to communicate with the patient about his or her health", + "primaryPurposeType_coding": { + "binding_description": "Codes for the main intent of the study.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "binding_version": null, + "description": "[system#code representation.] The type of study based upon the intent of the study activities. A classification of the intent of the study.", "element_property": true, - "items": { - "type": "string" + "term": { + "description": "Codes for the main intent of the study.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type" + } }, - "title": "A language which may be used to communicate with the patient about his or her health", - "type": "array" + "title": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility", + "type": "string" }, - "contact": { - "description": "[Text representation of PatientContact] A contact party (e.g. guardian, partner, friend) for the patient", + "primaryPurposeType_text": { + "binding_description": "Codes for the main intent of the study.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "binding_version": null, + "description": "[system#code representation.] The type of study based upon the intent of the study activities. A classification of the intent of the study.", "element_property": true, - "items": { - "type": "string" + "term": { + "description": "Codes for the main intent of the study.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-prim-purp-type" + } }, - "title": "A contact party (e.g. guardian, partner, friend) for the patient", - "type": "array" - }, - "deceasedBoolean": { - "description": "Indicates if the individual is deceased or not", - "element_property": true, - "one_of_many": "deceased", - "one_of_many_required": false, - "title": "Indicates if the individual is deceased or not", - "type": "boolean" - }, - "deceasedDateTime": { - "description": "Indicates if the individual is deceased or not", - "element_property": true, - "format": "date-time", - "one_of_many": "deceased", - "one_of_many_required": false, - "title": "Indicates if the individual is deceased or not", + "title": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility", "type": "string" }, - "disability_adjusted_life_years": { - "description": "[extension disability_adjusted_life_years] Disability Adjusted Life Years as defined in the literature and summarized at .", - "type": "number" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "progressStatus": { + "description": "[Text representation of ResearchStudyProgressStatus] Status of study with time for that status", "element_property": true, "items": { "type": "string" }, - "title": "Additional content defined by implementations", + "title": "Status of study with time for that status", "type": "array" }, - "gender": { - "binding_description": "The gender of a person used for administrative purposes.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", - "binding_version": "5.0.0", - "description": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.", - "element_property": true, - "enum_values": [ - "male", - "female", - "other", - "unknown" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "male | female | other | unknown", + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, "type": "string" }, - "generalPractitioner": { - "backref": "generalPractitioner_patient", - "description": "[Text representation of Reference] Patient's nominated care provider.", + "protocol": { + "backref": "protocol_research_study", + "description": "[Text representation of Reference] The set of steps expected to be performed as part of the execution of the study.", "element_property": true, "enum_reference_types": [ - "Organization", - "Practitioner", - "PractitionerRole" + "PlanDefinition" ], "items": { "type": "string" }, - "title": "Patient's nominated primary care provider", + "title": "Steps followed in executing study", "type": "array" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "recruitment": { + "description": "[Text representation of ResearchStudyRecruitment] Target or actual group of participants enrolled in study", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", + "title": "Target or actual group of participants enrolled in study", "type": "string" }, - "identifier": { - "description": "An identifier for this patient", - "element_property": true, - "items": { - "type": "string" - }, - "title": "An identifier for this patient", - "type": "array" - }, - "identifier_coding": { - "description": "[system#code representation of identifier] An identifier for this patient", - "element_property": true, - "items": { - "type": "string" - }, - "title": "An identifier for this patient", - "type": "array" - }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] An identifier for this patient", - "element_property": true, - "items": { - "type": "string" - }, - "title": "An identifier for this patient", - "type": "array" - }, - "link": { - "description": "[Text representation of PatientLink] Link to a Patient or RelatedPerson resource that concerns the same actual individual", + "region": { + "binding_description": "Countries and regions within which this artifact is targeted for use.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/jurisdiction", + "binding_version": null, + "description": "text representation. A country, state or other area where the study is taking place rather than its precise geographic location or address.", "element_property": true, "items": { "type": "string" }, - "title": "Link to a Patient or RelatedPerson resource that concerns the same actual individual", - "type": "array" - }, - "managingOrganization": { - "backref": "managingOrganization_patient", - "description": "[Text representation of Reference] Organization that is the custodian of the patient record", - "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "Organization that is the custodian of the patient record", - "type": "string" - }, - "maritalStatus": { - "binding_description": "The domestic partnership status of a person.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/marital-status", - "binding_version": null, - "description": "text representation. This field contains a patient's most recent marital (civil) status.", - "element_property": true, "term": { - "description": "The domestic partnership status of a person.", + "description": "Countries and regions within which this artifact is targeted for use.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/marital-status", + "cde_id": "http://hl7.org/fhir/ValueSet/jurisdiction", "cde_version": null, "source": "fhir", "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/marital-status", - "term_url": "http://hl7.org/fhir/ValueSet/marital-status" + "term": "http://hl7.org/fhir/ValueSet/jurisdiction", + "term_url": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, - "title": "Marital (civil) status of a patient", - "type": "string" + "title": "Geographic area for the study", + "type": "array" }, - "maritalStatus_coding": { - "binding_description": "The domestic partnership status of a person.", + "region_coding": { + "binding_description": "Countries and regions within which this artifact is targeted for use.", "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/marital-status", + "binding_uri": "http://hl7.org/fhir/ValueSet/jurisdiction", "binding_version": null, - "description": "[system#code representation.] This field contains a patient's most recent marital (civil) status.", + "description": "[system#code representation.] A country, state or other area where the study is taking place rather than its precise geographic location or address.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The domestic partnership status of a person.", + "description": "Countries and regions within which this artifact is targeted for use.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/marital-status", + "cde_id": "http://hl7.org/fhir/ValueSet/jurisdiction", "cde_version": null, "source": "fhir", "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/marital-status", - "term_url": "http://hl7.org/fhir/ValueSet/marital-status" + "term": "http://hl7.org/fhir/ValueSet/jurisdiction", + "term_url": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, - "title": "Marital (civil) status of a patient", - "type": "string" + "title": "Geographic area for the study", + "type": "array" }, - "maritalStatus_text": { - "binding_description": "The domestic partnership status of a person.", + "region_text": { + "binding_description": "Countries and regions within which this artifact is targeted for use.", "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/marital-status", + "binding_uri": "http://hl7.org/fhir/ValueSet/jurisdiction", "binding_version": null, - "description": "[system#code representation.] This field contains a patient's most recent marital (civil) status.", + "description": "[system#code representation.] A country, state or other area where the study is taking place rather than its precise geographic location or address.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The domestic partnership status of a person.", + "description": "Countries and regions within which this artifact is targeted for use.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/marital-status", + "cde_id": "http://hl7.org/fhir/ValueSet/jurisdiction", "cde_version": null, "source": "fhir", "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/marital-status", - "term_url": "http://hl7.org/fhir/ValueSet/marital-status" + "term": "http://hl7.org/fhir/ValueSet/jurisdiction", + "term_url": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, - "title": "Marital (civil) status of a patient", - "type": "string" - }, - "multipleBirthBoolean": { - "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", - "element_property": true, - "one_of_many": "multipleBirth", - "one_of_many_required": false, - "title": "Whether patient is part of a multiple birth", - "type": "boolean" - }, - "multipleBirthInteger": { - "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", - "element_property": true, - "one_of_many": "multipleBirth", - "one_of_many_required": false, - "title": "Whether patient is part of a multiple birth", - "type": "integer" + "title": "Geographic area for the study", + "type": "array" }, - "name": { - "description": "[Text representation of HumanName] A name associated with the individual.", + "relatedArtifact": { + "description": "[Text representation of RelatedArtifact] Citations, references, URLs and other related documents. When using relatedArtifact to share URLs, the relatedArtifact.type will often be set to one of \"documentation\" or \"supported-with\" and the URL value will often be in relatedArtifact.document.url but another possible location is relatedArtifact.resource when it is a canonical URL.", "element_property": true, "items": { "type": "string" }, - "title": "A name associated with the patient", + "title": "References, URLs, and attachments", "type": "array" }, - "patient_birthPlace": { - "description": "[Text representation of Address] [extension patient_birthPlace] The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", - "type": "string" - }, - "patient_mothersMaidenName": { - "description": "[extension patient_mothersMaidenName] Mother's maiden (unmarried) name, commonly collected to help verify patient identity.", + "resourceType": { + "const": "ResearchStudy", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "photo": { - "description": "[Text representation of Attachment] Image of the patient", + "result": { + "backref": "result_research_study", + "description": "[Text representation of Reference] Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov.", "element_property": true, - "items": { + "enum_reference_types": [ + "EvidenceReport", + "Citation", + "DiagnosticReport" + ], + "items": { "type": "string" }, - "title": "Image of the patient", + "title": "Link to results generated during the study", "type": "array" }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" - }, - "type": "string" - }, - "quality_adjusted_life_years": { - "description": "[extension quality_adjusted_life_years] Quality Adjusted Life Years as defined in the literature and summarized at .", - "type": "number" - }, - "resourceType": { - "const": "Patient", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "telecom": { - "description": "[Text representation of ContactPoint] A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.", + "site": { + "backref": "site_research_study", + "description": "[Text representation of Reference] A facility in which study activities are conducted.", "element_property": true, + "enum_reference_types": [ + "Location", + "ResearchStudy", + "Organization" + ], "items": { "type": "string" }, - "title": "A contact detail for the individual", + "title": "Facility where study activities are conducted", "type": "array" }, - "us_core_birthsex": { - "binding_description": "Code for sex assigned at birth", + "status": { + "binding_description": "Codes that convey the current publication status of the research study resource.", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/birthsex", - "binding_version": null, - "description": "[extension us_core_birthsex] A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).", - "term": { - "description": "Code for sex assigned at birth", - "termDef": { - "cde_id": "http://hl7.org/fhir/us/core/ValueSet/birthsex", - "cde_version": null, - "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/us/core/ValueSet/birthsex", - "term_url": "http://hl7.org/fhir/us/core/ValueSet/birthsex" - } - }, - "type": "string" - }, - "us_core_ethnicity": { - "description": "[extension us_core_ethnicity] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.", + "binding_uri": "http://hl7.org/fhir/ValueSet/publication-status", + "binding_version": "5.0.0", + "description": "The publication state of the resource (not of the study).", + "element_property": true, + "element_required": true, + "enum_values": [ + "draft", + "active", + "retired", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "draft | active | retired | unknown", "type": "string" }, - "us_core_ethnicity_detailed": { - "binding_description": null, - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity", + "studyDesign": { + "binding_description": "This is a set of terms for study design characteristics.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/study-design", "binding_version": null, - "description": "[Text representation of Coding] [extension us_core_ethnicity] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.", + "description": "text representation. Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", + "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": null, + "description": "This is a set of terms for study design characteristics.", "termDef": { - "cde_id": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity", + "cde_id": "http://hl7.org/fhir/ValueSet/study-design", "cde_version": null, "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity", - "term_url": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/study-design", + "term_url": "http://hl7.org/fhir/ValueSet/study-design" } }, - "type": "string" + "title": "Classifications of the study design characteristics", + "type": "array" }, - "us_core_ethnicity_ombCategory": { - "binding_description": null, - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category", + "studyDesign_coding": { + "binding_description": "This is a set of terms for study design characteristics.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/study-design", "binding_version": null, - "description": "[Text representation of Coding] [extension us_core_ethnicity] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.", + "description": "[system#code representation.] Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", + "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": null, + "description": "This is a set of terms for study design characteristics.", "termDef": { - "cde_id": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category", + "cde_id": "http://hl7.org/fhir/ValueSet/study-design", "cde_version": null, "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category", - "term_url": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/study-design", + "term_url": "http://hl7.org/fhir/ValueSet/study-design" } }, - "type": "string" + "title": "Classifications of the study design characteristics", + "type": "array" }, - "us_core_genderIdentity": { - "binding_description": null, - "binding_strength": "extensible", - "binding_uri": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "studyDesign_text": { + "binding_description": "This is a set of terms for study design characteristics.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/study-design", "binding_version": null, - "description": "text representation. [extension us_core_genderIdentity] This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.", + "description": "[system#code representation.] Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.", + "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": null, + "description": "This is a set of terms for study design characteristics.", "termDef": { - "cde_id": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "cde_id": "http://hl7.org/fhir/ValueSet/study-design", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", - "term_url": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/study-design", + "term_url": "http://hl7.org/fhir/ValueSet/study-design" } }, + "title": "Classifications of the study design characteristics", + "type": "array" + }, + "title": { + "description": "The human readable name of the research study.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Human readable name of the study", "type": "string" }, - "us_core_genderIdentity_coding": { - "binding_description": null, - "binding_strength": "extensible", - "binding_uri": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", - "binding_version": null, - "description": "[system#code representation.] [extension us_core_genderIdentity] This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.", - "term": { - "description": null, - "termDef": { - "cde_id": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", - "term_url": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32" - } - }, + "url": { + "description": "Canonical identifier for this study resource, represented as a globally unique URI.", + "element_property": true, + "pattern": "\\S*", + "title": "Canonical identifier for this study resource", "type": "string" }, - "us_core_genderIdentity_text": { - "binding_description": null, - "binding_strength": "extensible", - "binding_uri": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "version": { + "description": "The business version for the study record", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "The business version for the study record", + "type": "string" + }, + "whyStopped": { + "binding_description": "Codes for why the study ended prematurely.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", "binding_version": null, - "description": "[system#code representation.] [extension us_core_genderIdentity] This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.", + "description": "text representation. A description and/or code explaining the premature termination of the study.", + "element_property": true, "term": { - "description": null, + "description": "Codes for why the study ended prematurely.", "termDef": { - "cde_id": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", - "term_url": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped" } }, + "title": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design", "type": "string" }, - "us_core_race": { - "description": "[extension us_core_race] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.", - "type": "string" - }, - "us_core_race_detailed": { - "binding_description": null, - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/detailed-race", + "whyStopped_coding": { + "binding_description": "Codes for why the study ended prematurely.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", "binding_version": null, - "description": "[Text representation of Coding] [extension us_core_race] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.", + "description": "[system#code representation.] A description and/or code explaining the premature termination of the study.", + "element_property": true, "term": { - "description": null, + "description": "Codes for why the study ended prematurely.", "termDef": { - "cde_id": "http://hl7.org/fhir/us/core/ValueSet/detailed-race", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", "cde_version": null, "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/us/core/ValueSet/detailed-race", - "term_url": "http://hl7.org/fhir/us/core/ValueSet/detailed-race" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped" } }, + "title": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design", "type": "string" }, - "us_core_race_ombCategory": { - "binding_description": "The 5 race category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category", + "whyStopped_text": { + "binding_description": "Codes for why the study ended prematurely.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", "binding_version": null, - "description": "[Text representation of Coding] [extension us_core_race] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.", + "description": "[system#code representation.] A description and/or code explaining the premature termination of the study.", + "element_property": true, "term": { - "description": "The 5 race category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).", + "description": "Codes for why the study ended prematurely.", "termDef": { - "cde_id": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category", + "cde_id": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", "cde_version": null, "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category", - "term_url": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category" - } - }, - "type": "string" - }, - "us_core_tribal_affiliation_isEnrolled": { - "description": "[extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", - "type": "boolean" - }, - "us_core_tribal_affiliation_tribalAffiliation": { - "binding_description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", - "binding_strength": "extensible", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "binding_version": null, - "description": "text representation. [extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", - "term": { - "description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "term_url": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS" - } - }, - "type": "string" - }, - "us_core_tribal_affiliation_tribalAffiliation_coding": { - "binding_description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", - "binding_strength": "extensible", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "binding_version": null, - "description": "[system#code representation.] [extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", - "term": { - "description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "term_url": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS" - } - }, - "type": "string" - }, - "us_core_tribal_affiliation_tribalAffiliation_text": { - "binding_description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", - "binding_strength": "extensible", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "binding_version": null, - "description": "[system#code representation.] [extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", - "term": { - "description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", - "term_url": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped", + "term_url": "http://hl7.org/fhir/ValueSet/research-study-reason-stopped" } }, + "title": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design", "type": "string" } }, "systemProperties": [ "id" ], - "title": "Patient", + "title": "ResearchStudy", "type": "object", "uniqueKeys": [ [ @@ -2988,184 +2946,139 @@ ] ] }, - "substance.yaml": { + "patient.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, - "category": "Clinical", - "description": "A homogeneous material with a definite composition. [See https://hl7.org/fhir/R5/Substance.html]", - "id": "substance", - "links": [], + "category": "Administrative", + "description": "Information about an individual or animal receiving health care services. Demographics and other administrative information about an individual or animal receiving care or other health-related services. [See https://hl7.org/fhir/R5/Patient.html]", + "id": "patient", + "links": [ + { + "backref": "generalPractitioner_patient", + "label": "Patient_generalPractitioner_Organization_generalPractitioner_patient", + "multiplicity": "many_to_many", + "name": "generalPractitioner_Organization", + "required": false, + "target_type": "organization" + }, + { + "backref": "generalPractitioner_patient", + "label": "Patient_generalPractitioner_Practitioner_generalPractitioner_patient", + "multiplicity": "many_to_many", + "name": "generalPractitioner_Practitioner", + "required": false, + "target_type": "practitioner" + }, + { + "backref": "generalPractitioner_patient", + "label": "Patient_generalPractitioner_PractitionerRole_generalPractitioner_patient", + "multiplicity": "many_to_many", + "name": "generalPractitioner_PractitionerRole", + "required": false, + "target_type": "practitioner_role" + } + ], "program": "*", "project": "*", "properties": { - "category": { - "binding_description": "Category or classification of substance.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/substance-category", - "binding_version": null, - "description": "text representation. A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", + "active": { + "description": "Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.", + "element_property": true, + "title": "Whether this patient's record is in active use", + "type": "boolean" + }, + "address_postalCode": { + "description": "[Plucked from Patient.address] A postal code designating a region defined by the postal service.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Postal code for area", + "type": "string" + }, + "birthDate": { + "description": "The date of birth for the individual", + "element_property": true, + "format": "date", + "title": "The date of birth for the individual", + "type": "string" + }, + "communication": { + "description": "[Text representation of PatientCommunication] A language which may be used to communicate with the patient about his or her health", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "Category or classification of substance.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/substance-category", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/substance-category", - "term_url": "http://hl7.org/fhir/ValueSet/substance-category" - } - }, - "title": "What class/type of substance this is", + "title": "A language which may be used to communicate with the patient about his or her health", "type": "array" }, - "category_coding": { - "binding_description": "Category or classification of substance.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/substance-category", - "binding_version": null, - "description": "[system#code representation.] A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", + "contact": { + "description": "[Text representation of PatientContact] A contact party (e.g. guardian, partner, friend) for the patient", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "Category or classification of substance.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/substance-category", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/substance-category", - "term_url": "http://hl7.org/fhir/ValueSet/substance-category" - } - }, - "title": "What class/type of substance this is", + "title": "A contact party (e.g. guardian, partner, friend) for the patient", "type": "array" }, - "category_text": { - "binding_description": "Category or classification of substance.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/substance-category", - "binding_version": null, - "description": "[system#code representation.] A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", + "deceasedBoolean": { + "description": "Indicates if the individual is deceased or not", + "element_property": true, + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Indicates if the individual is deceased or not", + "type": "boolean" + }, + "deceasedDateTime": { + "description": "Indicates if the individual is deceased or not", + "element_property": true, + "format": "date-time", + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Indicates if the individual is deceased or not", + "type": "string" + }, + "disability_adjusted_life_years": { + "description": "[extension disability_adjusted_life_years] Disability Adjusted Life Years as defined in the literature and summarized at .", + "type": "number" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "Category or classification of substance.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/substance-category", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/substance-category", - "term_url": "http://hl7.org/fhir/ValueSet/substance-category" - } - }, - "title": "What class/type of substance this is", + "title": "Additional content defined by implementations", "type": "array" }, - "code": { - "backref": "substance", - "binding_description": "Substance codes.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/substance-code", - "binding_version": null, - "description": "text representation. A code (or set of codes) that identify this substance.", + "gender": { + "binding_description": "The gender of a person used for administrative purposes.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "binding_version": "5.0.0", + "description": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.", "element_property": true, - "enum_reference_types": [ - "SubstanceDefinition" + "enum_values": [ + "male", + "female", + "other", + "unknown" ], - "term": { - "description": "Substance codes.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/substance-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/substance-code", - "term_url": "http://hl7.org/fhir/ValueSet/substance-code" - } - }, - "title": "What substance this is", + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "male | female | other | unknown", "type": "string" }, - "code_coding": { - "backref": "substance", - "binding_description": "Substance codes.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/substance-code", - "binding_version": null, - "description": "[system#code representation.] A code (or set of codes) that identify this substance.", + "generalPractitioner": { + "backref": "generalPractitioner_patient", + "description": "[Text representation of Reference] Patient's nominated care provider.", "element_property": true, "enum_reference_types": [ - "SubstanceDefinition" + "Organization", + "Practitioner", + "PractitionerRole" ], - "term": { - "description": "Substance codes.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/substance-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/substance-code", - "term_url": "http://hl7.org/fhir/ValueSet/substance-code" - } + "items": { + "type": "string" }, - "title": "What substance this is", - "type": "string" - }, - "code_text": { - "backref": "substance", - "binding_description": "Substance codes.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/substance-code", - "binding_version": null, - "description": "[system#code representation.] A code (or set of codes) that identify this substance.", - "element_property": true, - "enum_reference_types": [ - "SubstanceDefinition" - ], - "term": { - "description": "Substance codes.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/substance-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/substance-code", - "term_url": "http://hl7.org/fhir/ValueSet/substance-code" - } - }, - "title": "What substance this is", - "type": "string" - }, - "description": { - "description": "A description of the substance - its appearance, handling requirements, and other usage notes.", - "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Textual description of the substance, comments", - "type": "string" - }, - "expiry": { - "description": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.", - "element_property": true, - "format": "date-time", - "title": "When no longer valid to use", - "type": "string" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Additional content defined by implementations", + "title": "Patient's nominated primary care provider", "type": "array" }, "id": { @@ -3178,2927 +3091,2353 @@ "type": "string" }, "identifier": { - "description": "Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).", + "description": "An identifier for this patient", "element_property": true, "items": { "type": "string" }, - "title": "Unique identifier", + "title": "An identifier for this patient", "type": "array" }, "identifier_coding": { - "description": "[system#code representation of identifier] Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).", + "description": "[system#code representation of identifier] An identifier for this patient", "element_property": true, "items": { "type": "string" }, - "title": "Unique identifier", + "title": "An identifier for this patient", "type": "array" }, "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).", + "description": "[system#code representation of identifier.text] An identifier for this patient", "element_property": true, "items": { "type": "string" }, - "title": "Unique identifier", + "title": "An identifier for this patient", "type": "array" }, - "ingredient": { - "description": "[Text representation of SubstanceIngredient] A substance can be composed of other substances.", + "link": { + "description": "[Text representation of PatientLink] Link to a Patient or RelatedPerson resource that concerns the same actual individual", "element_property": true, "items": { "type": "string" }, - "title": "Composition information about the substance", + "title": "Link to a Patient or RelatedPerson resource that concerns the same actual individual", "type": "array" }, - "instance": { - "description": "A boolean to indicate if this an instance of a substance or a kind of one (a definition).", + "managingOrganization": { + "backref": "managingOrganization_patient", + "description": "[Text representation of Reference] Organization that is the custodian of the patient record", "element_property": true, - "element_required": true, - "title": "Is this an instance of a substance or a kind of one", - "type": "boolean" + "enum_reference_types": [ + "Organization" + ], + "title": "Organization that is the custodian of the patient record", + "type": "string" }, - "project_id": { + "maritalStatus": { + "binding_description": "The domestic partnership status of a person.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/marital-status", + "binding_version": null, + "description": "text representation. This field contains a patient's most recent marital (civil) status.", + "element_property": true, "term": { - "$ref": "_terms.yaml#/project_id" + "description": "The domestic partnership status of a person.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/marital-status", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/marital-status", + "term_url": "http://hl7.org/fhir/ValueSet/marital-status" + } }, + "title": "Marital (civil) status of a patient", "type": "string" }, - "quantity": { - "description": "[Text representation of Quantity] text representation. The amount of the substance.", + "maritalStatus_coding": { + "binding_description": "The domestic partnership status of a person.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/marital-status", + "binding_version": null, + "description": "[system#code representation.] This field contains a patient's most recent marital (civil) status.", "element_property": true, - "title": "Amount of substance in the package", + "term": { + "description": "The domestic partnership status of a person.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/marital-status", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/marital-status", + "term_url": "http://hl7.org/fhir/ValueSet/marital-status" + } + }, + "title": "Marital (civil) status of a patient", "type": "string" }, - "quantity_unit": { - "title": "Unit representation. Amount of substance in the package", + "maritalStatus_text": { + "binding_description": "The domestic partnership status of a person.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/marital-status", + "binding_version": null, + "description": "[system#code representation.] This field contains a patient's most recent marital (civil) status.", + "element_property": true, + "term": { + "description": "The domestic partnership status of a person.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/marital-status", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/marital-status", + "term_url": "http://hl7.org/fhir/ValueSet/marital-status" + } + }, + "title": "Marital (civil) status of a patient", "type": "string" }, - "quantity_value": { - "title": "Numerical value (with implicit precision) representation. Amount of substance in the package", - "type": "number" + "multipleBirthBoolean": { + "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", + "element_property": true, + "one_of_many": "multipleBirth", + "one_of_many_required": false, + "title": "Whether patient is part of a multiple birth", + "type": "boolean" }, - "resourceType": { - "const": "Substance", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + "multipleBirthInteger": { + "description": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).", + "element_property": true, + "one_of_many": "multipleBirth", + "one_of_many_required": false, + "title": "Whether patient is part of a multiple birth", + "type": "integer" }, - "status": { - "binding_description": "A code to indicate if the substance is actively used.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/substance-status", - "binding_version": "5.0.0", - "description": "A code to indicate if the substance is actively used.", + "name": { + "description": "[Text representation of HumanName] A name associated with the individual.", "element_property": true, - "enum_values": [ - "active", - "inactive", - "entered-in-error" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "active | inactive | entered-in-error", + "items": { + "type": "string" + }, + "title": "A name associated with the patient", + "type": "array" + }, + "patient_birthPlace": { + "description": "[Text representation of Address] [extension patient_birthPlace] The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.", "type": "string" - } - }, - "systemProperties": [ - "id" - ], - "title": "Substance", - "type": "object", - "uniqueKeys": [ - [ - "id" - ] - ] - }, - "_program.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": false, - "category": "administrative", - "description": "A broad framework of goals to be achieved. (NCIt C52647)\n", - "id": "program", - "links": [], - "program": "*", - "project": "*", - "properties": { - "dbgap_accession_number": { - "description": "The dbgap accession number provided for the program.", + }, + "patient_birthPlace_city": { + "description": "nested", "type": "string" }, - "default_bucket": { - "description": "The Gen3 managed bucket projects in this program will use.", + "patient_birthPlace_country": { + "description": "nested", "type": "string" }, - "id": { - "$ref": "_definitions.yaml#/UUID", - "systemAlias": "node_id" + "patient_birthPlace_resourceType": { + "description": "nested", + "type": "string" }, - "name": { - "description": "Full name/title of the program.", + "patient_birthPlace_state": { + "description": "nested", "type": "string" }, - "type": { - "type": "string" - } - }, - "required": [ - "name", - "dbgap_accession_number" - ], - "submittable": false, - "systemProperties": [ - "id" - ], - "title": "Program", - "type": "object", - "uniqueKeys": [ - [ - "id" - ], - [ - "name" - ] - ], - "validators": null - }, - "_project.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": false, - "category": "administrative", - "constraints": null, - "description": "Any specifically defined piece of work that is undertaken or attempted to meet a single requirement. (NCIt C47885)\n", - "id": "project", - "links": [ - { - "backref": "projects", - "label": "member_of", - "multiplicity": "many_to_one", - "name": "programs", - "required": true, - "target_type": "program" - } - ], - "program": "*", - "project": "*", - "properties": { - "availability_mechanism": { - "description": "Mechanism by which the project will be made avilable.", + "patient_mothersMaidenName": { + "description": "[extension patient_mothersMaidenName] Mother's maiden (unmarried) name, commonly collected to help verify patient identity.", "type": "string" }, - "availability_type": { - "description": "Is the project open or restricted?", - "enum": [ - "Open", - "Restricted" - ] + "photo": { + "description": "[Text representation of Attachment] Image of the patient", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Image of the patient", + "type": "array" }, - "code": { - "description": "Unique identifier for the project.", + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, "type": "string" }, - "date_collected": { - "description": "The date or date range in which the project data was collected.", - "type": "string" + "quality_adjusted_life_years": { + "description": "[extension quality_adjusted_life_years] Quality Adjusted Life Years as defined in the literature and summarized at .", + "type": "number" }, - "dbgap_accession_number": { - "description": "The dbgap accession number provided for the project.", + "resourceType": { + "const": "Patient", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "id": { - "$ref": "_definitions.yaml#/UUID", - "description": "UUID for the project.", - "systemAlias": "node_id" + "telecom": { + "description": "[Text representation of ContactPoint] A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "A contact detail for the individual", + "type": "array" }, - "intended_release_date": { - "description": "Tracks a Project's intended release date.", - "format": "date-time", + "us_core_birthsex": { + "binding_description": "Code for sex assigned at birth", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/birthsex", + "binding_version": null, + "description": "[extension us_core_birthsex] A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9).", + "term": { + "description": "Code for sex assigned at birth", + "termDef": { + "cde_id": "http://hl7.org/fhir/us/core/ValueSet/birthsex", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/us/core/ValueSet/birthsex", + "term_url": "http://hl7.org/fhir/us/core/ValueSet/birthsex" + } + }, "type": "string" }, - "investigator_affiliation": { - "description": "The investigator's affiliation with respect to a research institution.", + "us_core_ethnicity": { + "description": "[extension us_core_ethnicity] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.", "type": "string" }, - "investigator_name": { - "description": "Name of the principal investigator for the project.", + "us_core_ethnicity_detailed": { + "binding_description": null, + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity", + "binding_version": null, + "description": "[Text representation of Coding] [extension us_core_ethnicity] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.", + "term": { + "description": null, + "termDef": { + "cde_id": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity", + "term_url": "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity" + } + }, "type": "string" }, - "name": { - "description": "Display name/brief description for the project.", + "us_core_ethnicity_ombCategory": { + "binding_description": null, + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category", + "binding_version": null, + "description": "[Text representation of Coding] [extension us_core_ethnicity] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.", + "term": { + "description": null, + "termDef": { + "cde_id": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category", + "term_url": "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category" + } + }, "type": "string" }, - "programs": { - "$ref": "_definitions.yaml#/to_one", - "description": "Indicates that the project is logically part of the indicated project.\n" + "us_core_ethnicity_ombCategory_coding": { + "description": "extension", + "items": { + "type": "string" + }, + "type": "array" }, - "releasable": { - "default": false, - "description": "A project can only be released by the user when `releasable` is true.\n", - "type": "boolean" + "us_core_ethnicity_text": { + "description": "nested", + "type": "string" }, - "released": { - "default": false, - "description": "To release a project is to tell the GDC to include all submitted\nentities in the next GDC index.\n", - "type": "boolean" + "us_core_genderIdentity": { + "binding_description": null, + "binding_strength": "extensible", + "binding_uri": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "binding_version": null, + "description": "text representation. [extension us_core_genderIdentity] This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.", + "term": { + "description": null, + "termDef": { + "cde_id": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "term_url": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32" + } + }, + "type": "string" }, - "state": { - "default": "open", - "description": "The possible states a project can be in. All but `open` are\nequivalent to some type of locked state.\n", - "enum": [ - "open", - "review", - "submitted", - "processing", - "closed", - "legacy" - ] + "us_core_genderIdentity_coding": { + "binding_description": null, + "binding_strength": "extensible", + "binding_uri": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "binding_version": null, + "description": "[system#code representation.] [extension us_core_genderIdentity] This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.", + "term": { + "description": null, + "termDef": { + "cde_id": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "term_url": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32" + } + }, + "type": "string" }, - "support_id": { - "description": "The ID of the source providing support/grant resources.", + "us_core_genderIdentity_text": { + "binding_description": null, + "binding_strength": "extensible", + "binding_uri": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "binding_version": null, + "description": "[system#code representation.] [extension us_core_genderIdentity] This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension.", + "term": { + "description": null, + "termDef": { + "cde_id": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32", + "term_url": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.32" + } + }, "type": "string" }, - "support_source": { - "description": "The name of source providing support/grant resources.", + "us_core_race": { + "description": "[extension us_core_race] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.", "type": "string" }, - "type": { + "us_core_race_detailed": { + "binding_description": null, + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/detailed-race", + "binding_version": null, + "description": "[Text representation of Coding] [extension us_core_race] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.", + "term": { + "description": null, + "termDef": { + "cde_id": "http://hl7.org/fhir/us/core/ValueSet/detailed-race", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/us/core/ValueSet/detailed-race", + "term_url": "http://hl7.org/fhir/us/core/ValueSet/detailed-race" + } + }, "type": "string" - } - }, - "required": [ - "code", - "name", - "dbgap_accession_number", - "programs" - ], - "submittable": true, - "systemProperties": [ - "id", - "state", - "released", - "releasable", - "intended_release_date" - ], - "title": "Project", - "type": "object", - "uniqueKeys": [ - [ - "id" - ], - [ - "code" - ] - ], - "validators": null - }, - "_definitions.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "UUID": { - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "term": { - "$ref": "_terms.yaml#/UUID" }, - "type": "string" - }, - "data_bundle_state": { - "default": "submitted", - "description": "State of a data bundle.", - "enum": [ - "submitted", - "validated", - "error", - "released", - "suppressed", - "redacted" - ] - }, - "data_file_error_type": { - "enum": [ - "file_size", - "file_format", - "md5sum" - ], - "term": { - "$ref": "_terms.yaml#/data_file_error_type" - } - }, - "data_file_properties": { - "$ref": "#/ubiquitous_properties", - "error_type": { - "$ref": "#/data_file_error_type" - }, - "file_format": { - "$ref": "#/file_format" + "us_core_race_ombCategory": { + "binding_description": "The 5 race category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category", + "binding_version": null, + "description": "[Text representation of Coding] [extension us_core_race] Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.", + "term": { + "description": "The 5 race category codes according to the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.govinfo.gov/content/pkg/FR-1997-10-30/pdf/97-28653.pdf).", + "termDef": { + "cde_id": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category", + "term_url": "http://hl7.org/fhir/us/core/ValueSet/omb-race-category" + } + }, + "type": "string" }, - "file_name": { - "$ref": "#/file_name" + "us_core_race_ombCategory_coding": { + "description": "extension", + "items": { + "type": "string" + }, + "type": "array" }, - "file_size": { - "$ref": "#/file_size" + "us_core_race_text": { + "description": "extension", + "type": "string" }, - "file_state": { - "$ref": "#/file_state" + "us_core_tribal_affiliation_isEnrolled": { + "description": "[extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", + "type": "boolean" }, - "ga4gh_drs_uri": { - "$ref": "#/ga4gh_drs_uri" + "us_core_tribal_affiliation_tribalAffiliation": { + "binding_description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", + "binding_strength": "extensible", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "binding_version": null, + "description": "text representation. [extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", + "term": { + "description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "term_url": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS" + } + }, + "type": "string" }, - "md5sum": { - "$ref": "#/md5sum" + "us_core_tribal_affiliation_tribalAffiliation_coding": { + "binding_description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", + "binding_strength": "extensible", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "binding_version": null, + "description": "[system#code representation.] [extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", + "term": { + "description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "term_url": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS" + } + }, + "type": "string" }, - "object_id": { - "$ref": "#/object_id" - } - }, - "datetime": { - "oneOf": [ - { - "format": "date-time", - "type": "string" + "us_core_tribal_affiliation_tribalAffiliation_text": { + "binding_description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", + "binding_strength": "extensible", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "binding_version": null, + "description": "[system#code representation.] [extension us_core_tribal_affiliation] This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.", + "term": { + "description": "Tribal Entity recognized by the United States Bureau Of Indian Affairs.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS", + "term_url": "http://terminology.hl7.org/ValueSet/v3-TribalEntityUS" + } }, - { - "type": "null" - } - ], - "term": { - "$ref": "_terms.yaml#/datetime" + "type": "string" } }, - "fhir_resource": { - "additionalProperties": true, - "properties": { - "id": { - "$ref": "#/UUID" - }, - "resource_type": { + "systemProperties": [ + "id" + ], + "title": "Patient", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "practitioner.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Administrative", + "description": "A person with a formal responsibility in the provisioning of healthcare or related services. A person who is directly or indirectly involved in the provisioning of healthcare or related services. [See https://hl7.org/fhir/R5/Practitioner.html]", + "id": "practitioner", + "links": [], + "program": "*", + "project": "*", + "properties": { + "active": { + "description": "Whether this practitioner's record is in active use", + "element_property": true, + "title": "Whether this practitioner's record is in active use", + "type": "boolean" + }, + "address": { + "description": "[Text representation of Address] Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.", + "element_property": true, + "items": { "type": "string" - } + }, + "title": "Address(es) of the practitioner that are not role specific (typically home address)", + "type": "array" }, - "type": "object" - }, - "file_format": { - "term": { - "$ref": "_terms.yaml#/file_format" + "birthDate": { + "description": "The date of birth for the practitioner.", + "element_property": true, + "format": "date", + "title": "The date on which the practitioner was born", + "type": "string" }, - "type": "string" - }, - "file_name": { - "term": { - "$ref": "_terms.yaml#/file_name" + "communication": { + "description": "[Text representation of PractitionerCommunication] A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes. The `PractitionerRole.communication` property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis).", + "element_property": true, + "items": { + "type": "string" + }, + "title": "A language which may be used to communicate with the practitioner", + "type": "array" }, - "type": "string" - }, - "file_size": { - "term": { - "$ref": "_terms.yaml#/file_size" + "deceasedBoolean": { + "description": "Indicates if the practitioner is deceased or not", + "element_property": true, + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Indicates if the practitioner is deceased or not", + "type": "boolean" }, - "type": "integer" - }, - "file_state": { - "default": "registered", - "enum": [ - "registered", - "uploading", - "uploaded", - "validating", - "validated", - "submitted", - "processing", - "processed", - "released", - "error" - ], - "term": { - "$ref": "_terms.yaml#/file_state" - } - }, - "foreign_key": { - "additionalProperties": true, - "properties": { - "id": { - "$ref": "#/UUID" - }, - "submitter_id": { - "type": "string" - } + "deceasedDateTime": { + "description": "Indicates if the practitioner is deceased or not", + "element_property": true, + "format": "date-time", + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Indicates if the practitioner is deceased or not", + "type": "string" }, - "type": "object" - }, - "foreign_key_project": { - "additionalProperties": true, - "properties": { - "code": { + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { "type": "string" }, - "id": { - "$ref": "#/UUID" - } - }, - "type": "object" - }, - "ga4gh_drs_uri": { - "term": { - "$ref": "_terms.yaml#/ga4gh_drs_uri" + "title": "Additional content defined by implementations", + "type": "array" }, - "type": "string" - }, - "id": "_definitions", - "md5sum": { - "pattern": "^[a-f0-9]{32}$", - "term": { - "$ref": "_terms.yaml#/md5sum" - }, - "type": "string" - }, - "object_id": { - "description": "The GUID of the object in the index service.", - "type": "string" - }, - "parent_uuids": { - "items": { - "$ref": "#/UUID" + "gender": { + "binding_description": "The gender of a person used for administrative purposes.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "binding_version": "5.0.0", + "description": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", + "element_property": true, + "enum_values": [ + "male", + "female", + "other", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "male | female | other | unknown", + "type": "string" }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" }, - "type": "string" - }, - "qc_metrics_state": { - "enum": [ - "FAIL", - "PASS", - "WARN" - ], - "term": { - "$ref": "_terms.yaml#/qc_metric_state" - } - }, - "release_state": { - "default": "unreleased", - "description": "Release state of an entity.", - "enum": [ - "unreleased", - "released", - "redacted" - ] - }, - "state": { - "default": "validated", - "downloadable": [ - "uploaded", - "md5summed", - "validating", - "validated", - "error", - "invalid", - "released" - ], - "oneOf": [ - { - "enum": [ - "uploading", - "uploaded", - "md5summing", - "md5summed", - "validating", - "error", - "invalid", - "suppressed", - "redacted", - "live" - ] - }, - { - "enum": [ - "validated", - "submitted", - "released" - ] - } - ], - "public": [ - "live" - ], - "term": { - "$ref": "_terms.yaml#/state" - } - }, - "to_many": { - "anyOf": [ - { - "items": { - "$ref": "#/foreign_key", - "minItems": 1 - }, - "type": "array" + "identifier": { + "description": "An identifier that applies to this person in this role.", + "element_property": true, + "items": { + "type": "string" }, - { - "$ref": "#/foreign_key" - } - ] - }, - "to_many_project": { - "anyOf": [ - { - "items": { - "$ref": "#/foreign_key_project", - "minItems": 1 - }, - "type": "array" + "title": "An identifier for the person as this agent", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] An identifier that applies to this person in this role.", + "element_property": true, + "items": { + "type": "string" }, - { - "$ref": "#/foreign_key_project" - } - ] - }, - "to_one": { - "anyOf": [ - { - "items": { - "$ref": "#/foreign_key", - "maxItems": 1, - "minItems": 1 - }, - "type": "array" + "title": "An identifier for the person as this agent", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] An identifier that applies to this person in this role.", + "element_property": true, + "items": { + "type": "string" }, - { - "$ref": "#/foreign_key" - } - ] - }, - "to_one_project": { - "anyOf": [ - { - "items": { - "$ref": "#/foreign_key_project", - "maxItems": 1, - "minItems": 1 - }, - "type": "array" + "title": "An identifier for the person as this agent", + "type": "array" + }, + "name": { + "description": "[Text representation of HumanName] The name(s) associated with the practitioner", + "element_property": true, + "items": { + "type": "string" }, - { - "$ref": "#/foreign_key_project" - } - ] - }, - "ubiquitous_properties": { - "created_datetime": { - "$ref": "#/datetime" + "title": "The name(s) associated with the practitioner", + "type": "array" }, - "id": { - "$ref": "#/UUID", - "systemAlias": "node_id" + "photo": { + "description": "[Text representation of Attachment] Image of the person", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Image of the person", + "type": "array" }, "project_id": { - "$ref": "#/project_id" - }, - "state": { - "$ref": "#/state" - }, - "submitter_id": { - "description": "A project-specific identifier for a node. This property is the calling card/nickname/alias for a unit of submission. It can be used in place of the UUID for identifying or recalling a node.\n", - "type": [ - "string" - ] - }, - "type": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, "type": "string" }, - "updated_datetime": { - "$ref": "#/datetime" - } - }, - "workflow_properties": { - "$ref": "#/ubiquitous_properties", - "workflow_end_datetime": { - "$ref": "#/datetime" + "qualification": { + "description": "[Text representation of PractitionerQualification] The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care", + "type": "array" }, - "workflow_link": { - "description": "Link to Github hash for the CWL workflow used.", + "resourceType": { + "const": "Practitioner", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "workflow_start_datetime": { - "$ref": "#/datetime" - }, - "workflow_version": { - "description": "Major version for a GDC workflow.", - "type": "string" + "telecom": { + "description": "[Text representation of ContactPoint] A contact detail for the practitioner, e.g. a telephone number or an email address.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "A contact detail for the practitioner (that apply to all roles)", + "type": "array" } - } + }, + "systemProperties": [ + "id" + ], + "title": "Practitioner", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] }, - "document_reference.yaml": { + "substance.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, - "category": "data_file", - "description": "A reference to a document. A reference to a document of any kind for any purpose. While the term \u201cdocument\u201d implies a more narrow focus, for this resource this \"document\" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference. [See https://hl7.org/fhir/R5/DocumentReference.html]", - "id": "document_reference", - "links": [ - { - "backref": "subject_DocumentReference", - "label": "DocumentReference_subject_ResearchStudy_subject_DocumentReference", - "multiplicity": "many_to_many", - "name": "subject_ResearchStudy", - "required": false, - "target_type": "research_study" - }, - { - "backref": "subject_DocumentReference", - "label": "DocumentReference_subject_Patient_subject_DocumentReference", - "multiplicity": "many_to_many", - "name": "subject_Patient", - "required": false, - "target_type": "patient" - }, - { - "backref": "subject_DocumentReference", - "label": "DocumentReference_subject_Specimen_subject_DocumentReference", - "multiplicity": "many_to_many", - "name": "subject_Specimen", - "required": false, - "target_type": "specimen" - }, - { - "backref": "subject_DocumentReference", - "label": "DocumentReference_subject_Observation_subject_DocumentReference", - "multiplicity": "many_to_many", - "name": "subject_Observation", - "required": false, - "target_type": "observation" - } - ], + "category": "Clinical", + "description": "A homogeneous material with a definite composition. [See https://hl7.org/fhir/R5/Substance.html]", + "id": "substance", + "links": [], "program": "*", "project": "*", "properties": { - "$ref": "_definitions.yaml#/data_file_properties", - "attester": { - "description": "[Text representation of DocumentReferenceAttester] A participant who has authenticated the accuracy of the document.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Attests to accuracy of the document", - "type": "array" - }, - "auth_resource_path": { - "description": "Gen3 scaffolding", - "type": "string" - }, - "author": { - "backref": "author_document_reference", - "description": "[Text representation of Reference] Identifies who is responsible for adding the information to the document.", - "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "Device", - "Patient", - "RelatedPerson", - "CareTeam" - ], - "items": { - "type": "string" - }, - "title": "Who and/or what authored the document", - "type": "array" - }, - "basedOn": { - "backref": "basedOn_document_reference", - "description": "[Text representation of Reference] A procedure that is fulfilled in whole or in part by the creation of this media.", - "element_property": true, - "enum_reference_types": [ - "Appointment", - "AppointmentResponse", - "CarePlan", - "Claim", - "CommunicationRequest", - "Contract", - "CoverageEligibilityRequest", - "DeviceRequest", - "EnrollmentRequest", - "ImmunizationRecommendation", - "MedicationRequest", - "NutritionOrder", - "RequestOrchestration", - "ServiceRequest", - "SupplyRequest", - "VisionPrescription" - ], - "items": { - "type": "string" - }, - "title": "Procedure that caused this media to be created", - "type": "array" - }, - "bodySite": { - "backref": "bodySite_document_reference", - "binding_description": "SNOMED CT Body site concepts", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "category": { + "binding_description": "Category or classification of substance.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/substance-category", "binding_version": null, - "description": "text representation. The anatomic structures included in the document.", + "description": "text representation. A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", "element_property": true, - "enum_reference_types": [ - "BodyStructure" - ], "items": { "type": "string" }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "Category or classification of substance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/substance-category", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/substance-category", + "term_url": "http://hl7.org/fhir/ValueSet/substance-category" } }, - "title": "Body part included", + "title": "What class/type of substance this is", "type": "array" }, - "bodySite_coding": { - "backref": "bodySite_document_reference", - "binding_description": "SNOMED CT Body site concepts", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "category_coding": { + "binding_description": "Category or classification of substance.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/substance-category", "binding_version": null, - "description": "[system#code representation.] The anatomic structures included in the document.", + "description": "[system#code representation.] A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", "element_property": true, - "enum_reference_types": [ - "BodyStructure" - ], "items": { "type": "string" }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "Category or classification of substance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/substance-category", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/substance-category", + "term_url": "http://hl7.org/fhir/ValueSet/substance-category" } }, - "title": "Body part included", + "title": "What class/type of substance this is", "type": "array" }, - "bodySite_text": { - "backref": "bodySite_document_reference", - "binding_description": "SNOMED CT Body site concepts", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "category_text": { + "binding_description": "Category or classification of substance.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/substance-category", "binding_version": null, - "description": "[system#code representation.] The anatomic structures included in the document.", + "description": "[system#code representation.] A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", "element_property": true, - "enum_reference_types": [ - "BodyStructure" - ], "items": { "type": "string" }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "Category or classification of substance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/substance-category", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/substance-category", + "term_url": "http://hl7.org/fhir/ValueSet/substance-category" } }, - "title": "Body part included", + "title": "What class/type of substance this is", "type": "array" }, - "category": { - "binding_description": "High-level kind of document at a macro level.", + "code": { + "backref": "substance", + "binding_description": "Substance codes.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "binding_uri": "http://hl7.org/fhir/ValueSet/substance-code", "binding_version": null, - "description": "text representation. A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", + "description": "text representation. A code (or set of codes) that identify this substance.", "element_property": true, - "items": { - "type": "string" - }, + "enum_reference_types": [ + "SubstanceDefinition" + ], "term": { - "description": "High-level kind of document at a macro level.", + "description": "Substance codes.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "cde_id": "http://hl7.org/fhir/ValueSet/substance-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/referenced-item-category", - "term_url": "http://hl7.org/fhir/ValueSet/referenced-item-category" + "term": "http://hl7.org/fhir/ValueSet/substance-code", + "term_url": "http://hl7.org/fhir/ValueSet/substance-code" } }, - "title": "Categorization of document", - "type": "array" + "title": "What substance this is", + "type": "string" }, - "category_coding": { - "binding_description": "High-level kind of document at a macro level.", + "code_coding": { + "backref": "substance", + "binding_description": "Substance codes.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "binding_uri": "http://hl7.org/fhir/ValueSet/substance-code", "binding_version": null, - "description": "[system#code representation.] A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", + "description": "[system#code representation.] A code (or set of codes) that identify this substance.", "element_property": true, - "items": { - "type": "string" - }, + "enum_reference_types": [ + "SubstanceDefinition" + ], "term": { - "description": "High-level kind of document at a macro level.", + "description": "Substance codes.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "cde_id": "http://hl7.org/fhir/ValueSet/substance-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/referenced-item-category", - "term_url": "http://hl7.org/fhir/ValueSet/referenced-item-category" + "term": "http://hl7.org/fhir/ValueSet/substance-code", + "term_url": "http://hl7.org/fhir/ValueSet/substance-code" } }, - "title": "Categorization of document", - "type": "array" + "title": "What substance this is", + "type": "string" }, - "category_text": { - "binding_description": "High-level kind of document at a macro level.", + "code_text": { + "backref": "substance", + "binding_description": "Substance codes.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "binding_uri": "http://hl7.org/fhir/ValueSet/substance-code", "binding_version": null, - "description": "[system#code representation.] A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", + "description": "[system#code representation.] A code (or set of codes) that identify this substance.", "element_property": true, - "items": { - "type": "string" - }, + "enum_reference_types": [ + "SubstanceDefinition" + ], "term": { - "description": "High-level kind of document at a macro level.", + "description": "Substance codes.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "cde_id": "http://hl7.org/fhir/ValueSet/substance-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/referenced-item-category", - "term_url": "http://hl7.org/fhir/ValueSet/referenced-item-category" + "term": "http://hl7.org/fhir/ValueSet/substance-code", + "term_url": "http://hl7.org/fhir/ValueSet/substance-code" } }, - "title": "Categorization of document", - "type": "array" - }, - "content_attachment_contentType": { - "binding_description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/mimetypes", - "binding_version": "5.0.0", - "description": "[Plucked from DocumentReference.content] Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.", - "element_property": true, - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "Mime type of the content, with charset etc.", - "type": "string" - }, - "content_attachment_extension_md5": { - "description": "[Plucked from DocumentReference.content] Value of extension", + "title": "What substance this is", "type": "string" }, - "content_attachment_size": { - "description": "[Plucked from DocumentReference.content] The number of bytes of data that make up this attachment (before base64 encoding, if that is done).", + "description": { + "description": "A description of the substance - its appearance, handling requirements, and other usage notes.", "element_property": true, - "title": "Number of bytes of content (if url provided)", - "type": "integer" + "pattern": "\\s*(\\S|\\s)*", + "title": "Textual description of the substance, comments", + "type": "string" }, - "content_attachment_url": { - "description": "[Plucked from DocumentReference.content] A location where the data can be accessed.", + "expiry": { + "description": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.", "element_property": true, - "format": "uri", - "maxLength": 65536, - "minLength": 1, - "title": "Uri where the data can be found", + "format": "date-time", + "title": "When no longer valid to use", "type": "string" }, - "context": { - "backref": "context_document_reference", - "description": "[Text representation of Reference] Describes the clinical encounter or type of care that the document content is associated with.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, - "enum_reference_types": [ - "Appointment", - "Encounter", - "EpisodeOfCare" - ], "items": { "type": "string" }, - "title": "Context of the document content", + "title": "Additional content defined by implementations", "type": "array" }, - "custodian": { - "backref": "custodian_document_reference", - "description": "[Text representation of Reference] Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.", - "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "Organization which maintains the document", - "type": "string" - }, - "data_category": { - "term": { - "$ref": "_terms.yaml#/data_category" - }, - "type": "string" - }, - "data_format": { - "term": { - "$ref": "_terms.yaml#/data_format" - }, - "type": "string" - }, - "data_type": { - "term": { - "$ref": "_terms.yaml#/data_type" - }, - "type": "string" - }, - "date": { - "description": "When the document reference was created.", - "element_property": true, - "format": "date-time", - "title": "When this document reference was created", - "type": "string" - }, - "description": { - "description": "Human-readable description of the source document.", - "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Human-readable description", - "type": "string" - }, - "docStatus": { - "binding_description": "Status of the underlying document.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/composition-status", - "binding_version": "5.0.0", - "description": "The status of the underlying document.", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, - "enum_values": [ - "registered", - "partial", - "preliminary", - "final", - "amended", - "corrected", - "appended", - "cancelled", - "entered-in-error", - "deprecated", - "unknown" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", "type": "string" }, - "event": { - "backref": "event_document_reference", - "binding_description": "This list of codes represents the main clinical acts being documented.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "binding_version": null, - "description": "text representation. This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", + "identifier": { + "description": "Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "This list of codes represents the main clinical acts being documented.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "term_url": "http://terminology.hl7.org/ValueSet/v3-ActCode" - } - }, - "title": "Main clinical acts documented", + "title": "Unique identifier", "type": "array" }, - "event_coding": { - "backref": "event_document_reference", - "binding_description": "This list of codes represents the main clinical acts being documented.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "binding_version": null, - "description": "[system#code representation.] This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", + "identifier_coding": { + "description": "[system#code representation of identifier] Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "This list of codes represents the main clinical acts being documented.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "term_url": "http://terminology.hl7.org/ValueSet/v3-ActCode" - } - }, - "title": "Main clinical acts documented", + "title": "Unique identifier", "type": "array" }, - "event_text": { - "backref": "event_document_reference", - "binding_description": "This list of codes represents the main clinical acts being documented.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "binding_version": null, - "description": "[system#code representation.] This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "This list of codes represents the main clinical acts being documented.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v3-ActCode", - "term_url": "http://terminology.hl7.org/ValueSet/v3-ActCode" - } - }, - "title": "Main clinical acts documented", + "title": "Unique identifier", "type": "array" }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "ingredient": { + "description": "[Text representation of SubstanceIngredient] A substance can be composed of other substances.", "element_property": true, "items": { "type": "string" }, - "title": "Additional content defined by implementations", + "title": "Composition information about the substance", "type": "array" }, - "facilityType": { - "binding_description": "XDS Facility Type.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "binding_version": null, - "description": "text representation. The kind of facility where the patient was seen.", + "instance": { + "description": "A boolean to indicate if this an instance of a substance or a kind of one (a definition).", "element_property": true, + "element_required": true, + "title": "Is this an instance of a substance or a kind of one", + "type": "boolean" + }, + "project_id": { "term": { - "description": "XDS Facility Type.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "term_url": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" - } + "$ref": "_terms.yaml#/project_id" }, - "title": "Kind of facility where patient was seen", "type": "string" }, - "facilityType_coding": { - "binding_description": "XDS Facility Type.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "binding_version": null, - "description": "[system#code representation.] The kind of facility where the patient was seen.", + "quantity": { + "description": "[Text representation of Quantity] text representation. The amount of the substance.", "element_property": true, - "term": { - "description": "XDS Facility Type.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "term_url": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" - } - }, - "title": "Kind of facility where patient was seen", + "title": "Amount of substance in the package", "type": "string" }, - "facilityType_text": { - "binding_description": "XDS Facility Type.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "binding_version": null, - "description": "[system#code representation.] The kind of facility where the patient was seen.", - "element_property": true, - "term": { - "description": "XDS Facility Type.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", - "term_url": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" - } - }, - "title": "Kind of facility where patient was seen", + "quantity_unit": { + "title": "Unit representation. Amount of substance in the package", "type": "string" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", + "quantity_value": { + "title": "Numerical value (with implicit precision) representation. Amount of substance in the package", + "type": "number" + }, + "resourceType": { + "const": "Substance", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "identifier": { - "description": "Other business identifiers associated with the document, including version independent identifiers.", + "status": { + "binding_description": "A code to indicate if the substance is actively used.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/substance-status", + "binding_version": "5.0.0", + "description": "A code to indicate if the substance is actively used.", "element_property": true, - "items": { - "type": "string" - }, - "title": "Business identifiers for the document", - "type": "array" + "enum_values": [ + "active", + "inactive", + "entered-in-error" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "active | inactive | entered-in-error", + "type": "string" + } + }, + "systemProperties": [ + "id" + ], + "title": "Substance", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "_program.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": false, + "category": "administrative", + "description": "A broad framework of goals to be achieved. (NCIt C52647)\n", + "id": "program", + "links": [], + "program": "*", + "project": "*", + "properties": { + "dbgap_accession_number": { + "description": "The dbgap accession number provided for the program.", + "type": "string" }, - "identifier_coding": { - "description": "[system#code representation of identifier] Other business identifiers associated with the document, including version independent identifiers.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Business identifiers for the document", - "type": "array" + "default_bucket": { + "description": "The Gen3 managed bucket projects in this program will use.", + "type": "string" }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Other business identifiers associated with the document, including version independent identifiers.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Business identifiers for the document", - "type": "array" + "id": { + "$ref": "_definitions.yaml#/UUID", + "systemAlias": "node_id" }, - "modality": { - "binding_description": "Type of acquired data in the instance.", - "binding_strength": "extensible", - "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "binding_version": null, - "description": "text representation. Imaging modality used. This may include both acquisition and non-acquisition modalities.", - "element_property": true, - "items": { - "type": "string" - }, - "term": { - "description": "Type of acquired data in the instance.", - "termDef": { - "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" - } - }, - "title": "Imaging modality used", - "type": "array" + "name": { + "description": "Full name/title of the program.", + "type": "string" }, - "modality_coding": { - "binding_description": "Type of acquired data in the instance.", - "binding_strength": "extensible", - "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "binding_version": null, - "description": "[system#code representation.] Imaging modality used. This may include both acquisition and non-acquisition modalities.", - "element_property": true, - "items": { - "type": "string" - }, - "term": { - "description": "Type of acquired data in the instance.", - "termDef": { - "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" - } - }, - "title": "Imaging modality used", - "type": "array" + "type": { + "type": "string" + } + }, + "required": [ + "name", + "dbgap_accession_number" + ], + "submittable": false, + "systemProperties": [ + "id" + ], + "title": "Program", + "type": "object", + "uniqueKeys": [ + [ + "id" + ], + [ + "name" + ] + ], + "validators": null + }, + "_project.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": false, + "category": "administrative", + "constraints": null, + "description": "Any specifically defined piece of work that is undertaken or attempted to meet a single requirement. (NCIt C47885)\n", + "id": "project", + "links": [ + { + "backref": "projects", + "label": "member_of", + "multiplicity": "many_to_one", + "name": "programs", + "required": true, + "target_type": "program" + } + ], + "program": "*", + "project": "*", + "properties": { + "availability_mechanism": { + "description": "Mechanism by which the project will be made avilable.", + "type": "string" }, - "modality_text": { - "binding_description": "Type of acquired data in the instance.", - "binding_strength": "extensible", - "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "binding_version": null, - "description": "[system#code representation.] Imaging modality used. This may include both acquisition and non-acquisition modalities.", - "element_property": true, - "items": { - "type": "string" - }, - "term": { - "description": "Type of acquired data in the instance.", - "termDef": { - "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", - "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" - } - }, - "title": "Imaging modality used", - "type": "array" + "availability_type": { + "description": "Is the project open or restricted?", + "enum": [ + "Open", + "Restricted" + ] }, - "patient_id": { - "description": "Denormalized patient id", + "code": { + "description": "Unique identifier for the project.", "type": "string" }, - "period": { - "description": "[Text representation of Period] The time period over which the service that is described by the document was provided.", - "element_property": true, - "title": "Time of service that is being documented", + "date_collected": { + "description": "The date or date range in which the project data was collected.", "type": "string" }, - "practiceSetting": { - "binding_description": "Additional details about where the content was created (e.g. clinical specialty).", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "binding_version": null, - "description": "text representation. This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", - "element_property": true, - "term": { - "description": "Additional details about where the content was created (e.g. clinical specialty).", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" - } - }, - "title": "Additional details about where the content was created (e.g. clinical specialty)", + "dbgap_accession_number": { + "description": "The dbgap accession number provided for the project.", "type": "string" }, - "practiceSetting_coding": { - "binding_description": "Additional details about where the content was created (e.g. clinical specialty).", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "binding_version": null, - "description": "[system#code representation.] This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", - "element_property": true, - "term": { - "description": "Additional details about where the content was created (e.g. clinical specialty).", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" - } - }, - "title": "Additional details about where the content was created (e.g. clinical specialty)", - "type": "string" + "id": { + "$ref": "_definitions.yaml#/UUID", + "description": "UUID for the project.", + "systemAlias": "node_id" }, - "practiceSetting_text": { - "binding_description": "Additional details about where the content was created (e.g. clinical specialty).", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "binding_version": null, - "description": "[system#code representation.] This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", - "element_property": true, - "term": { - "description": "Additional details about where the content was created (e.g. clinical specialty).", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", - "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" - } - }, - "title": "Additional details about where the content was created (e.g. clinical specialty)", + "intended_release_date": { + "description": "Tracks a Project's intended release date.", + "format": "date-time", "type": "string" }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" - }, + "investigator_affiliation": { + "description": "The investigator's affiliation with respect to a research institution.", "type": "string" }, - "relatesTo": { - "description": "[Text representation of DocumentReferenceRelatesTo] Relationships that this document has with other document references that already exist.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Relationships to other documents", - "type": "array" - }, - "resourceType": { - "const": "DocumentReference", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", + "investigator_name": { + "description": "Name of the principal investigator for the project.", "type": "string" }, - "securityLabel": { - "binding_description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/security-label-examples", - "binding_version": null, - "description": "text representation. A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.", - "element_property": true, - "items": { - "type": "string" - }, - "term": { - "description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/security-label-examples", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/security-label-examples", - "term_url": "http://hl7.org/fhir/ValueSet/security-label-examples" - } - }, - "title": "Document security-tags", - "type": "array" - }, - "securityLabel_coding": { - "binding_description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/security-label-examples", - "binding_version": null, - "description": "[system#code representation.] A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.", - "element_property": true, - "items": { - "type": "string" - }, - "term": { - "description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/security-label-examples", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/security-label-examples", - "term_url": "http://hl7.org/fhir/ValueSet/security-label-examples" - } - }, - "title": "Document security-tags", - "type": "array" + "name": { + "description": "Display name/brief description for the project.", + "type": "string" }, - "securityLabel_text": { - "binding_description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/security-label-examples", - "binding_version": null, - "description": "[system#code representation.] A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.", - "element_property": true, - "items": { - "type": "string" - }, - "term": { - "description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/security-label-examples", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/security-label-examples", - "term_url": "http://hl7.org/fhir/ValueSet/security-label-examples" - } - }, - "title": "Document security-tags", - "type": "array" + "programs": { + "$ref": "_definitions.yaml#/to_one", + "description": "Indicates that the project is logically part of the indicated project.\n" }, - "status": { - "binding_description": "The status of the document reference.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/document-reference-status", - "binding_version": "5.0.0", - "description": "The status of this document reference.", - "element_property": true, - "element_required": true, - "enum_values": [ - "current", - "superseded", - "entered-in-error" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "current | superseded | entered-in-error", - "type": "string" + "releasable": { + "default": false, + "description": "A project can only be released by the user when `releasable` is true.\n", + "type": "boolean" }, - "subject": { - "backref": "subject_DocumentReference", - "description": "[Text representation of Reference] Who/what is the subject of the document.", - "enum_reference_types": [ - "ResearchStudy", - "Patient", - "Specimen", - "Observation" - ], - "title": "The item that this DocumentReference is about.", - "type": "string" + "released": { + "default": false, + "description": "To release a project is to tell the GDC to include all submitted\nentities in the next GDC index.\n", + "type": "boolean" }, - "type": { - "binding_description": "Precise type of clinical document.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "binding_version": null, - "description": "text representation. Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", - "element_property": true, - "term": { - "description": "Precise type of clinical document.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "cde_version": null, - "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "term_url": "http://hl7.org/fhir/ValueSet/doc-typecodes" - } - }, - "title": "Kind of document (LOINC if possible)", - "type": "string" + "state": { + "default": "open", + "description": "The possible states a project can be in. All but `open` are\nequivalent to some type of locked state.\n", + "enum": [ + "open", + "review", + "submitted", + "processing", + "closed", + "legacy" + ] }, - "type_coding": { - "binding_description": "Precise type of clinical document.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "binding_version": null, - "description": "[system#code representation.] Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", - "element_property": true, - "term": { - "description": "Precise type of clinical document.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "cde_version": null, - "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "term_url": "http://hl7.org/fhir/ValueSet/doc-typecodes" - } - }, - "title": "Kind of document (LOINC if possible)", + "support_id": { + "description": "The ID of the source providing support/grant resources.", "type": "string" }, - "type_text": { - "binding_description": "Precise type of clinical document.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "binding_version": null, - "description": "[system#code representation.] Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", - "element_property": true, - "term": { - "description": "Precise type of clinical document.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "cde_version": null, - "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/doc-typecodes", - "term_url": "http://hl7.org/fhir/ValueSet/doc-typecodes" - } - }, - "title": "Kind of document (LOINC if possible)", + "support_source": { + "description": "The name of source providing support/grant resources.", "type": "string" }, - "version": { - "description": "An explicitly assigned identifer of a variation of the content in the DocumentReference", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "An explicitly assigned identifer of a variation of the content in the DocumentReference", + "type": { "type": "string" } }, + "required": [ + "code", + "name", + "dbgap_accession_number", + "programs" + ], + "submittable": true, "systemProperties": [ - "id" + "id", + "state", + "released", + "releasable", + "intended_release_date" ], - "title": "DocumentReference", + "title": "Project", "type": "object", "uniqueKeys": [ [ "id" + ], + [ + "code" ] - ] - }, - "_settings.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "enable_case_cache": false, - "_dict_commit": "520a25999fd183f6c5b7ddef2980f3e839517da5", - "_dict_version": "0.2.1-9-g520a259" + ], + "validators": null }, - "task.yaml": { + "_definitions.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": true, - "category": "Analysis", - "description": "A task to be performed. [See https://hl7.org/fhir/R5/Task.html]", - "id": "task", - "links": [ - { - "backref": "owner_task", - "label": "Task_owner_Patient_owner_task", - "multiplicity": "many_to_many", - "name": "owner_Patient", - "required": false, - "target_type": "patient" - }, - { - "backref": "partOf_task", - "label": "Task_partOf_Task_partOf_task", - "multiplicity": "many_to_many", - "name": "partOf", - "required": false, - "target_type": "task" - }, - { - "backref": "task", - "label": "Task_specimen_Specimen_task", - "multiplicity": "many_to_many", - "name": "specimen", - "required": false, - "target_type": "specimen" + "UUID": { + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "term": { + "$ref": "_terms.yaml#/UUID" }, - { - "backref": "task", - "label": "Task_document_reference_DocumentReference_task", - "multiplicity": "many_to_many", - "name": "document_reference", - "required": false, - "target_type": "document_reference" + "type": "string" + }, + "data_bundle_state": { + "default": "submitted", + "description": "State of a data bundle.", + "enum": [ + "submitted", + "validated", + "error", + "released", + "suppressed", + "redacted" + ] + }, + "data_file_error_type": { + "enum": [ + "file_size", + "file_format", + "md5sum" + ], + "term": { + "$ref": "_terms.yaml#/data_file_error_type" } - ], - "program": "*", - "project": "*", - "properties": { - "authoredOn": { - "description": "The date and time this task was created.", - "element_property": true, - "format": "date-time", - "title": "Task Creation Date", - "type": "string" + }, + "data_file_properties": { + "$ref": "#/ubiquitous_properties", + "error_type": { + "$ref": "#/data_file_error_type" }, - "basedOn": { - "backref": "basedOn_task", - "description": "[Text representation of Reference] BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.", - "element_property": true, - "enum_reference_types": [ - "Resource" - ], - "items": { - "type": "string" - }, - "title": "Request fulfilled by this task", - "type": "array" + "file_format": { + "$ref": "#/file_format" }, - "businessStatus": { - "description": "text representation. Contains business-specific nuances of the business state.", - "element_property": true, - "title": "E.g. \"Specimen collected\", \"IV prepped\"", - "type": "string" + "file_name": { + "$ref": "#/file_name" }, - "businessStatus_coding": { - "description": "[system#code representation.] Contains business-specific nuances of the business state.", - "element_property": true, - "title": "E.g. \"Specimen collected\", \"IV prepped\"", - "type": "string" + "file_size": { + "$ref": "#/file_size" }, - "businessStatus_text": { - "description": "[system#code representation.] Contains business-specific nuances of the business state.", - "element_property": true, - "title": "E.g. \"Specimen collected\", \"IV prepped\"", - "type": "string" + "file_state": { + "$ref": "#/file_state" }, - "code": { - "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", - "binding_version": null, - "description": "text representation. A name or code (or both) briefly describing what the task involves.", - "element_property": true, - "term": { - "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/task-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/task-code", - "term_url": "http://hl7.org/fhir/ValueSet/task-code" - } - }, - "title": "Task Type", - "type": "string" + "ga4gh_drs_uri": { + "$ref": "#/ga4gh_drs_uri" }, - "code_coding": { - "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", - "binding_version": null, - "description": "[system#code representation.] A name or code (or both) briefly describing what the task involves.", - "element_property": true, - "term": { - "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/task-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/task-code", - "term_url": "http://hl7.org/fhir/ValueSet/task-code" - } - }, - "title": "Task Type", - "type": "string" + "md5sum": { + "$ref": "#/md5sum" }, - "code_text": { - "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", - "binding_version": null, - "description": "[system#code representation.] A name or code (or both) briefly describing what the task involves.", - "element_property": true, - "term": { - "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/task-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/task-code", - "term_url": "http://hl7.org/fhir/ValueSet/task-code" - } + "object_id": { + "$ref": "#/object_id" + } + }, + "datetime": { + "oneOf": [ + { + "format": "date-time", + "type": "string" }, - "title": "Task Type", - "type": "string" - }, - "description": { - "description": "A free-text description of what is to be performed.", - "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Human-readable explanation of task", - "type": "string" + { + "type": "null" + } + ], + "term": { + "$ref": "_terms.yaml#/datetime" + } + }, + "fhir_resource": { + "additionalProperties": true, + "properties": { + "id": { + "$ref": "#/UUID" + }, + "resource_type": { + "type": "string" + } }, - "doNotPerform": { - "description": "If true indicates that the Task is asking for the specified action to *not* occur.", - "element_property": true, - "title": "True if Task is prohibiting action", - "type": "boolean" + "type": "object" + }, + "file_format": { + "term": { + "$ref": "_terms.yaml#/file_format" }, - "document_reference": { - "backref": "task", - "description": "[Text representation of Reference] The output from this task. Used to generate link.", - "enum_reference_types": [ - "DocumentReference" - ], - "title": "The output from this task.", - "type": "string" + "type": "string" + }, + "file_name": { + "term": { + "$ref": "_terms.yaml#/file_name" }, - "encounter": { - "backref": "task", - "description": "[Text representation of Reference] The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", - "element_property": true, - "enum_reference_types": [ - "Encounter" - ], - "title": "Healthcare event during which this task originated", - "type": "string" + "type": "string" + }, + "file_size": { + "term": { + "$ref": "_terms.yaml#/file_size" }, - "executionPeriod": { - "description": "[Text representation of Period] Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).", - "element_property": true, - "title": "Start and end time of execution", - "type": "string" + "type": "integer" + }, + "file_state": { + "default": "registered", + "enum": [ + "registered", + "uploading", + "uploaded", + "validating", + "validated", + "submitted", + "processing", + "processed", + "released", + "error" + ], + "term": { + "$ref": "_terms.yaml#/file_state" + } + }, + "foreign_key": { + "additionalProperties": true, + "properties": { + "id": { + "$ref": "#/UUID" + }, + "submitter_id": { + "type": "string" + } }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { + "type": "object" + }, + "foreign_key_project": { + "additionalProperties": true, + "properties": { + "code": { "type": "string" }, - "title": "Additional content defined by implementations", - "type": "array" + "id": { + "$ref": "#/UUID" + } }, - "focus": { - "backref": "focus_task", - "description": "[Text representation of Reference] The request being fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.", - "element_property": true, - "enum_reference_types": [ - "Resource" - ], - "title": "What task is acting on", - "type": "string" + "type": "object" + }, + "ga4gh_drs_uri": { + "term": { + "$ref": "_terms.yaml#/ga4gh_drs_uri" }, - "for_fhir": { - "backref": "for_task", - "description": "[Text representation of Reference] [Reserved word `for` renamed to `for_fhir`] The entity who benefits from the performance of the service specified in the task (e.g., the patient).", - "element_property": true, - "enum_reference_types": [ - "Resource" - ], - "title": "Beneficiary of the Task", - "type": "string" + "type": "string" + }, + "id": "_definitions", + "md5sum": { + "pattern": "^[a-f0-9]{32}$", + "term": { + "$ref": "_terms.yaml#/md5sum" }, - "groupIdentifier": { - "description": "[Text representation of Identifier] A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.", - "element_property": true, - "title": "Requisition or grouper id", - "type": "string" + "type": "string" + }, + "object_id": { + "description": "The GUID of the object in the index service.", + "type": "string" + }, + "parent_uuids": { + "items": { + "$ref": "#/UUID" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", - "type": "string" + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" }, - "identifier": { - "description": "The business identifier for this task.", - "element_property": true, - "items": { - "type": "string" + "type": "string" + }, + "qc_metrics_state": { + "enum": [ + "FAIL", + "PASS", + "WARN" + ], + "term": { + "$ref": "_terms.yaml#/qc_metric_state" + } + }, + "release_state": { + "default": "unreleased", + "description": "Release state of an entity.", + "enum": [ + "unreleased", + "released", + "redacted" + ] + }, + "state": { + "default": "validated", + "downloadable": [ + "uploaded", + "md5summed", + "validating", + "validated", + "error", + "invalid", + "released" + ], + "oneOf": [ + { + "enum": [ + "uploading", + "uploaded", + "md5summing", + "md5summed", + "validating", + "error", + "invalid", + "suppressed", + "redacted", + "live" + ] }, - "title": "Task Instance Identifier", - "type": "array" - }, - "identifier_coding": { - "description": "[system#code representation of identifier] The business identifier for this task.", - "element_property": true, - "items": { - "type": "string" + { + "enum": [ + "validated", + "submitted", + "released" + ] + } + ], + "public": [ + "live" + ], + "term": { + "$ref": "_terms.yaml#/state" + } + }, + "to_many": { + "anyOf": [ + { + "items": { + "$ref": "#/foreign_key", + "minItems": 1 + }, + "type": "array" }, - "title": "Task Instance Identifier", - "type": "array" - }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] The business identifier for this task.", - "element_property": true, - "items": { - "type": "string" + { + "$ref": "#/foreign_key" + } + ] + }, + "to_many_project": { + "anyOf": [ + { + "items": { + "$ref": "#/foreign_key_project", + "minItems": 1 + }, + "type": "array" }, - "title": "Task Instance Identifier", - "type": "array" + { + "$ref": "#/foreign_key_project" + } + ] + }, + "to_one": { + "anyOf": [ + { + "items": { + "$ref": "#/foreign_key", + "maxItems": 1, + "minItems": 1 + }, + "type": "array" + }, + { + "$ref": "#/foreign_key" + } + ] + }, + "to_one_project": { + "anyOf": [ + { + "items": { + "$ref": "#/foreign_key_project", + "maxItems": 1, + "minItems": 1 + }, + "type": "array" + }, + { + "$ref": "#/foreign_key_project" + } + ] + }, + "ubiquitous_properties": { + "created_datetime": { + "$ref": "#/datetime" }, - "input_valueReference": { - "backref": "task_input", - "description": "[Text representation of Reference] [Plucked from Task.input] The value of the input parameter as a basic type.", - "element_property": true, - "one_of_many": "value", - "one_of_many_required": true, - "title": "Content to use in performing the task", - "type": "string" + "id": { + "$ref": "#/UUID", + "systemAlias": "node_id" }, - "instantiatesCanonical": { - "description": "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", - "element_property": true, - "enum_reference_types": [ - "ActivityDefinition" - ], - "pattern": "\\S*", - "title": "Formal definition of task", - "type": "string" + "project_id": { + "$ref": "#/project_id" }, - "instantiatesUri": { - "description": "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", - "element_property": true, - "pattern": "\\S*", - "title": "Formal definition of task", - "type": "string" + "state": { + "$ref": "#/state" }, - "insurance": { - "backref": "insurance_task", - "description": "[Text representation of Reference] Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.", - "element_property": true, - "enum_reference_types": [ - "Coverage", - "ClaimResponse" - ], - "items": { - "type": "string" - }, - "title": "Associated insurance coverage", - "type": "array" + "submitter_id": { + "description": "A project-specific identifier for a node. This property is the calling card/nickname/alias for a unit of submission. It can be used in place of the UUID for identifying or recalling a node.\n", + "type": [ + "string" + ] }, - "intent": { - "binding_description": "Distinguishes whether the task is a proposal, plan or full order.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-intent", - "binding_version": "5.0.0", - "description": "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.", - "element_property": true, - "element_required": true, - "enum_values": [ - "unknown", - "proposal", - "plan", - "order", - "original-order", - "reflex-order", - "filler-order", - "instance-order", - "option" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", + "type": { "type": "string" }, - "lastModified": { - "description": "The date and time of last modification to this task.", - "element_property": true, - "format": "date-time", - "title": "Task Last Modified Date", + "updated_datetime": { + "$ref": "#/datetime" + } + }, + "workflow_properties": { + "$ref": "#/ubiquitous_properties", + "workflow_end_datetime": { + "$ref": "#/datetime" + }, + "workflow_link": { + "description": "Link to Github hash for the CWL workflow used.", "type": "string" }, - "location": { - "backref": "task", - "description": "[Text representation of Reference] Principal physical location where this task is performed.", - "element_property": true, - "enum_reference_types": [ - "Location" - ], - "title": "Where task occurs", + "workflow_start_datetime": { + "$ref": "#/datetime" + }, + "workflow_version": { + "description": "Major version for a GDC workflow.", "type": "string" + } + } + }, + "document_reference.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "data_file", + "description": "A reference to a document. A reference to a document of any kind for any purpose. While the term \u201cdocument\u201d implies a more narrow focus, for this resource this \"document\" encompasses *any* serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference. [See https://hl7.org/fhir/R5/DocumentReference.html]", + "id": "document_reference", + "links": [ + { + "backref": "subject_DocumentReference", + "label": "DocumentReference_subject_ResearchStudy_subject_DocumentReference", + "multiplicity": "many_to_many", + "name": "subject_ResearchStudy", + "required": false, + "target_type": "research_study" }, - "note": { - "description": "[Text representation of Annotation] Free-text information captured about the task as it progresses.", + { + "backref": "subject_DocumentReference", + "label": "DocumentReference_subject_Patient_subject_DocumentReference", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" + }, + { + "backref": "subject_DocumentReference", + "label": "DocumentReference_subject_Specimen_subject_DocumentReference", + "multiplicity": "many_to_many", + "name": "subject_Specimen", + "required": false, + "target_type": "specimen" + }, + { + "backref": "subject_DocumentReference", + "label": "DocumentReference_subject_Observation_subject_DocumentReference", + "multiplicity": "many_to_many", + "name": "subject_Observation", + "required": false, + "target_type": "observation" + } + ], + "program": "*", + "project": "*", + "properties": { + "$ref": "_definitions.yaml#/data_file_properties", + "attester": { + "description": "[Text representation of DocumentReferenceAttester] A participant who has authenticated the accuracy of the document.", "element_property": true, "items": { "type": "string" }, - "title": "Comments made about the task", + "title": "Attests to accuracy of the document", "type": "array" }, - "output_valueReference": { - "backref": "task_output", - "description": "[Text representation of Reference] [Plucked from Task.output] The value of the Output parameter as a basic type.", - "element_property": true, - "one_of_many": "value", - "one_of_many_required": true, - "title": "Result of output", + "auth_resource_path": { + "description": "Gen3 scaffolding", "type": "string" }, - "owner": { - "backref": "owner_task", - "description": "[Text representation of Reference] Party responsible for managing task execution.", + "author": { + "backref": "author_document_reference", + "description": "[Text representation of Reference] Identifies who is responsible for adding the information to the document.", "element_property": true, "enum_reference_types": [ "Practitioner", "PractitionerRole", "Organization", - "CareTeam", + "Device", "Patient", - "RelatedPerson" - ], - "title": "Responsible individual", - "type": "string" - }, - "partOf": { - "backref": "partOf_task", - "description": "[Text representation of Reference] Task that this particular task is part of.", - "element_property": true, - "enum_reference_types": [ - "Task" + "RelatedPerson", + "CareTeam" ], "items": { "type": "string" }, - "title": "Composite task", + "title": "Who and/or what authored the document", "type": "array" }, - "performer": { - "description": "[Text representation of TaskPerformer] The entity who performed the requested task.", + "basedOn": { + "backref": "basedOn_document_reference", + "description": "[Text representation of Reference] A procedure that is fulfilled in whole or in part by the creation of this media.", "element_property": true, + "enum_reference_types": [ + "Appointment", + "AppointmentResponse", + "CarePlan", + "Claim", + "CommunicationRequest", + "Contract", + "CoverageEligibilityRequest", + "DeviceRequest", + "EnrollmentRequest", + "ImmunizationRecommendation", + "MedicationRequest", + "NutritionOrder", + "RequestOrchestration", + "ServiceRequest", + "SupplyRequest", + "VisionPrescription" + ], "items": { "type": "string" }, - "title": "Who or what performed the task", + "title": "Procedure that caused this media to be created", "type": "array" }, - "priority": { - "binding_description": "The priority of a task (may affect service level applied to the task).", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/request-priority", - "binding_version": "5.0.0", - "description": "Indicates how quickly the Task should be addressed with respect to other requests.", + "bodySite": { + "backref": "bodySite_document_reference", + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "text representation. The anatomic structures included in the document.", "element_property": true, - "enum_values": [ - "routine", - "urgent", - "asap", - "stat" + "enum_reference_types": [ + "BodyStructure" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "routine | urgent | asap | stat", - "type": "string" - }, - "project_id": { + "items": { + "type": "string" + }, "term": { - "$ref": "_terms.yaml#/project_id" + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } }, - "type": "string" + "title": "Body part included", + "type": "array" }, - "reason": { - "backref": "reason_task", - "description": "text representation. A description, code, or reference indicating why this task needs to be performed.", + "bodySite_coding": { + "backref": "bodySite_document_reference", + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] The anatomic structures included in the document.", "element_property": true, + "enum_reference_types": [ + "BodyStructure" + ], "items": { "type": "string" }, - "title": "Why task is needed", - "type": "array" - }, - "reason_coding": { - "backref": "reason_task", - "description": "[system#code representation.] A description, code, or reference indicating why this task needs to be performed.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Why task is needed", - "type": "array" - }, - "reason_text": { - "backref": "reason_task", - "description": "[system#code representation.] A description, code, or reference indicating why this task needs to be performed.", - "element_property": true, - "items": { - "type": "string" + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } }, - "title": "Why task is needed", + "title": "Body part included", "type": "array" }, - "relevantHistory": { - "backref": "relevantHistory_task", - "description": "[Text representation of Reference] Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.", + "bodySite_text": { + "backref": "bodySite_document_reference", + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] The anatomic structures included in the document.", "element_property": true, "enum_reference_types": [ - "Provenance" + "BodyStructure" ], "items": { "type": "string" }, - "title": "Key events in history of the Task", + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Body part included", "type": "array" }, - "requestedPerformer": { - "backref": "requestedPerformer_task", - "binding_description": "The type(s) of task performers allowed.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", + "category": { + "binding_description": "High-level kind of document at a macro level.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/referenced-item-category", "binding_version": null, - "description": "text representation. The kind of participant or specific participant that should perform the task.", + "description": "text representation. A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "CareTeam", - "HealthcareService", - "Patient", - "Device", - "RelatedPerson" - ], "items": { "type": "string" }, "term": { - "description": "The type(s) of task performers allowed.", + "description": "High-level kind of document at a macro level.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/performer-role", + "cde_id": "http://hl7.org/fhir/ValueSet/referenced-item-category", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/performer-role", - "term_url": "http://hl7.org/fhir/ValueSet/performer-role" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "term_url": "http://hl7.org/fhir/ValueSet/referenced-item-category" } }, - "title": "Who should perform Task", + "title": "Categorization of document", "type": "array" }, - "requestedPerformer_coding": { - "backref": "requestedPerformer_task", - "binding_description": "The type(s) of task performers allowed.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", + "category_coding": { + "binding_description": "High-level kind of document at a macro level.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/referenced-item-category", "binding_version": null, - "description": "[system#code representation.] The kind of participant or specific participant that should perform the task.", + "description": "[system#code representation.] A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "CareTeam", - "HealthcareService", - "Patient", - "Device", - "RelatedPerson" - ], "items": { "type": "string" }, "term": { - "description": "The type(s) of task performers allowed.", + "description": "High-level kind of document at a macro level.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/performer-role", + "cde_id": "http://hl7.org/fhir/ValueSet/referenced-item-category", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/performer-role", - "term_url": "http://hl7.org/fhir/ValueSet/performer-role" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "term_url": "http://hl7.org/fhir/ValueSet/referenced-item-category" } }, - "title": "Who should perform Task", + "title": "Categorization of document", "type": "array" }, - "requestedPerformer_text": { - "backref": "requestedPerformer_task", - "binding_description": "The type(s) of task performers allowed.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", + "category_text": { + "binding_description": "High-level kind of document at a macro level.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/referenced-item-category", "binding_version": null, - "description": "[system#code representation.] The kind of participant or specific participant that should perform the task.", + "description": "[system#code representation.] A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.", "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole", - "Organization", - "CareTeam", - "HealthcareService", - "Patient", - "Device", - "RelatedPerson" - ], "items": { "type": "string" }, "term": { - "description": "The type(s) of task performers allowed.", + "description": "High-level kind of document at a macro level.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/performer-role", + "cde_id": "http://hl7.org/fhir/ValueSet/referenced-item-category", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/performer-role", - "term_url": "http://hl7.org/fhir/ValueSet/performer-role" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/referenced-item-category", + "term_url": "http://hl7.org/fhir/ValueSet/referenced-item-category" } }, - "title": "Who should perform Task", + "title": "Categorization of document", "type": "array" }, - "requestedPeriod": { - "description": "[Text representation of Period] Indicates the start and/or end of the period of time when completion of the task is desired to take place.", + "content_attachment_contentType": { + "binding_description": "BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/mimetypes", + "binding_version": "5.0.0", + "description": "[Plucked from DocumentReference.content] Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.", "element_property": true, - "title": "When the task should be performed", + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "Mime type of the content, with charset etc.", "type": "string" }, - "requester": { - "backref": "requester_task", - "description": "[Text representation of Reference] The creator of the task.", - "element_property": true, - "enum_reference_types": [ - "Device", - "Organization", - "Patient", - "Practitioner", - "PractitionerRole", - "RelatedPerson" - ], - "title": "Who is asking for task to be done", + "content_attachment_extension_md5": { + "description": "[Plucked from DocumentReference.content] Value of extension", "type": "string" }, - "resourceType": { - "const": "Task", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + "content_attachment_size": { + "description": "[Plucked from DocumentReference.content] The number of bytes of data that make up this attachment (before base64 encoding, if that is done).", + "element_property": true, + "title": "Number of bytes of content (if url provided)", + "type": "integer" }, - "restriction": { - "description": "[Text representation of TaskRestriction] If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.", + "content_attachment_url": { + "description": "[Plucked from DocumentReference.content] A location where the data can be accessed.", "element_property": true, - "title": "Constraints on fulfillment tasks", + "format": "uri", + "maxLength": 65536, + "minLength": 1, + "title": "Uri where the data can be found", "type": "string" }, - "specimen": { - "backref": "task", - "description": "[Text representation of Reference] The specimen input to this task. Used to generate link.", + "context": { + "backref": "context_document_reference", + "description": "[Text representation of Reference] Describes the clinical encounter or type of care that the document content is associated with.", + "element_property": true, "enum_reference_types": [ - "Specimen" + "Appointment", + "Encounter", + "EpisodeOfCare" ], - "title": "The specimen input to this task.", - "type": "string" + "items": { + "type": "string" + }, + "title": "Context of the document content", + "type": "array" }, - "status": { - "binding_description": "The current status of the task.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-status", - "binding_version": "5.0.0", - "description": "The current status of the task.", + "custodian": { + "backref": "custodian_document_reference", + "description": "[Text representation of Reference] Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.", "element_property": true, - "element_required": true, - "enum_values": [ - "draft", - "requested", - "received", - "accepted", - "+" + "enum_reference_types": [ + "Organization" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "draft | requested | received | accepted | +", + "title": "Organization which maintains the document", "type": "string" }, - "statusReason": { - "backref": "task", - "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", - "binding_version": null, - "description": "text representation. An explanation as to why this task is held, failed, was refused, etc.", - "element_property": true, + "data_category": { "term": { - "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/task-status-reason", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/task-status-reason", - "term_url": "http://hl7.org/fhir/ValueSet/task-status-reason" - } + "$ref": "_terms.yaml#/data_category" }, - "title": "Reason for current status", "type": "string" }, - "statusReason_coding": { - "backref": "task", - "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", - "binding_version": null, - "description": "[system#code representation.] An explanation as to why this task is held, failed, was refused, etc.", - "element_property": true, + "data_format": { "term": { - "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/task-status-reason", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/task-status-reason", - "term_url": "http://hl7.org/fhir/ValueSet/task-status-reason" - } + "$ref": "_terms.yaml#/data_format" }, - "title": "Reason for current status", "type": "string" }, - "statusReason_text": { - "backref": "task", - "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", - "binding_version": null, - "description": "[system#code representation.] An explanation as to why this task is held, failed, was refused, etc.", - "element_property": true, + "data_type": { "term": { - "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/task-status-reason", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/task-status-reason", - "term_url": "http://hl7.org/fhir/ValueSet/task-status-reason" - } + "$ref": "_terms.yaml#/data_type" }, - "title": "Reason for current status", - "type": "string" - } - }, - "systemProperties": [ - "id" - ], - "title": "Task", - "type": "object", - "uniqueKeys": [ - [ - "id" - ] - ] - }, - "condition.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": true, - "category": "Clinical", - "description": "Detailed information about conditions, problems or diagnoses. A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. [See https://hl7.org/fhir/R5/Condition.html]", - "id": "condition", - "links": [ - { - "backref": "condition", - "label": "Condition_subject_Patient_condition", - "multiplicity": "many_to_many", - "name": "subject_Patient", - "required": false, - "target_type": "patient" - } - ], - "program": "*", - "project": "*", - "properties": { - "abatementAge": { - "description": "[Text representation of Age] The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", - "element_property": true, - "one_of_many": "abatement", - "one_of_many_required": false, - "title": "When in resolution/remission", "type": "string" }, - "abatementDateTime": { - "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", + "date": { + "description": "When the document reference was created.", "element_property": true, "format": "date-time", - "one_of_many": "abatement", - "one_of_many_required": false, - "title": "When in resolution/remission", - "type": "string" - }, - "abatementPeriod": { - "description": "[Text representation of Period] The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", - "element_property": true, - "one_of_many": "abatement", - "one_of_many_required": false, - "title": "When in resolution/remission", + "title": "When this document reference was created", "type": "string" }, - "abatementRange": { - "description": "[Text representation of Range] The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", + "description": { + "description": "Human-readable description of the source document.", "element_property": true, - "one_of_many": "abatement", - "one_of_many_required": false, - "title": "When in resolution/remission", + "pattern": "\\s*(\\S|\\s)*", + "title": "Human-readable description", "type": "string" }, - "abatementString": { - "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", + "docStatus": { + "binding_description": "Status of the underlying document.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/composition-status", + "binding_version": "5.0.0", + "description": "The status of the underlying document.", "element_property": true, - "one_of_many": "abatement", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "When in resolution/remission", + "enum_values": [ + "registered", + "partial", + "preliminary", + "final", + "amended", + "corrected", + "appended", + "cancelled", + "entered-in-error", + "deprecated", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown", "type": "string" }, - "bodySite": { - "binding_description": "SNOMED CT Body site concepts", + "event": { + "backref": "event_document_reference", + "binding_description": "This list of codes represents the main clinical acts being documented.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActCode", "binding_version": null, - "description": "text representation. The anatomical location where this condition manifests itself.", + "description": "text representation. This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "This list of codes represents the main clinical acts being documented.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://terminology.hl7.org/ValueSet/v3-ActCode", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://terminology.hl7.org/ValueSet/v3-ActCode", + "term_url": "http://terminology.hl7.org/ValueSet/v3-ActCode" } }, - "title": "Anatomical location, if relevant", + "title": "Main clinical acts documented", "type": "array" }, - "bodySite_coding": { - "binding_description": "SNOMED CT Body site concepts", + "event_coding": { + "backref": "event_document_reference", + "binding_description": "This list of codes represents the main clinical acts being documented.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActCode", "binding_version": null, - "description": "[system#code representation.] The anatomical location where this condition manifests itself.", + "description": "[system#code representation.] This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "This list of codes represents the main clinical acts being documented.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://terminology.hl7.org/ValueSet/v3-ActCode", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://terminology.hl7.org/ValueSet/v3-ActCode", + "term_url": "http://terminology.hl7.org/ValueSet/v3-ActCode" } }, - "title": "Anatomical location, if relevant", + "title": "Main clinical acts documented", "type": "array" }, - "bodySite_text": { - "binding_description": "SNOMED CT Body site concepts", + "event_text": { + "backref": "event_document_reference", + "binding_description": "This list of codes represents the main clinical acts being documented.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-ActCode", "binding_version": null, - "description": "[system#code representation.] The anatomical location where this condition manifests itself.", + "description": "[system#code representation.] This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "This list of codes represents the main clinical acts being documented.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://terminology.hl7.org/ValueSet/v3-ActCode", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://terminology.hl7.org/ValueSet/v3-ActCode", + "term_url": "http://terminology.hl7.org/ValueSet/v3-ActCode" } }, - "title": "Anatomical location, if relevant", + "title": "Main clinical acts documented", "type": "array" }, - "category": { - "binding_description": "A category assigned to the condition.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-category", - "binding_version": null, - "description": "text representation. A category assigned to the condition.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "A category assigned to the condition.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-category", - "cde_version": null, - "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/condition-category", - "term_url": "http://hl7.org/fhir/ValueSet/condition-category" - } - }, - "title": "problem-list-item | encounter-diagnosis", + "title": "Additional content defined by implementations", "type": "array" }, - "category_coding": { - "binding_description": "A category assigned to the condition.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-category", + "facilityType": { + "binding_description": "XDS Facility Type.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", "binding_version": null, - "description": "[system#code representation.] A category assigned to the condition.", + "description": "text representation. The kind of facility where the patient was seen.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A category assigned to the condition.", + "description": "XDS Facility Type.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-category", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/condition-category", - "term_url": "http://hl7.org/fhir/ValueSet/condition-category" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" } }, - "title": "problem-list-item | encounter-diagnosis", - "type": "array" + "title": "Kind of facility where patient was seen", + "type": "string" }, - "category_text": { - "binding_description": "A category assigned to the condition.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-category", + "facilityType_coding": { + "binding_description": "XDS Facility Type.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", "binding_version": null, - "description": "[system#code representation.] A category assigned to the condition.", + "description": "[system#code representation.] The kind of facility where the patient was seen.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A category assigned to the condition.", + "description": "XDS Facility Type.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-category", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/condition-category", - "term_url": "http://hl7.org/fhir/ValueSet/condition-category" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" } }, - "title": "problem-list-item | encounter-diagnosis", - "type": "array" + "title": "Kind of facility where patient was seen", + "type": "string" }, - "clinicalStatus": { - "binding_description": "The clinical status of the condition or diagnosis.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-clinical", - "binding_version": "5.0.0", - "description": "text representation. The clinical status of the condition.", + "facilityType_text": { + "binding_description": "XDS Facility Type.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", + "binding_version": null, + "description": "[system#code representation.] The kind of facility where the patient was seen.", "element_property": true, "term": { - "description": "The clinical status of the condition or diagnosis.", + "description": "XDS Facility Type.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-clinical", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", "cde_version": null, "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/condition-clinical", - "term_url": "http://hl7.org/fhir/ValueSet/condition-clinical" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/c80-facilitycodes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-facilitycodes" } }, - "title": "active | recurrence | relapse | inactive | remission | resolved | unknown", + "title": "Kind of facility where patient was seen", "type": "string" }, - "clinicalStatus_coding": { - "binding_description": "The clinical status of the condition or diagnosis.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-clinical", - "binding_version": "5.0.0", - "description": "[system#code representation.] The clinical status of the condition.", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Other business identifiers associated with the document, including version independent identifiers.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business identifiers for the document", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Other business identifiers associated with the document, including version independent identifiers.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business identifiers for the document", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Other business identifiers associated with the document, including version independent identifiers.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business identifiers for the document", + "type": "array" + }, + "modality": { + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "binding_version": null, + "description": "text representation. Imaging modality used. This may include both acquisition and non-acquisition modalities.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The clinical status of the condition or diagnosis.", + "description": "Type of acquired data in the instance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-clinical", + "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "cde_version": null, "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/condition-clinical", - "term_url": "http://hl7.org/fhir/ValueSet/condition-clinical" + "strength": "extensible", + "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" } }, - "title": "active | recurrence | relapse | inactive | remission | resolved | unknown", - "type": "string" + "title": "Imaging modality used", + "type": "array" }, - "clinicalStatus_text": { - "binding_description": "The clinical status of the condition or diagnosis.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-clinical", - "binding_version": "5.0.0", - "description": "[system#code representation.] The clinical status of the condition.", + "modality_coding": { + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "binding_version": null, + "description": "[system#code representation.] Imaging modality used. This may include both acquisition and non-acquisition modalities.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The clinical status of the condition or diagnosis.", + "description": "Type of acquired data in the instance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-clinical", + "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "cde_version": null, "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/condition-clinical", - "term_url": "http://hl7.org/fhir/ValueSet/condition-clinical" + "strength": "extensible", + "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" } }, - "title": "active | recurrence | relapse | inactive | remission | resolved | unknown", + "title": "Imaging modality used", + "type": "array" + }, + "modality_text": { + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "binding_version": null, + "description": "[system#code representation.] Imaging modality used. This may include both acquisition and non-acquisition modalities.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "Type of acquired data in the instance.", + "termDef": { + "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" + } + }, + "title": "Imaging modality used", + "type": "array" + }, + "patient_id": { + "description": "Denormalized patient id", "type": "string" }, - "code": { - "binding_description": "Identification of the condition or diagnosis.", + "patient_identifier": { + "description": "Denormalized patient identifier", + "items": { + "type": "string" + }, + "type": "array" + }, + "period": { + "description": "[Text representation of Period] The time period over which the service that is described by the document was provided.", + "element_property": true, + "title": "Time of service that is being documented", + "type": "string" + }, + "practiceSetting": { + "binding_description": "Additional details about where the content was created (e.g. clinical specialty).", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "binding_version": null, - "description": "text representation. Identification of the condition, problem or diagnosis", + "description": "text representation. This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", "element_property": true, "term": { - "description": "Identification of the condition or diagnosis.", + "description": "Additional details about where the content was created (e.g. clinical specialty).", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, - "title": "Identification of the condition, problem or diagnosis", + "title": "Additional details about where the content was created (e.g. clinical specialty)", "type": "string" }, - "code_coding": { - "binding_description": "Identification of the condition or diagnosis.", + "practiceSetting_coding": { + "binding_description": "Additional details about where the content was created (e.g. clinical specialty).", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "binding_version": null, - "description": "[system#code representation.] Identification of the condition, problem or diagnosis", + "description": "[system#code representation.] This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", "element_property": true, "term": { - "description": "Identification of the condition or diagnosis.", + "description": "Additional details about where the content was created (e.g. clinical specialty).", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, - "title": "Identification of the condition, problem or diagnosis", + "title": "Additional details about where the content was created (e.g. clinical specialty)", "type": "string" }, - "code_text": { - "binding_description": "Identification of the condition or diagnosis.", + "practiceSetting_text": { + "binding_description": "Additional details about where the content was created (e.g. clinical specialty).", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_uri": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "binding_version": null, - "description": "[system#code representation.] Identification of the condition, problem or diagnosis", + "description": "[system#code representation.] This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.", "element_property": true, "term": { - "description": "Identification of the condition or diagnosis.", + "description": "Additional details about where the content was created (e.g. clinical specialty).", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_id": "http://hl7.org/fhir/ValueSet/c80-practice-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + "term": "http://hl7.org/fhir/ValueSet/c80-practice-codes", + "term_url": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, - "title": "Identification of the condition, problem or diagnosis", + "title": "Additional details about where the content was created (e.g. clinical specialty)", "type": "string" }, - "encounter": { - "backref": "condition", - "description": "[Text representation of Reference] The Encounter during which this Condition was created or to which the creation of this record is tightly associated.", + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "relatesTo": { + "description": "[Text representation of DocumentReferenceRelatesTo] Relationships that this document has with other document references that already exist.", "element_property": true, - "enum_reference_types": [ - "Encounter" - ], - "title": "The Encounter during which this Condition was created", + "items": { + "type": "string" + }, + "title": "Relationships to other documents", + "type": "array" + }, + "resourceType": { + "const": "DocumentReference", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", "type": "string" }, - "evidence": { - "backref": "evidence_condition", - "binding_description": null, + "securityLabel": { + "binding_description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_uri": "http://hl7.org/fhir/ValueSet/security-label-examples", "binding_version": null, - "description": "text representation. Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", + "description": "text representation. A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.", "element_property": true, - "enum_reference_types": [ - "Resource" - ], "items": { "type": "string" }, "term": { - "description": null, + "description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_id": "http://hl7.org/fhir/ValueSet/security-label-examples", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/clinical-findings", - "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + "term": "http://hl7.org/fhir/ValueSet/security-label-examples", + "term_url": "http://hl7.org/fhir/ValueSet/security-label-examples" } }, - "title": "Supporting evidence for the verification status", + "title": "Document security-tags", "type": "array" }, - "evidence_coding": { - "backref": "evidence_condition", - "binding_description": null, + "securityLabel_coding": { + "binding_description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_uri": "http://hl7.org/fhir/ValueSet/security-label-examples", "binding_version": null, - "description": "[system#code representation.] Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", + "description": "[system#code representation.] A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.", "element_property": true, - "enum_reference_types": [ - "Resource" - ], "items": { "type": "string" }, "term": { - "description": null, + "description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_id": "http://hl7.org/fhir/ValueSet/security-label-examples", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/clinical-findings", - "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + "term": "http://hl7.org/fhir/ValueSet/security-label-examples", + "term_url": "http://hl7.org/fhir/ValueSet/security-label-examples" } }, - "title": "Supporting evidence for the verification status", + "title": "Document security-tags", "type": "array" }, - "evidence_text": { - "backref": "evidence_condition", - "binding_description": null, + "securityLabel_text": { + "binding_description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_uri": "http://hl7.org/fhir/ValueSet/security-label-examples", "binding_version": null, - "description": "[system#code representation.] Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", + "description": "[system#code representation.] A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.", "element_property": true, - "enum_reference_types": [ - "Resource" - ], "items": { "type": "string" }, "term": { - "description": null, + "description": "Example Security Labels from the Healthcare Privacy and Security Classification System.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_id": "http://hl7.org/fhir/ValueSet/security-label-examples", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/clinical-findings", - "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + "term": "http://hl7.org/fhir/ValueSet/security-label-examples", + "term_url": "http://hl7.org/fhir/ValueSet/security-label-examples" } }, - "title": "Supporting evidence for the verification status", - "type": "array" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", - "type": "string" - }, - "identifier": { - "description": "Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "External Ids for this condition", - "type": "array" - }, - "identifier_coding": { - "description": "[system#code representation of identifier] Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "External Ids for this condition", - "type": "array" - }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "External Ids for this condition", + "title": "Document security-tags", "type": "array" }, - "note": { - "description": "[Text representation of Annotation] Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.", - "element_property": true, + "specimen_identifier": { + "description": "Denormalized specimen identifier", "items": { "type": "string" }, - "title": "Additional information about the Condition", "type": "array" }, - "onsetAge": { - "description": "[Text representation of Age] Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "title": "Estimated or actual date, date-time, or age", - "type": "string" - }, - "onsetDateTime": { - "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "element_property": true, - "format": "date-time", - "one_of_many": "onset", - "one_of_many_required": false, - "title": "Estimated or actual date, date-time, or age", - "type": "string" - }, - "onsetPeriod": { - "description": "[Text representation of Period] Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "title": "Estimated or actual date, date-time, or age", - "type": "string" - }, - "onsetRange": { - "description": "[Text representation of Range] Estimated or actual date or date-time the condition began, in the opinion of the clinician.", + "status": { + "binding_description": "The status of the document reference.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/document-reference-status", + "binding_version": "5.0.0", + "description": "The status of this document reference.", "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "title": "Estimated or actual date, date-time, or age", + "element_required": true, + "enum_values": [ + "current", + "superseded", + "entered-in-error" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "current | superseded | entered-in-error", "type": "string" }, - "onsetString": { - "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", - "element_property": true, - "one_of_many": "onset", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Estimated or actual date, date-time, or age", + "subject": { + "backref": "subject_DocumentReference", + "description": "[Text representation of Reference] Who/what is the subject of the document.", + "enum_reference_types": [ + "ResearchStudy", + "Patient", + "Specimen", + "Observation" + ], + "title": "The item that this DocumentReference is about.", "type": "string" }, - "participant": { - "description": "[Text representation of ConditionParticipant] Indicates who or what participated in the activities related to the condition and how they were involved.", - "element_property": true, + "task_identifier": { + "description": "Denormalized task identifier", "items": { "type": "string" }, - "title": "Who or what participated in the activities related to the condition and how they were involved", "type": "array" }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" - }, - "type": "string" - }, - "recordedDate": { - "description": "The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.", - "element_property": true, - "format": "date-time", - "title": "Date condition was first recorded", - "type": "string" - }, - "resourceType": { - "const": "Condition", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "severity": { - "binding_description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "type": { + "binding_description": "Precise type of clinical document.", "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-severity", + "binding_uri": "http://hl7.org/fhir/ValueSet/doc-typecodes", "binding_version": null, - "description": "text representation. A subjective assessment of the severity of the condition as evaluated by the clinician.", + "description": "text representation. Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", "element_property": true, "term": { - "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "description": "Precise type of clinical document.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-severity", + "cde_id": "http://hl7.org/fhir/ValueSet/doc-typecodes", "cde_version": null, "source": "fhir", "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/condition-severity", - "term_url": "http://hl7.org/fhir/ValueSet/condition-severity" + "term": "http://hl7.org/fhir/ValueSet/doc-typecodes", + "term_url": "http://hl7.org/fhir/ValueSet/doc-typecodes" } }, - "title": "Subjective severity of condition", + "title": "Kind of document (LOINC if possible)", "type": "string" }, - "severity_coding": { - "binding_description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "type_coding": { + "binding_description": "Precise type of clinical document.", "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-severity", + "binding_uri": "http://hl7.org/fhir/ValueSet/doc-typecodes", "binding_version": null, - "description": "[system#code representation.] A subjective assessment of the severity of the condition as evaluated by the clinician.", + "description": "[system#code representation.] Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", "element_property": true, "term": { - "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "description": "Precise type of clinical document.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-severity", + "cde_id": "http://hl7.org/fhir/ValueSet/doc-typecodes", "cde_version": null, "source": "fhir", "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/condition-severity", - "term_url": "http://hl7.org/fhir/ValueSet/condition-severity" + "term": "http://hl7.org/fhir/ValueSet/doc-typecodes", + "term_url": "http://hl7.org/fhir/ValueSet/doc-typecodes" } }, - "title": "Subjective severity of condition", + "title": "Kind of document (LOINC if possible)", "type": "string" }, - "severity_text": { - "binding_description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "type_text": { + "binding_description": "Precise type of clinical document.", "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-severity", + "binding_uri": "http://hl7.org/fhir/ValueSet/doc-typecodes", "binding_version": null, - "description": "[system#code representation.] A subjective assessment of the severity of the condition as evaluated by the clinician.", + "description": "[system#code representation.] Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.", "element_property": true, "term": { - "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "description": "Precise type of clinical document.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-severity", + "cde_id": "http://hl7.org/fhir/ValueSet/doc-typecodes", "cde_version": null, "source": "fhir", "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/condition-severity", - "term_url": "http://hl7.org/fhir/ValueSet/condition-severity" + "term": "http://hl7.org/fhir/ValueSet/doc-typecodes", + "term_url": "http://hl7.org/fhir/ValueSet/doc-typecodes" } }, - "title": "Subjective severity of condition", + "title": "Kind of document (LOINC if possible)", "type": "string" }, - "stage": { - "description": "[Text representation of ConditionStage] A simple summary of the stage such as \"Stage 3\" or \"Early Onset\". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Stage/grade, usually assessed formally", - "type": "array" - }, - "subject": { - "backref": "condition", - "description": "[Text representation of Reference] Indicates the patient or group who the condition record is associated with.", + "version": { + "description": "An explicitly assigned identifer of a variation of the content in the DocumentReference", "element_property": true, - "enum_reference_types": [ - "Patient", - "Group" - ], - "title": "Who has the condition?", - "type": "string" - }, - "verificationStatus": { - "binding_description": "The verification status to support or decline the clinical status of the condition or diagnosis.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "binding_version": "5.0.0", - "description": "text representation. The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.", - "element_property": true, - "term": { - "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "cde_version": null, - "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "term_url": "http://hl7.org/fhir/ValueSet/condition-ver-status" - } - }, - "title": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", - "type": "string" - }, - "verificationStatus_coding": { - "binding_description": "The verification status to support or decline the clinical status of the condition or diagnosis.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "binding_version": "5.0.0", - "description": "[system#code representation.] The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.", - "element_property": true, - "term": { - "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "cde_version": null, - "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "term_url": "http://hl7.org/fhir/ValueSet/condition-ver-status" - } - }, - "title": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", - "type": "string" - }, - "verificationStatus_text": { - "binding_description": "The verification status to support or decline the clinical status of the condition or diagnosis.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "binding_version": "5.0.0", - "description": "[system#code representation.] The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.", - "element_property": true, - "term": { - "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "cde_version": null, - "source": "fhir", - "strength": "required", - "term": "http://hl7.org/fhir/ValueSet/condition-ver-status", - "term_url": "http://hl7.org/fhir/ValueSet/condition-ver-status" - } - }, - "title": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", + "pattern": "[ \\r\\n\\t\\S]+", + "title": "An explicitly assigned identifer of a variation of the content in the DocumentReference", "type": "string" } }, "systemProperties": [ "id" ], - "title": "Condition", + "title": "DocumentReference", "type": "object", "uniqueKeys": [ [ @@ -6106,317 +5445,251 @@ ] ] }, - "medication_request.yaml": { + "_settings.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "enable_case_cache": false, + "_dict_commit": "520a25999fd183f6c5b7ddef2980f3e839517da5", + "_dict_version": "0.2.1-9-g520a259" + }, + "task.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, - "category": "Clinical", - "description": "Ordering of medication for patient or group. 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. [See https://hl7.org/fhir/R5/MedicationRequest.html]", - "id": "medication_request", + "category": "Analysis", + "description": "A task to be performed. [See https://hl7.org/fhir/R5/Task.html]", + "id": "task", "links": [ { - "backref": "subject_medication_request", - "label": "MedicationRequest_subject_Patient_subject_medication_request", + "backref": "owner_task", + "label": "Task_owner_Practitioner_owner_task", "multiplicity": "many_to_many", - "name": "subject_Patient", + "name": "owner_Practitioner", "required": false, - "target_type": "patient" + "target_type": "practitioner" }, { - "backref": "basedOn_medication_request", - "label": "MedicationRequest_basedOn_MedicationRequest_basedOn_medication_request", + "backref": "owner_task", + "label": "Task_owner_PractitionerRole_owner_task", "multiplicity": "many_to_many", - "name": "basedOn_MedicationRequest", + "name": "owner_PractitionerRole", "required": false, - "target_type": "medication_request" + "target_type": "practitioner_role" }, { - "backref": "medication_request", - "label": "MedicationRequest_medication_Medication_medication_request", + "backref": "owner_task", + "label": "Task_owner_Organization_owner_task", "multiplicity": "many_to_many", - "name": "medication", + "name": "owner_Organization", "required": false, - "target_type": "medication" + "target_type": "organization" }, { - "backref": "reason_medication_request", - "label": "MedicationRequest_reason_Condition_reason_medication_request", + "backref": "owner_task", + "label": "Task_owner_Patient_owner_task", "multiplicity": "many_to_many", - "name": "reason_Condition", + "name": "owner_Patient", "required": false, - "target_type": "condition" + "target_type": "patient" }, { - "backref": "reason_medication_request", - "label": "MedicationRequest_reason_Observation_reason_medication_request", + "backref": "partOf_task", + "label": "Task_partOf_Task_partOf_task", "multiplicity": "many_to_many", - "name": "reason_Observation", + "name": "partOf", "required": false, - "target_type": "observation" + "target_type": "task" + }, + { + "backref": "task", + "label": "Task_specimen_Specimen_task", + "multiplicity": "many_to_many", + "name": "specimen", + "required": false, + "target_type": "specimen" + }, + { + "backref": "task", + "label": "Task_document_reference_DocumentReference_task", + "multiplicity": "many_to_many", + "name": "document_reference", + "required": false, + "target_type": "document_reference" } ], "program": "*", "project": "*", "properties": { "authoredOn": { - "description": "The date (and perhaps time) when the prescription was initially written or authored on.", + "description": "The date and time this task was created.", "element_property": true, "format": "date-time", - "title": "When request was initially authored", + "title": "Task Creation Date", "type": "string" }, "basedOn": { - "backref": "basedOn_medication_request", - "description": "[Text representation of Reference] A plan or request that is fulfilled in whole or in part by this medication request", + "backref": "basedOn_task", + "description": "[Text representation of Reference] BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a \"request\" resource such as a ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the \"request\" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.", "element_property": true, "enum_reference_types": [ - "CarePlan", - "MedicationRequest", - "ServiceRequest", - "ImmunizationRecommendation" + "Resource" ], "items": { "type": "string" }, - "title": "A plan or request that is fulfilled in whole or in part by this medication request", + "title": "Request fulfilled by this task", "type": "array" }, - "category": { - "binding_description": "A coded concept identifying where the medication is to be consumed or administered.", + "businessStatus": { + "description": "text representation. Contains business-specific nuances of the business state.", + "element_property": true, + "title": "E.g. \"Specimen collected\", \"IV prepped\"", + "type": "string" + }, + "businessStatus_coding": { + "description": "[system#code representation.] Contains business-specific nuances of the business state.", + "element_property": true, + "title": "E.g. \"Specimen collected\", \"IV prepped\"", + "type": "string" + }, + "businessStatus_text": { + "description": "[system#code representation.] Contains business-specific nuances of the business state.", + "element_property": true, + "title": "E.g. \"Specimen collected\", \"IV prepped\"", + "type": "string" + }, + "code": { + "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", "binding_version": null, - "description": "text representation. An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.", + "description": "text representation. A name or code (or both) briefly describing what the task involves.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A coded concept identifying where the medication is to be consumed or administered.", + "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "cde_id": "http://hl7.org/fhir/ValueSet/task-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" + "term": "http://hl7.org/fhir/ValueSet/task-code", + "term_url": "http://hl7.org/fhir/ValueSet/task-code" } }, - "title": "Grouping or category of medication request", - "type": "array" + "title": "Task Type", + "type": "string" }, - "category_coding": { - "binding_description": "A coded concept identifying where the medication is to be consumed or administered.", + "code_coding": { + "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", "binding_version": null, - "description": "[system#code representation.] An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.", + "description": "[system#code representation.] A name or code (or both) briefly describing what the task involves.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A coded concept identifying where the medication is to be consumed or administered.", + "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "cde_id": "http://hl7.org/fhir/ValueSet/task-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" + "term": "http://hl7.org/fhir/ValueSet/task-code", + "term_url": "http://hl7.org/fhir/ValueSet/task-code" } }, - "title": "Grouping or category of medication request", - "type": "array" + "title": "Task Type", + "type": "string" }, - "category_text": { - "binding_description": "A coded concept identifying where the medication is to be consumed or administered.", + "code_text": { + "binding_description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-code", "binding_version": null, - "description": "[system#code representation.] An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.", + "description": "[system#code representation.] A name or code (or both) briefly describing what the task involves.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A coded concept identifying where the medication is to be consumed or administered.", + "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "cde_id": "http://hl7.org/fhir/ValueSet/task-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" + "term": "http://hl7.org/fhir/ValueSet/task-code", + "term_url": "http://hl7.org/fhir/ValueSet/task-code" } }, - "title": "Grouping or category of medication request", - "type": "array" + "title": "Task Type", + "type": "string" }, - "courseOfTherapyType": { - "binding_description": "Identifies the overall pattern of medication administratio.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "binding_version": null, - "description": "text representation. The description of the overall pattern of the administration of the medication to the patient.", + "description": { + "description": "A free-text description of what is to be performed.", "element_property": true, - "term": { - "description": "Identifies the overall pattern of medication administratio.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" - } - }, - "title": "Overall pattern of medication administration", + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Human-readable explanation of task", "type": "string" }, - "courseOfTherapyType_coding": { - "binding_description": "Identifies the overall pattern of medication administratio.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "binding_version": null, - "description": "[system#code representation.] The description of the overall pattern of the administration of the medication to the patient.", - "element_property": true, - "term": { - "description": "Identifies the overall pattern of medication administratio.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" - } - }, - "title": "Overall pattern of medication administration", - "type": "string" - }, - "courseOfTherapyType_text": { - "binding_description": "Identifies the overall pattern of medication administratio.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "binding_version": null, - "description": "[system#code representation.] The description of the overall pattern of the administration of the medication to the patient.", - "element_property": true, - "term": { - "description": "Identifies the overall pattern of medication administratio.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" - } - }, - "title": "Overall pattern of medication administration", - "type": "string" - }, - "device": { - "backref": "device_medication_request", - "description": "text representation. The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).", + "doNotPerform": { + "description": "If true indicates that the Task is asking for the specified action to *not* occur.", "element_property": true, - "enum_reference_types": [ - "DeviceDefinition" - ], - "items": { - "type": "string" - }, - "title": "Intended type of device for the administration", - "type": "array" + "title": "True if Task is prohibiting action", + "type": "boolean" }, - "device_coding": { - "backref": "device_medication_request", - "description": "[system#code representation.] The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).", - "element_property": true, + "document_reference": { + "backref": "task", + "description": "[Text representation of Reference] The output from this task. Used to generate link.", "enum_reference_types": [ - "DeviceDefinition" + "DocumentReference" ], - "items": { - "type": "string" - }, - "title": "Intended type of device for the administration", - "type": "array" + "title": "The output from this task.", + "type": "string" }, - "device_text": { - "backref": "device_medication_request", - "description": "[system#code representation.] The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).", + "encounter": { + "backref": "task", + "description": "[Text representation of Reference] The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", "element_property": true, "enum_reference_types": [ - "DeviceDefinition" + "Encounter" ], - "items": { - "type": "string" - }, - "title": "Intended type of device for the administration", - "type": "array" - }, - "dispenseRequest": { - "description": "[Text representation of MedicationRequestDispenseRequest] Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.", - "element_property": true, - "title": "Medication supply authorization", + "title": "Healthcare event during which this task originated", "type": "string" }, - "doNotPerform": { - "description": "If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.", + "executionPeriod": { + "description": "[Text representation of Period] Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).", "element_property": true, - "title": "True if patient is to stop taking or not to start taking the medication", - "type": "boolean" + "title": "Start and end time of execution", + "type": "string" }, - "dosageInstruction": { - "description": "[Text representation of Dosage] Specific instructions for how the medication is to be used by the patient.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "type": "string" }, - "title": "Specific instructions for how the medication should be taken", + "title": "Additional content defined by implementations", "type": "array" }, - "effectiveDosePeriod": { - "description": "[Text representation of Period] The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.", - "element_property": true, - "title": "Period over which the medication is to be taken", - "type": "string" - }, - "encounter": { - "backref": "medication_request", - "description": "[Text representation of Reference] The Encounter during which this [x] was created or to which the creation of this record is tightly associated.", + "focus": { + "backref": "focus_task", + "description": "[Text representation of Reference] The request being fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.", "element_property": true, "enum_reference_types": [ - "Encounter" + "Resource" ], - "title": "Encounter created as part of encounter/admission/stay", + "title": "What task is acting on", "type": "string" }, - "eventHistory": { - "backref": "eventHistory_medication_request", - "description": "[Text representation of Reference] Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.", + "for_fhir": { + "backref": "for_task", + "description": "[Text representation of Reference] [Reserved word `for` renamed to `for_fhir`] The entity who benefits from the performance of the service specified in the task (e.g., the patient).", "element_property": true, "enum_reference_types": [ - "Provenance" + "Resource" ], - "items": { - "type": "string" - }, - "title": "A list of events of interest in the lifecycle", - "type": "array" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Additional content defined by implementations", - "type": "array" + "title": "Beneficiary of the Task", + "type": "string" }, "groupIdentifier": { - "description": "[Text representation of Identifier] A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.", + "description": "[Text representation of Identifier] A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.", "element_property": true, - "title": "Composite request this is part of", + "title": "Requisition or grouper id", "type": "string" }, "id": { @@ -6429,52 +5702,61 @@ "type": "string" }, "identifier": { - "description": "Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", + "description": "The business identifier for this task.", "element_property": true, "items": { "type": "string" }, - "title": "External ids for this request", + "title": "Task Instance Identifier", "type": "array" }, "identifier_coding": { - "description": "[system#code representation of identifier] Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", + "description": "[system#code representation of identifier] The business identifier for this task.", "element_property": true, "items": { "type": "string" }, - "title": "External ids for this request", + "title": "Task Instance Identifier", "type": "array" }, "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", + "description": "[system#code representation of identifier.text] The business identifier for this task.", "element_property": true, "items": { "type": "string" }, - "title": "External ids for this request", + "title": "Task Instance Identifier", "type": "array" }, - "informationSource": { - "backref": "informationSource_medication_request", - "description": "[Text representation of Reference] The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.", + "input_valueReference": { + "backref": "task_input", + "description": "[Text representation of Reference] [Plucked from Task.input] The value of the input parameter as a basic type.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": true, + "title": "Content to use in performing the task", + "type": "string" + }, + "instantiatesCanonical": { + "description": "The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", "element_property": true, "enum_reference_types": [ - "Patient", - "Practitioner", - "PractitionerRole", - "RelatedPerson", - "Organization" + "ActivityDefinition" ], - "items": { - "type": "string" - }, - "title": "The person or organization who provided the information about this request, if the source is someone other than the requestor", - "type": "array" + "pattern": "\\S*", + "title": "Formal definition of task", + "type": "string" + }, + "instantiatesUri": { + "description": "The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.", + "element_property": true, + "pattern": "\\S*", + "title": "Formal definition of task", + "type": "string" }, "insurance": { - "backref": "insurance_medication_request", - "description": "[Text representation of Reference] Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", + "backref": "insurance_task", + "description": "[Text representation of Reference] Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.", "element_property": true, "enum_reference_types": [ "Coverage", @@ -6487,14 +5769,15 @@ "type": "array" }, "intent": { - "binding_description": "The kind of medication order.", + "binding_description": "Distinguishes whether the task is a proposal, plan or full order.", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-intent", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-intent", "binding_version": "5.0.0", - "description": "Whether the request is a proposal, plan, or an original order.", + "description": "Indicates the \"level\" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.", "element_property": true, "element_required": true, "enum_values": [ + "unknown", "proposal", "plan", "order", @@ -6505,192 +5788,87 @@ "option" ], "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", + "title": "unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", "type": "string" }, - "medication": { - "backref": "medication_request", - "binding_description": "A coded concept identifying substance or product that can be ordered.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", - "binding_version": null, - "description": "text representation. Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", + "lastModified": { + "description": "The date and time of last modification to this task.", "element_property": true, - "enum_reference_types": [ - "Medication" - ], - "term": { - "description": "A coded concept identifying substance or product that can be ordered.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" - } - }, - "title": "Medication to be taken", + "format": "date-time", + "title": "Task Last Modified Date", "type": "string" }, - "medication_coding": { - "backref": "medication_request", - "binding_description": "A coded concept identifying substance or product that can be ordered.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", - "binding_version": null, - "description": "[system#code representation.] Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", + "location": { + "backref": "task", + "description": "[Text representation of Reference] Principal physical location where this task is performed.", "element_property": true, "enum_reference_types": [ - "Medication" + "Location" ], - "term": { - "description": "A coded concept identifying substance or product that can be ordered.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" - } - }, - "title": "Medication to be taken", - "type": "string" - }, - "medication_text": { - "backref": "medication_request", - "binding_description": "A coded concept identifying substance or product that can be ordered.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", - "binding_version": null, - "description": "[system#code representation.] Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", - "element_property": true, - "enum_reference_types": [ - "Medication" - ], - "term": { - "description": "A coded concept identifying substance or product that can be ordered.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" - } - }, - "title": "Medication to be taken", + "title": "Where task occurs", "type": "string" }, "note": { - "description": "[Text representation of Annotation] Extra information about the prescription that could not be conveyed by the other attributes.", + "description": "[Text representation of Annotation] Free-text information captured about the task as it progresses.", "element_property": true, "items": { "type": "string" }, - "title": "Information about the prescription", + "title": "Comments made about the task", "type": "array" }, - "performer": { - "backref": "performer_medication_request", - "description": "[Text representation of Reference] The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.", + "output_valueReference": { + "backref": "task_output", + "description": "[Text representation of Reference] [Plucked from Task.output] The value of the Output parameter as a basic type.", + "element_property": true, + "one_of_many": "value", + "one_of_many_required": true, + "title": "Result of output", + "type": "string" + }, + "owner": { + "backref": "owner_task", + "description": "[Text representation of Reference] Party responsible for managing task execution.", "element_property": true, "enum_reference_types": [ "Practitioner", "PractitionerRole", "Organization", - "Patient", - "DeviceDefinition", - "RelatedPerson", "CareTeam", - "HealthcareService" + "Patient", + "RelatedPerson" ], - "items": { - "type": "string" - }, - "title": "Intended performer of administration", - "type": "array" - }, - "performerType": { - "binding_description": "Identifies the type of individual that is desired to administer the medication.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "binding_version": null, - "description": "text representation. Indicates the type of performer of the administration of the medication.", - "element_property": true, - "term": { - "description": "Identifies the type of individual that is desired to administer the medication.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "term_url": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role" - } - }, - "title": "Desired kind of performer of the medication administration", + "title": "Responsible individual", "type": "string" }, - "performerType_coding": { - "binding_description": "Identifies the type of individual that is desired to administer the medication.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "binding_version": null, - "description": "[system#code representation.] Indicates the type of performer of the administration of the medication.", + "partOf": { + "backref": "partOf_task", + "description": "[Text representation of Reference] Task that this particular task is part of.", "element_property": true, - "term": { - "description": "Identifies the type of individual that is desired to administer the medication.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "term_url": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role" - } + "enum_reference_types": [ + "Task" + ], + "items": { + "type": "string" }, - "title": "Desired kind of performer of the medication administration", - "type": "string" + "title": "Composite task", + "type": "array" }, - "performerType_text": { - "binding_description": "Identifies the type of individual that is desired to administer the medication.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "binding_version": null, - "description": "[system#code representation.] Indicates the type of performer of the administration of the medication.", + "performer": { + "description": "[Text representation of TaskPerformer] The entity who performed the requested task.", "element_property": true, - "term": { - "description": "Identifies the type of individual that is desired to administer the medication.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", - "term_url": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role" - } + "items": { + "type": "string" }, - "title": "Desired kind of performer of the medication administration", - "type": "string" - }, - "priorPrescription": { - "backref": "priorPrescription_medication_request", - "description": "[Text representation of Reference] Reference to an order/prescription that is being replaced by this MedicationRequest", - "element_property": true, - "enum_reference_types": [ - "MedicationRequest" - ], - "title": "Reference to an order/prescription that is being replaced by this MedicationRequest", - "type": "string" + "title": "Who or what performed the task", + "type": "array" }, "priority": { - "binding_description": "Identifies the level of importance to be assigned to actioning the request.", + "binding_description": "The priority of a task (may affect service level applied to the task).", "binding_strength": "required", "binding_uri": "http://hl7.org/fhir/ValueSet/request-priority", "binding_version": "5.0.0", - "description": "Indicates how quickly the Medication Request should be addressed with respect to other requests.", + "description": "Indicates how quickly the Task should be addressed with respect to other requests.", "element_property": true, "enum_values": [ "routine", @@ -6709,265 +5887,285 @@ "type": "string" }, "reason": { - "backref": "reason_medication_request", - "binding_description": "A coded concept indicating why the medication was ordered.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", - "binding_version": null, - "description": "text representation. The reason or the indication for ordering or not ordering the medication.", + "backref": "reason_task", + "description": "text representation. A description, code, or reference indicating why this task needs to be performed.", "element_property": true, - "enum_reference_types": [ - "Condition", - "Observation" - ], "items": { "type": "string" }, - "term": { - "description": "A coded concept indicating why the medication was ordered.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" - } - }, - "title": "Reason or indication for ordering or not ordering the medication", + "title": "Why task is needed", "type": "array" }, "reason_coding": { - "backref": "reason_medication_request", - "binding_description": "A coded concept indicating why the medication was ordered.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", - "binding_version": null, - "description": "[system#code representation.] The reason or the indication for ordering or not ordering the medication.", + "backref": "reason_task", + "description": "[system#code representation.] A description, code, or reference indicating why this task needs to be performed.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Why task is needed", + "type": "array" + }, + "reason_text": { + "backref": "reason_task", + "description": "[system#code representation.] A description, code, or reference indicating why this task needs to be performed.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Why task is needed", + "type": "array" + }, + "relevantHistory": { + "backref": "relevantHistory_task", + "description": "[Text representation of Reference] Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.", "element_property": true, "enum_reference_types": [ - "Condition", - "Observation" + "Provenance" ], "items": { "type": "string" }, - "term": { - "description": "A coded concept indicating why the medication was ordered.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" - } - }, - "title": "Reason or indication for ordering or not ordering the medication", + "title": "Key events in history of the Task", "type": "array" }, - "reason_text": { - "backref": "reason_medication_request", - "binding_description": "A coded concept indicating why the medication was ordered.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "requestedPerformer": { + "backref": "requestedPerformer_task", + "binding_description": "The type(s) of task performers allowed.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", "binding_version": null, - "description": "[system#code representation.] The reason or the indication for ordering or not ordering the medication.", + "description": "text representation. The kind of participant or specific participant that should perform the task.", "element_property": true, "enum_reference_types": [ - "Condition", - "Observation" + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam", + "HealthcareService", + "Patient", + "Device", + "RelatedPerson" ], "items": { "type": "string" }, "term": { - "description": "A coded concept indicating why the medication was ordered.", + "description": "The type(s) of task performers allowed.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_id": "http://hl7.org/fhir/ValueSet/performer-role", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/condition-code", - "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/performer-role", + "term_url": "http://hl7.org/fhir/ValueSet/performer-role" } }, - "title": "Reason or indication for ordering or not ordering the medication", + "title": "Who should perform Task", "type": "array" }, - "recorder": { - "backref": "recorder_medication_request", - "description": "[Text representation of Reference] The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.", - "element_property": true, - "enum_reference_types": [ - "Practitioner", - "PractitionerRole" + "requestedPerformer_coding": { + "backref": "requestedPerformer_task", + "binding_description": "The type(s) of task performers allowed.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", + "binding_version": null, + "description": "[system#code representation.] The kind of participant or specific participant that should perform the task.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam", + "HealthcareService", + "Patient", + "Device", + "RelatedPerson" ], - "title": "Person who entered the request", - "type": "string" + "items": { + "type": "string" + }, + "term": { + "description": "The type(s) of task performers allowed.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/performer-role", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/performer-role", + "term_url": "http://hl7.org/fhir/ValueSet/performer-role" + } + }, + "title": "Who should perform Task", + "type": "array" }, - "renderedDosageInstruction": { - "description": "The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", + "requestedPerformer_text": { + "backref": "requestedPerformer_task", + "binding_description": "The type(s) of task performers allowed.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/performer-role", + "binding_version": null, + "description": "[system#code representation.] The kind of participant or specific participant that should perform the task.", "element_property": true, - "pattern": "\\s*(\\S|\\s)*", - "title": "Full representation of the dosage instructions", - "type": "string" + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam", + "HealthcareService", + "Patient", + "Device", + "RelatedPerson" + ], + "items": { + "type": "string" + }, + "term": { + "description": "The type(s) of task performers allowed.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/performer-role", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/performer-role", + "term_url": "http://hl7.org/fhir/ValueSet/performer-role" + } + }, + "title": "Who should perform Task", + "type": "array" }, - "reported": { - "description": "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.", + "requestedPeriod": { + "description": "[Text representation of Period] Indicates the start and/or end of the period of time when completion of the task is desired to take place.", "element_property": true, - "title": "Reported rather than primary record", - "type": "boolean" + "title": "When the task should be performed", + "type": "string" }, "requester": { - "backref": "requester_medication_request", - "description": "[Text representation of Reference] The individual, organization, or device that initiated the request and has responsibility for its activation.", + "backref": "requester_task", + "description": "[Text representation of Reference] The creator of the task.", "element_property": true, "enum_reference_types": [ - "Practitioner", - "PractitionerRole", + "Device", "Organization", "Patient", - "RelatedPerson", - "Device" + "Practitioner", + "PractitionerRole", + "RelatedPerson" ], - "title": "Who/What requested the Request", + "title": "Who is asking for task to be done", "type": "string" }, "resourceType": { - "const": "MedicationRequest", + "const": "Task", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, + "restriction": { + "description": "[Text representation of TaskRestriction] If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.", + "element_property": true, + "title": "Constraints on fulfillment tasks", + "type": "string" + }, + "specimen": { + "backref": "task", + "description": "[Text representation of Reference] The specimen input to this task. Used to generate link.", + "enum_reference_types": [ + "Specimen" + ], + "title": "The specimen input to this task.", + "type": "string" + }, "status": { - "binding_description": "A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.", + "binding_description": "The current status of the task.", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-status", "binding_version": "5.0.0", - "description": "A code specifying the current state of the order. Generally, this will be active or completed state.", + "description": "The current status of the task.", "element_property": true, "element_required": true, "enum_values": [ - "active", - "on-hold", - "ended", - "stopped", - "completed", - "cancelled", - "entered-in-error", "draft", - "unknown" + "requested", + "received", + "accepted", + "+" ], "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown", - "type": "string" - }, - "statusChanged": { - "description": "The date (and perhaps time) when the status was changed.", - "element_property": true, - "format": "date-time", - "title": "When the status was changed", + "title": "draft | requested | received | accepted | +", "type": "string" }, "statusReason": { - "binding_description": "Identifies the reasons for a given status.", + "backref": "task", + "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", "binding_version": null, - "description": "text representation. Captures the reason for the current state of the MedicationRequest.", + "description": "text representation. An explanation as to why this task is held, failed, was refused, etc.", "element_property": true, "term": { - "description": "Identifies the reasons for a given status.", + "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "cde_id": "http://hl7.org/fhir/ValueSet/task-status-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" + "term": "http://hl7.org/fhir/ValueSet/task-status-reason", + "term_url": "http://hl7.org/fhir/ValueSet/task-status-reason" } }, "title": "Reason for current status", "type": "string" }, "statusReason_coding": { - "binding_description": "Identifies the reasons for a given status.", + "backref": "task", + "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", "binding_version": null, - "description": "[system#code representation.] Captures the reason for the current state of the MedicationRequest.", + "description": "[system#code representation.] An explanation as to why this task is held, failed, was refused, etc.", "element_property": true, "term": { - "description": "Identifies the reasons for a given status.", + "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "cde_id": "http://hl7.org/fhir/ValueSet/task-status-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" + "term": "http://hl7.org/fhir/ValueSet/task-status-reason", + "term_url": "http://hl7.org/fhir/ValueSet/task-status-reason" } }, "title": "Reason for current status", "type": "string" }, "statusReason_text": { - "binding_description": "Identifies the reasons for a given status.", + "backref": "task", + "binding_description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "binding_uri": "http://hl7.org/fhir/ValueSet/task-status-reason", "binding_version": null, - "description": "[system#code representation.] Captures the reason for the current state of the MedicationRequest.", + "description": "[system#code representation.] An explanation as to why this task is held, failed, was refused, etc.", "element_property": true, "term": { - "description": "Identifies the reasons for a given status.", + "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "cde_id": "http://hl7.org/fhir/ValueSet/task-status-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", - "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" + "term": "http://hl7.org/fhir/ValueSet/task-status-reason", + "term_url": "http://hl7.org/fhir/ValueSet/task-status-reason" } }, "title": "Reason for current status", "type": "string" - }, - "subject": { - "backref": "subject_medication_request", - "description": "[Text representation of Reference] The individual or group for whom the medication has been requested.", - "element_property": true, - "enum_reference_types": [ - "Patient", - "Group" - ], - "title": "Individual or group for whom the medication has been requested", - "type": "string" - }, - "substitution": { - "description": "[Text representation of MedicationRequestSubstitution] Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.", - "element_property": true, - "title": "Any restrictions on medication substitution", - "type": "string" - }, - "supportingInformation": { - "backref": "supportingInformation_medication_request", - "description": "[Text representation of Reference] Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient).", - "element_property": true, - "enum_reference_types": [ - "Resource" - ], - "items": { - "type": "string" - }, - "title": "Information to support fulfilling of the medication", - "type": "array" } }, "systemProperties": [ "id" ], - "title": "MedicationRequest", + "title": "Task", "type": "object", "uniqueKeys": [ [ @@ -6975,463 +6173,3909 @@ ] ] }, - "research_subject.yaml": { + "condition.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, - "category": "Administrative", - "description": "Participant or object which is the recipient of investigative activities in a study. A ResearchSubject is a participant or object which is the recipient of investigative activities in a research study. [See https://hl7.org/fhir/R5/ResearchSubject.html]", - "id": "research_subject", + "category": "Clinical", + "description": "Detailed information about conditions, problems or diagnoses. A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. [See https://hl7.org/fhir/R5/Condition.html]", + "id": "condition", "links": [ { - "backref": "research_subject", - "label": "ResearchSubject_subject_Patient_research_subject", + "backref": "condition", + "label": "Condition_subject_Patient_condition", "multiplicity": "many_to_many", "name": "subject_Patient", "required": false, "target_type": "patient" + } + ], + "program": "*", + "project": "*", + "properties": { + "abatementAge": { + "description": "[Text representation of Age] The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", + "element_property": true, + "one_of_many": "abatement", + "one_of_many_required": false, + "title": "When in resolution/remission", + "type": "string" }, - { - "backref": "research_subject", - "label": "ResearchSubject_subject_Specimen_research_subject", - "multiplicity": "many_to_many", - "name": "subject_Specimen", - "required": false, - "target_type": "specimen" + "abatementDateTime": { + "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", + "element_property": true, + "format": "date-time", + "one_of_many": "abatement", + "one_of_many_required": false, + "title": "When in resolution/remission", + "type": "string" }, - { - "backref": "research_subject", - "label": "ResearchSubject_subject_Medication_research_subject", - "multiplicity": "many_to_many", - "name": "subject_Medication", - "required": false, - "target_type": "medication" - }, - { - "backref": "research_subject", - "label": "ResearchSubject_subject_Substance_research_subject", - "multiplicity": "many_to_many", - "name": "subject_Substance", - "required": false, - "target_type": "substance" + "abatementPeriod": { + "description": "[Text representation of Period] The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", + "element_property": true, + "one_of_many": "abatement", + "one_of_many_required": false, + "title": "When in resolution/remission", + "type": "string" }, - { - "backref": "research_subject", - "label": "ResearchSubject_study_ResearchStudy_research_subject", - "multiplicity": "many_to_many", - "name": "study", - "required": false, - "target_type": "research_study" - } - ], - "program": "*", - "project": "*", - "properties": { - "actualComparisonGroup": { - "description": "The name of the arm in the study the subject actually followed as part of this study.", + "abatementRange": { + "description": "[Text representation of Range] The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "What path was followed", + "one_of_many": "abatement", + "one_of_many_required": false, + "title": "When in resolution/remission", "type": "string" }, - "assignedComparisonGroup": { - "description": "The name of the arm in the study the subject is expected to follow as part of this study.", + "abatementString": { + "description": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Some conditions, such as chronic conditions, are never really resolved, but they can abate.", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "What path should be followed", + "one_of_many": "abatement", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "When in resolution/remission", "type": "string" }, - "consent": { - "backref": "consent_research_subject", - "description": "[Text representation of Reference] A record of the patient's informed agreement to participate in the study.", + "bodySite": { + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "text representation. The anatomical location where this condition manifests itself.", "element_property": true, - "enum_reference_types": [ - "Consent" - ], "items": { "type": "string" }, - "title": "Agreement to participate in study", + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Anatomical location, if relevant", "type": "array" }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "bodySite_coding": { + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] The anatomical location where this condition manifests itself.", "element_property": true, "items": { "type": "string" }, - "title": "Additional content defined by implementations", + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Anatomical location, if relevant", "type": "array" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", - "type": "string" - }, - "identifier": { - "description": "Identifiers assigned to this research subject for a study.", + "bodySite_text": { + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] The anatomical location where this condition manifests itself.", "element_property": true, "items": { "type": "string" }, - "title": "Business Identifier for research subject in a study", + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Anatomical location, if relevant", "type": "array" }, - "identifier_coding": { - "description": "[system#code representation of identifier] Identifiers assigned to this research subject for a study.", + "category": { + "binding_description": "A category assigned to the condition.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-category", + "binding_version": null, + "description": "text representation. A category assigned to the condition.", "element_property": true, "items": { "type": "string" }, - "title": "Business Identifier for research subject in a study", + "term": { + "description": "A category assigned to the condition.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-category", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/condition-category", + "term_url": "http://hl7.org/fhir/ValueSet/condition-category" + } + }, + "title": "problem-list-item | encounter-diagnosis", "type": "array" }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Identifiers assigned to this research subject for a study.", + "category_coding": { + "binding_description": "A category assigned to the condition.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-category", + "binding_version": null, + "description": "[system#code representation.] A category assigned to the condition.", "element_property": true, "items": { "type": "string" }, - "title": "Business Identifier for research subject in a study", + "term": { + "description": "A category assigned to the condition.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-category", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/condition-category", + "term_url": "http://hl7.org/fhir/ValueSet/condition-category" + } + }, + "title": "problem-list-item | encounter-diagnosis", "type": "array" }, - "period": { - "description": "[Text representation of Period] The dates the subject began and ended their participation in the study.", - "element_property": true, - "title": "Start and end of participation", - "type": "string" - }, - "progress": { - "description": "[Text representation of ResearchSubjectProgress] The current state (status) of the subject and resons for status change where appropriate.", + "category_text": { + "binding_description": "A category assigned to the condition.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-category", + "binding_version": null, + "description": "[system#code representation.] A category assigned to the condition.", "element_property": true, "items": { "type": "string" }, - "title": "Subject status", + "term": { + "description": "A category assigned to the condition.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-category", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/condition-category", + "term_url": "http://hl7.org/fhir/ValueSet/condition-category" + } + }, + "title": "problem-list-item | encounter-diagnosis", "type": "array" }, - "project_id": { + "clinicalStatus": { + "binding_description": "The clinical status of the condition or diagnosis.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-clinical", + "binding_version": "5.0.0", + "description": "text representation. The clinical status of the condition.", + "element_property": true, "term": { - "$ref": "_terms.yaml#/project_id" + "description": "The clinical status of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-clinical", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/condition-clinical", + "term_url": "http://hl7.org/fhir/ValueSet/condition-clinical" + } }, + "title": "active | recurrence | relapse | inactive | remission | resolved | unknown", "type": "string" }, - "resourceType": { - "const": "ResearchSubject", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" - }, - "status": { - "binding_description": "Codes that convey the current publication status of the research study resource.", + "clinicalStatus_coding": { + "binding_description": "The clinical status of the condition or diagnosis.", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/publication-status", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-clinical", "binding_version": "5.0.0", - "description": "The publication state of the resource (not of the subject).", + "description": "[system#code representation.] The clinical status of the condition.", "element_property": true, - "element_required": true, - "enum_values": [ - "draft", - "active", - "retired", - "unknown" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "draft | active | retired | unknown", + "term": { + "description": "The clinical status of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-clinical", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/condition-clinical", + "term_url": "http://hl7.org/fhir/ValueSet/condition-clinical" + } + }, + "title": "active | recurrence | relapse | inactive | remission | resolved | unknown", "type": "string" }, - "study": { - "backref": "research_subject", - "description": "[Text representation of Reference] Reference to the study the subject is participating in.", + "clinicalStatus_text": { + "binding_description": "The clinical status of the condition or diagnosis.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-clinical", + "binding_version": "5.0.0", + "description": "[system#code representation.] The clinical status of the condition.", + "element_property": true, + "term": { + "description": "The clinical status of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-clinical", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/condition-clinical", + "term_url": "http://hl7.org/fhir/ValueSet/condition-clinical" + } + }, + "title": "active | recurrence | relapse | inactive | remission | resolved | unknown", + "type": "string" + }, + "code": { + "binding_description": "Identification of the condition or diagnosis.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "text representation. Identification of the condition, problem or diagnosis", + "element_property": true, + "term": { + "description": "Identification of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Identification of the condition, problem or diagnosis", + "type": "string" + }, + "code_coding": { + "binding_description": "Identification of the condition or diagnosis.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "[system#code representation.] Identification of the condition, problem or diagnosis", + "element_property": true, + "term": { + "description": "Identification of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Identification of the condition, problem or diagnosis", + "type": "string" + }, + "code_text": { + "binding_description": "Identification of the condition or diagnosis.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "[system#code representation.] Identification of the condition, problem or diagnosis", + "element_property": true, + "term": { + "description": "Identification of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Identification of the condition, problem or diagnosis", + "type": "string" + }, + "encounter": { + "backref": "condition", + "description": "[Text representation of Reference] The Encounter during which this Condition was created or to which the creation of this record is tightly associated.", "element_property": true, "enum_reference_types": [ - "ResearchStudy" + "Encounter" ], - "title": "Study subject is part of", + "title": "The Encounter during which this Condition was created", "type": "string" }, - "subject": { - "backref": "research_subject", - "description": "[Text representation of Reference] The record of the person, animal or other entity involved in the study.", + "evidence": { + "backref": "evidence_condition", + "binding_description": null, + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "text representation. Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", "element_property": true, "enum_reference_types": [ - "Patient", - "Group", - "Specimen", - "Device", - "Medication", - "Substance", - "BiologicallyDerivedProduct" + "Resource" ], - "title": "Who or what is part of study", + "items": { + "type": "string" + }, + "term": { + "description": null, + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Supporting evidence for the verification status", + "type": "array" + }, + "evidence_coding": { + "backref": "evidence_condition", + "binding_description": null, + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "[system#code representation.] Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "items": { + "type": "string" + }, + "term": { + "description": null, + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Supporting evidence for the verification status", + "type": "array" + }, + "evidence_text": { + "backref": "evidence_condition", + "binding_description": null, + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "[system#code representation.] Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "items": { + "type": "string" + }, + "term": { + "description": null, + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Supporting evidence for the verification status", + "type": "array" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Ids for this condition", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Ids for this condition", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Ids for this condition", + "type": "array" + }, + "note": { + "description": "[Text representation of Annotation] Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional information about the Condition", + "type": "array" + }, + "onsetAge": { + "description": "[Text representation of Age] Estimated or actual date or date-time the condition began, in the opinion of the clinician.", + "element_property": true, + "one_of_many": "onset", + "one_of_many_required": false, + "title": "Estimated or actual date, date-time, or age", + "type": "string" + }, + "onsetDateTime": { + "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", + "element_property": true, + "format": "date-time", + "one_of_many": "onset", + "one_of_many_required": false, + "title": "Estimated or actual date, date-time, or age", + "type": "string" + }, + "onsetPeriod": { + "description": "[Text representation of Period] Estimated or actual date or date-time the condition began, in the opinion of the clinician.", + "element_property": true, + "one_of_many": "onset", + "one_of_many_required": false, + "title": "Estimated or actual date, date-time, or age", + "type": "string" + }, + "onsetRange": { + "description": "[Text representation of Range] Estimated or actual date or date-time the condition began, in the opinion of the clinician.", + "element_property": true, + "one_of_many": "onset", + "one_of_many_required": false, + "title": "Estimated or actual date, date-time, or age", + "type": "string" + }, + "onsetString": { + "description": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.", + "element_property": true, + "one_of_many": "onset", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Estimated or actual date, date-time, or age", + "type": "string" + }, + "participant": { + "description": "[Text representation of ConditionParticipant] Indicates who or what participated in the activities related to the condition and how they were involved.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Who or what participated in the activities related to the condition and how they were involved", + "type": "array" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "recordedDate": { + "description": "The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.", + "element_property": true, + "format": "date-time", + "title": "Date condition was first recorded", + "type": "string" + }, + "resourceType": { + "const": "Condition", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "severity": { + "binding_description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-severity", + "binding_version": null, + "description": "text representation. A subjective assessment of the severity of the condition as evaluated by the clinician.", + "element_property": true, + "term": { + "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-severity", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/condition-severity", + "term_url": "http://hl7.org/fhir/ValueSet/condition-severity" + } + }, + "title": "Subjective severity of condition", + "type": "string" + }, + "severity_coding": { + "binding_description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-severity", + "binding_version": null, + "description": "[system#code representation.] A subjective assessment of the severity of the condition as evaluated by the clinician.", + "element_property": true, + "term": { + "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-severity", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/condition-severity", + "term_url": "http://hl7.org/fhir/ValueSet/condition-severity" + } + }, + "title": "Subjective severity of condition", + "type": "string" + }, + "severity_text": { + "binding_description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-severity", + "binding_version": null, + "description": "[system#code representation.] A subjective assessment of the severity of the condition as evaluated by the clinician.", + "element_property": true, + "term": { + "description": "A subjective assessment of the severity of the condition as evaluated by the clinician.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-severity", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/condition-severity", + "term_url": "http://hl7.org/fhir/ValueSet/condition-severity" + } + }, + "title": "Subjective severity of condition", + "type": "string" + }, + "stage": { + "description": "[Text representation of ConditionStage] A simple summary of the stage such as \"Stage 3\" or \"Early Onset\". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Stage/grade, usually assessed formally", + "type": "array" + }, + "subject": { + "backref": "condition", + "description": "[Text representation of Reference] Indicates the patient or group who the condition record is associated with.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group" + ], + "title": "Who has the condition?", + "type": "string" + }, + "verificationStatus": { + "binding_description": "The verification status to support or decline the clinical status of the condition or diagnosis.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "binding_version": "5.0.0", + "description": "text representation. The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.", + "element_property": true, + "term": { + "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "term_url": "http://hl7.org/fhir/ValueSet/condition-ver-status" + } + }, + "title": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", + "type": "string" + }, + "verificationStatus_coding": { + "binding_description": "The verification status to support or decline the clinical status of the condition or diagnosis.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "binding_version": "5.0.0", + "description": "[system#code representation.] The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.", + "element_property": true, + "term": { + "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "term_url": "http://hl7.org/fhir/ValueSet/condition-ver-status" + } + }, + "title": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", + "type": "string" + }, + "verificationStatus_text": { + "binding_description": "The verification status to support or decline the clinical status of the condition or diagnosis.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "binding_version": "5.0.0", + "description": "[system#code representation.] The verification status to support the clinical status of the condition. The verification status pertains to the condition, itself, not to any specific condition attribute.", + "element_property": true, + "term": { + "description": "The verification status to support or decline the clinical status of the condition or diagnosis.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "cde_version": null, + "source": "fhir", + "strength": "required", + "term": "http://hl7.org/fhir/ValueSet/condition-ver-status", + "term_url": "http://hl7.org/fhir/ValueSet/condition-ver-status" + } + }, + "title": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error", "type": "string" } }, - "systemProperties": [ - "id" - ], - "title": "ResearchSubject", - "type": "object", - "uniqueKeys": [ - [ - "id" - ] - ] - }, - "_terms.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "RIN": { - "description": "A numerical assessment of the integrity of RNA based on the entire electrophoretic trace of the RNA sample including the presence or absence of degradation products.\n", - "termDef": { - "cde_id": 5278775, - "cde_version": 1.0, - "source": "caDSR", - "term": "Biospecimen RNA Integrity Number Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5278775&version=1.0" - } - }, - "UUID": { - "description": "A 128-bit identifier. Depending on the mechanism used to generate it, it is either guaranteed to be different from all other UUIDs/GUIDs generated until 3400 AD or extremely likely to be different. Its relatively small size lends itself well to sorting, ordering, and hashing of all sorts, storing in databases, simple allocation, and ease of programming in general.\n", - "termDef": { - "cde_id": "C54100", - "cde_version": null, - "source": "NCIt", - "term": "Universally Unique Identifier", - "term_url": "https://ncit.nci.nih.gov/ncitbrowser/ConceptReport.jsp?dictionary=NCI_Thesaurus&version=16.02d&ns=NCI_Thesaurus&code=C54100" - } - }, - "data_category": { - "description": "Broad categorization of the contents of the data file.\n" - }, - "data_file_error_type": { - "description": "Type of error for the data file object.\n" - }, - "data_format": { - "description": "Format of the data files.\n" - }, - "data_type": { - "description": "Specific content type of the data file. (CMG)\n" - }, - "datetime": { - "description": "A combination of date and time of day in the form [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]\n" - }, - "encoding": { - "description": "Version of ASCII encoding of quality values found in the file.\n", - "termDef": { - "cde_id": null, - "cde_version": null, - "source": "FastQC", - "term": "Encoding", - "term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/1%20Basic%20Statistics.html" - } - }, - "file_format": { - "description": "The format of the data file object.\n" - }, - "file_name": { - "description": "The name (or part of a name) of a file (of any type).\n" - }, - "file_size": { - "description": "The size of the data file (object) in bytes.\n" - }, - "file_state": { - "description": "The current state of the data file object.\n" - }, - "ga4gh_drs_uri": { - "description": "DRS URI as defined by GA4GH DRS spec for pointers to file objects.\n" - }, - "id": "_terms", - "md5sum": { - "description": "The 128-bit hash value expressed as a 32 digit hexadecimal number used as a file's digital fingerprint.\n" - }, - "microsatellite_instability_abnormal": { - "description": "The yes/no indicator to signify the status of a tumor for microsatellite instability.\n", - "termDef": { - "cde_id": 3123142, - "cde_version": 1.0, - "source": "caDSR", - "term": "Microsatellite Instability Occurrence Indicator", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3123142&version=1.0" - } - }, - "morphology": { - "description": "The third edition of the International Classification of Diseases for Oncology, published in 2000 used principally in tumor and cancer registries for coding the site (topography) and the histology (morphology) of neoplasms. The study of the structure of the cells and their arrangement to constitute tissues and, finally, the association among these to form organs. In pathology, the microscopic process of identifying normal and abnormal morphologic characteristics in tissues, by employing various cytochemical and immunocytochemical stains. A system of numbered categories for representation of data.\n", - "termDef": { - "cde_id": 3226275, - "cde_version": 1.0, - "source": "caDSR", - "term": "International Classification of Diseases for Oncology, Third Edition ICD-O-3 Histology Code", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3226275&version=1.0" - } - }, - "new_event_anatomic_site": { - "description": "Text term to specify the anatomic location of the return of tumor after treatment.\n", - "termDef": { - "cde_id": 3108271, - "cde_version": 2.0, - "source": "caDSR", - "term": "New Neoplasm Event Occurrence Anatomic Site", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3108271&version=2.0" - } - }, - "new_event_type": { - "description": "Text term to identify a new tumor event.\n", - "termDef": { - "cde_id": 3119721, - "cde_version": 1.0, - "source": "caDSR", - "term": "New Neoplasm Event Type", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3119721&version=1.0" - } - }, - "normal_tumor_genotype_snp_match": { - "description": "Text term that represents whether or not the genotype of the normal tumor matches or if the data is not available.\n", - "termDef": { - "cde_id": 4588156, - "cde_version": 1.0, - "source": "caDSR", - "term": "Normal Tumor Genotype Match Indicator", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=4588156&version=1.0" - } - }, - "number_proliferating_cells": { - "description": "Numeric value that represents the count of proliferating cells determined during pathologic review of the sample slide(s).\n", - "termDef": { - "cde_id": 5432636, - "cde_version": 1.0, - "source": "caDSR", - "term": "Pathology Review Slide Proliferating Cell Count", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432636&version=1.0" - } - }, - "oct_embedded": { - "description": "Indicator of whether or not the sample was embedded in Optimal Cutting Temperature (OCT) compound.\n", - "termDef": { - "cde_id": 5432538, - "cde_version": 1.0, - "source": "caDSR", - "term": "Tissue Sample Optimal Cutting Temperature Compound Embedding Indicator", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432538&version=1.0" - } - }, - "percent_eosinophil_infiltration": { - "description": "Numeric value to represent the percentage of infiltration by eosinophils in a tumor sample or specimen.\n", - "termDef": { - "cde_id": 2897700, - "cde_version": 2.0, - "source": "caDSR", - "term": "Specimen Eosinophilia Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897700&version=2.0" - } - }, - "percent_gc_content": { - "description": "The overall %GC of all bases in all sequences.\n", - "termDef": { - "cde_id": null, - "cde_version": null, - "source": "FastQC", - "term": "%GC", - "term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/1%20Basic%20Statistics.html" - } - }, - "percent_granulocyte_infiltration": { - "description": "Numeric value to represent the percentage of infiltration by granulocytes in a tumor sample or specimen.\n", - "termDef": { - "cde_id": 2897705, - "cde_version": 2.0, - "source": "caDSR", - "term": "Specimen Granulocyte Infiltration Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897705&version=2.0" - } - }, - "percent_inflam_infiltration": { - "description": "Numeric value to represent local response to cellular injury, marked by capillary dilatation, edema and leukocyte infiltration; clinically, inflammation is manifest by reddness, heat, pain, swelling and loss of function, with the need to heal damaged tissue.\n", - "termDef": { - "cde_id": 2897695, - "cde_version": 1.0, - "source": "caDSR", - "term": "Specimen Inflammation Change Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897695&version=1.0" - } - }, - "percent_lymphocyte_infiltration": { - "description": "Numeric value to represent the percentage of infiltration by lymphocytes in a solid tissue normal sample or specimen.\n", - "termDef": { - "cde_id": 2897710, - "cde_version": 2.0, - "source": "caDSR", - "term": "Specimen Lymphocyte Infiltration Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897710&version=2.0" - } - }, - "percent_monocyte_infiltration": { - "description": "Numeric value to represent the percentage of monocyte infiltration in a sample or specimen.\n", - "termDef": { - "cde_id": 5455535, - "cde_version": 1.0, - "source": "caDSR", - "term": "Specimen Monocyte Infiltration Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5455535&version=1.0" - } - }, - "percent_necrosis": { - "description": "Numeric value to represent the percentage of cell death in a malignant tumor sample or specimen.\n", - "termDef": { - "cde_id": 2841237, - "cde_version": 1.0, - "source": "caDSR", - "term": "Malignant Neoplasm Necrosis Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841237&version=1.0" - } - }, - "percent_neutrophil_infiltration": { - "description": "Numeric value to represent the percentage of infiltration by neutrophils in a tumor sample or specimen.\n", - "termDef": { - "cde_id": 2841267, - "cde_version": 1.0, - "source": "caDSR", - "term": "Malignant Neoplasm Neutrophil Infiltration Percentage Cell Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841267&version=1.0" - } - }, - "percent_normal_cells": { - "description": "Numeric value to represent the percentage of normal cell content in a malignant tumor sample or specimen.\n", - "termDef": { - "cde_id": 2841233, - "cde_version": 1.0, - "source": "caDSR", - "term": "Malignant Neoplasm Normal Cell Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841233&version=1.0" - } - }, - "percent_stromal_cells": { - "description": "Numeric value to represent the percentage of reactive cells that are present in a malignant tumor sample or specimen but are not malignant such as fibroblasts, vascular structures, etc.\n", - "termDef": { - "cde_id": 2841241, - "cde_version": 1.0, - "source": "caDSR", - "term": "Malignant Neoplasm Stromal Cell Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841241&version=1.0" - } - }, - "percent_tumor_cells": { - "description": "Numeric value that represents the percentage of infiltration by granulocytes in a sample.\n", - "termDef": { - "cde_id": 5432686, - "cde_version": 1.0, - "source": "caDSR", - "term": "Specimen Tumor Cell Percentage Value", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432686&version=1.0" + "systemProperties": [ + "id" + ], + "title": "Condition", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "medication_request.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Clinical", + "description": "Ordering of medication for patient or group. 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. [See https://hl7.org/fhir/R5/MedicationRequest.html]", + "id": "medication_request", + "links": [ + { + "backref": "subject_medication_request", + "label": "MedicationRequest_subject_Patient_subject_medication_request", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" + }, + { + "backref": "basedOn_medication_request", + "label": "MedicationRequest_basedOn_MedicationRequest_basedOn_medication_request", + "multiplicity": "many_to_many", + "name": "basedOn_MedicationRequest", + "required": false, + "target_type": "medication_request" + }, + { + "backref": "medication_request", + "label": "MedicationRequest_medication_Medication_medication_request", + "multiplicity": "many_to_many", + "name": "medication", + "required": false, + "target_type": "medication" + }, + { + "backref": "reason_medication_request", + "label": "MedicationRequest_reason_Condition_reason_medication_request", + "multiplicity": "many_to_many", + "name": "reason_Condition", + "required": false, + "target_type": "condition" + }, + { + "backref": "reason_medication_request", + "label": "MedicationRequest_reason_Observation_reason_medication_request", + "multiplicity": "many_to_many", + "name": "reason_Observation", + "required": false, + "target_type": "observation" } - }, - "percent_tumor_nuclei": { + ], + "program": "*", + "project": "*", + "properties": { + "authoredOn": { + "description": "The date (and perhaps time) when the prescription was initially written or authored on.", + "element_property": true, + "format": "date-time", + "title": "When request was initially authored", + "type": "string" + }, + "basedOn": { + "backref": "basedOn_medication_request", + "description": "[Text representation of Reference] A plan or request that is fulfilled in whole or in part by this medication request", + "element_property": true, + "enum_reference_types": [ + "CarePlan", + "MedicationRequest", + "ServiceRequest", + "ImmunizationRecommendation" + ], + "items": { + "type": "string" + }, + "title": "A plan or request that is fulfilled in whole or in part by this medication request", + "type": "array" + }, + "category": { + "binding_description": "A coded concept identifying where the medication is to be consumed or administered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "binding_version": null, + "description": "text representation. An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "A coded concept identifying where the medication is to be consumed or administered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" + } + }, + "title": "Grouping or category of medication request", + "type": "array" + }, + "category_coding": { + "binding_description": "A coded concept identifying where the medication is to be consumed or administered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "binding_version": null, + "description": "[system#code representation.] An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "A coded concept identifying where the medication is to be consumed or administered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" + } + }, + "title": "Grouping or category of medication request", + "type": "array" + }, + "category_text": { + "binding_description": "A coded concept identifying where the medication is to be consumed or administered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "binding_version": null, + "description": "[system#code representation.] An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "A coded concept identifying where the medication is to be consumed or administered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-admin-location" + } + }, + "title": "Grouping or category of medication request", + "type": "array" + }, + "courseOfTherapyType": { + "binding_description": "Identifies the overall pattern of medication administratio.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "binding_version": null, + "description": "text representation. The description of the overall pattern of the administration of the medication to the patient.", + "element_property": true, + "term": { + "description": "Identifies the overall pattern of medication administratio.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" + } + }, + "title": "Overall pattern of medication administration", + "type": "string" + }, + "courseOfTherapyType_coding": { + "binding_description": "Identifies the overall pattern of medication administratio.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "binding_version": null, + "description": "[system#code representation.] The description of the overall pattern of the administration of the medication to the patient.", + "element_property": true, + "term": { + "description": "Identifies the overall pattern of medication administratio.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" + } + }, + "title": "Overall pattern of medication administration", + "type": "string" + }, + "courseOfTherapyType_text": { + "binding_description": "Identifies the overall pattern of medication administratio.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "binding_version": null, + "description": "[system#code representation.] The description of the overall pattern of the administration of the medication to the patient.", + "element_property": true, + "term": { + "description": "Identifies the overall pattern of medication administratio.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy" + } + }, + "title": "Overall pattern of medication administration", + "type": "string" + }, + "device": { + "backref": "device_medication_request", + "description": "text representation. The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).", + "element_property": true, + "enum_reference_types": [ + "DeviceDefinition" + ], + "items": { + "type": "string" + }, + "title": "Intended type of device for the administration", + "type": "array" + }, + "device_coding": { + "backref": "device_medication_request", + "description": "[system#code representation.] The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).", + "element_property": true, + "enum_reference_types": [ + "DeviceDefinition" + ], + "items": { + "type": "string" + }, + "title": "Intended type of device for the administration", + "type": "array" + }, + "device_text": { + "backref": "device_medication_request", + "description": "[system#code representation.] The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).", + "element_property": true, + "enum_reference_types": [ + "DeviceDefinition" + ], + "items": { + "type": "string" + }, + "title": "Intended type of device for the administration", + "type": "array" + }, + "dispenseRequest": { + "description": "[Text representation of MedicationRequestDispenseRequest] Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.", + "element_property": true, + "title": "Medication supply authorization", + "type": "string" + }, + "doNotPerform": { + "description": "If true, indicates that the provider is asking for the patient to either stop taking or to not start taking the specified medication. For example, the patient is taking an existing medication and the provider is changing their medication. They want to create two seperate requests: one to stop using the current medication and another to start the new medication.", + "element_property": true, + "title": "True if patient is to stop taking or not to start taking the medication", + "type": "boolean" + }, + "dosageInstruction": { + "description": "[Text representation of Dosage] Specific instructions for how the medication is to be used by the patient.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Specific instructions for how the medication should be taken", + "type": "array" + }, + "effectiveDosePeriod": { + "description": "[Text representation of Period] The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.", + "element_property": true, + "title": "Period over which the medication is to be taken", + "type": "string" + }, + "encounter": { + "backref": "medication_request", + "description": "[Text representation of Reference] The Encounter during which this [x] was created or to which the creation of this record is tightly associated.", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "Encounter created as part of encounter/admission/stay", + "type": "string" + }, + "eventHistory": { + "backref": "eventHistory_medication_request", + "description": "[Text representation of Reference] Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.", + "element_property": true, + "enum_reference_types": [ + "Provenance" + ], + "items": { + "type": "string" + }, + "title": "A list of events of interest in the lifecycle", + "type": "array" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "groupIdentifier": { + "description": "[Text representation of Identifier] A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.", + "element_property": true, + "title": "Composite request this is part of", + "type": "string" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External ids for this request", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External ids for this request", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External ids for this request", + "type": "array" + }, + "informationSource": { + "backref": "informationSource_medication_request", + "description": "[Text representation of Reference] The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Practitioner", + "PractitionerRole", + "RelatedPerson", + "Organization" + ], + "items": { + "type": "string" + }, + "title": "The person or organization who provided the information about this request, if the source is someone other than the requestor", + "type": "array" + }, + "insurance": { + "backref": "insurance_medication_request", + "description": "[Text representation of Reference] Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", + "element_property": true, + "enum_reference_types": [ + "Coverage", + "ClaimResponse" + ], + "items": { + "type": "string" + }, + "title": "Associated insurance coverage", + "type": "array" + }, + "intent": { + "binding_description": "The kind of medication order.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-intent", + "binding_version": "5.0.0", + "description": "Whether the request is a proposal, plan, or an original order.", + "element_property": true, + "element_required": true, + "enum_values": [ + "proposal", + "plan", + "order", + "original-order", + "reflex-order", + "filler-order", + "instance-order", + "option" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", + "type": "string" + }, + "medication": { + "backref": "medication_request", + "binding_description": "A coded concept identifying substance or product that can be ordered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_version": null, + "description": "text representation. Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", + "element_property": true, + "enum_reference_types": [ + "Medication" + ], + "term": { + "description": "A coded concept identifying substance or product that can be ordered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + } + }, + "title": "Medication to be taken", + "type": "string" + }, + "medication_coding": { + "backref": "medication_request", + "binding_description": "A coded concept identifying substance or product that can be ordered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_version": null, + "description": "[system#code representation.] Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", + "element_property": true, + "enum_reference_types": [ + "Medication" + ], + "term": { + "description": "A coded concept identifying substance or product that can be ordered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + } + }, + "title": "Medication to be taken", + "type": "string" + }, + "medication_text": { + "backref": "medication_request", + "binding_description": "A coded concept identifying substance or product that can be ordered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_version": null, + "description": "[system#code representation.] Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", + "element_property": true, + "enum_reference_types": [ + "Medication" + ], + "term": { + "description": "A coded concept identifying substance or product that can be ordered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + } + }, + "title": "Medication to be taken", + "type": "string" + }, + "note": { + "description": "[Text representation of Annotation] Extra information about the prescription that could not be conveyed by the other attributes.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Information about the prescription", + "type": "array" + }, + "performer": { + "backref": "performer_medication_request", + "description": "[Text representation of Reference] The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "Patient", + "DeviceDefinition", + "RelatedPerson", + "CareTeam", + "HealthcareService" + ], + "items": { + "type": "string" + }, + "title": "Intended performer of administration", + "type": "array" + }, + "performerType": { + "binding_description": "Identifies the type of individual that is desired to administer the medication.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "binding_version": null, + "description": "text representation. Indicates the type of performer of the administration of the medication.", + "element_property": true, + "term": { + "description": "Identifies the type of individual that is desired to administer the medication.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "term_url": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role" + } + }, + "title": "Desired kind of performer of the medication administration", + "type": "string" + }, + "performerType_coding": { + "binding_description": "Identifies the type of individual that is desired to administer the medication.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "binding_version": null, + "description": "[system#code representation.] Indicates the type of performer of the administration of the medication.", + "element_property": true, + "term": { + "description": "Identifies the type of individual that is desired to administer the medication.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "term_url": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role" + } + }, + "title": "Desired kind of performer of the medication administration", + "type": "string" + }, + "performerType_text": { + "binding_description": "Identifies the type of individual that is desired to administer the medication.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "binding_version": null, + "description": "[system#code representation.] Indicates the type of performer of the administration of the medication.", + "element_property": true, + "term": { + "description": "Identifies the type of individual that is desired to administer the medication.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role", + "term_url": "http://hl7.org/fhir/ValueSet/medication-intended-performer-role" + } + }, + "title": "Desired kind of performer of the medication administration", + "type": "string" + }, + "priorPrescription": { + "backref": "priorPrescription_medication_request", + "description": "[Text representation of Reference] Reference to an order/prescription that is being replaced by this MedicationRequest", + "element_property": true, + "enum_reference_types": [ + "MedicationRequest" + ], + "title": "Reference to an order/prescription that is being replaced by this MedicationRequest", + "type": "string" + }, + "priority": { + "binding_description": "Identifies the level of importance to be assigned to actioning the request.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/request-priority", + "binding_version": "5.0.0", + "description": "Indicates how quickly the Medication Request should be addressed with respect to other requests.", + "element_property": true, + "enum_values": [ + "routine", + "urgent", + "asap", + "stat" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "routine | urgent | asap | stat", + "type": "string" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "reason": { + "backref": "reason_medication_request", + "binding_description": "A coded concept indicating why the medication was ordered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "text representation. The reason or the indication for ordering or not ordering the medication.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation" + ], + "items": { + "type": "string" + }, + "term": { + "description": "A coded concept indicating why the medication was ordered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Reason or indication for ordering or not ordering the medication", + "type": "array" + }, + "reason_coding": { + "backref": "reason_medication_request", + "binding_description": "A coded concept indicating why the medication was ordered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "[system#code representation.] The reason or the indication for ordering or not ordering the medication.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation" + ], + "items": { + "type": "string" + }, + "term": { + "description": "A coded concept indicating why the medication was ordered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Reason or indication for ordering or not ordering the medication", + "type": "array" + }, + "reason_text": { + "backref": "reason_medication_request", + "binding_description": "A coded concept indicating why the medication was ordered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "[system#code representation.] The reason or the indication for ordering or not ordering the medication.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation" + ], + "items": { + "type": "string" + }, + "term": { + "description": "A coded concept indicating why the medication was ordered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Reason or indication for ordering or not ordering the medication", + "type": "array" + }, + "recorder": { + "backref": "recorder_medication_request", + "description": "[Text representation of Reference] The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole" + ], + "title": "Person who entered the request", + "type": "string" + }, + "renderedDosageInstruction": { + "description": "The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", + "element_property": true, + "pattern": "\\s*(\\S|\\s)*", + "title": "Full representation of the dosage instructions", + "type": "string" + }, + "reported": { + "description": "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.", + "element_property": true, + "title": "Reported rather than primary record", + "type": "boolean" + }, + "requester": { + "backref": "requester_medication_request", + "description": "[Text representation of Reference] The individual, organization, or device that initiated the request and has responsibility for its activation.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "Patient", + "RelatedPerson", + "Device" + ], + "title": "Who/What requested the Request", + "type": "string" + }, + "resourceType": { + "const": "MedicationRequest", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "status": { + "binding_description": "A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status", + "binding_version": "5.0.0", + "description": "A code specifying the current state of the order. Generally, this will be active or completed state.", + "element_property": true, + "element_required": true, + "enum_values": [ + "active", + "on-hold", + "ended", + "stopped", + "completed", + "cancelled", + "entered-in-error", + "draft", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown", + "type": "string" + }, + "statusChanged": { + "description": "The date (and perhaps time) when the status was changed.", + "element_property": true, + "format": "date-time", + "title": "When the status was changed", + "type": "string" + }, + "statusReason": { + "binding_description": "Identifies the reasons for a given status.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "binding_version": null, + "description": "text representation. Captures the reason for the current state of the MedicationRequest.", + "element_property": true, + "term": { + "description": "Identifies the reasons for a given status.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" + } + }, + "title": "Reason for current status", + "type": "string" + }, + "statusReason_coding": { + "binding_description": "Identifies the reasons for a given status.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "binding_version": null, + "description": "[system#code representation.] Captures the reason for the current state of the MedicationRequest.", + "element_property": true, + "term": { + "description": "Identifies the reasons for a given status.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" + } + }, + "title": "Reason for current status", + "type": "string" + }, + "statusReason_text": { + "binding_description": "Identifies the reasons for a given status.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "binding_version": null, + "description": "[system#code representation.] Captures the reason for the current state of the MedicationRequest.", + "element_property": true, + "term": { + "description": "Identifies the reasons for a given status.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason", + "term_url": "http://hl7.org/fhir/ValueSet/medicationrequest-status-reason" + } + }, + "title": "Reason for current status", + "type": "string" + }, + "subject": { + "backref": "subject_medication_request", + "description": "[Text representation of Reference] The individual or group for whom the medication has been requested.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group" + ], + "title": "Individual or group for whom the medication has been requested", + "type": "string" + }, + "substitution": { + "description": "[Text representation of MedicationRequestSubstitution] Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.", + "element_property": true, + "title": "Any restrictions on medication substitution", + "type": "string" + }, + "supportingInformation": { + "backref": "supportingInformation_medication_request", + "description": "[Text representation of Reference] Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient).", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "items": { + "type": "string" + }, + "title": "Information to support fulfilling of the medication", + "type": "array" + } + }, + "systemProperties": [ + "id" + ], + "title": "MedicationRequest", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "research_subject.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Administrative", + "description": "Participant or object which is the recipient of investigative activities in a study. A ResearchSubject is a participant or object which is the recipient of investigative activities in a research study. [See https://hl7.org/fhir/R5/ResearchSubject.html]", + "id": "research_subject", + "links": [ + { + "backref": "research_subject", + "label": "ResearchSubject_subject_Patient_research_subject", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" + }, + { + "backref": "research_subject", + "label": "ResearchSubject_subject_Specimen_research_subject", + "multiplicity": "many_to_many", + "name": "subject_Specimen", + "required": false, + "target_type": "specimen" + }, + { + "backref": "research_subject", + "label": "ResearchSubject_subject_Medication_research_subject", + "multiplicity": "many_to_many", + "name": "subject_Medication", + "required": false, + "target_type": "medication" + }, + { + "backref": "research_subject", + "label": "ResearchSubject_subject_Substance_research_subject", + "multiplicity": "many_to_many", + "name": "subject_Substance", + "required": false, + "target_type": "substance" + }, + { + "backref": "research_subject", + "label": "ResearchSubject_study_ResearchStudy_research_subject", + "multiplicity": "many_to_many", + "name": "study", + "required": false, + "target_type": "research_study" + } + ], + "program": "*", + "project": "*", + "properties": { + "actualComparisonGroup": { + "description": "The name of the arm in the study the subject actually followed as part of this study.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "What path was followed", + "type": "string" + }, + "assignedComparisonGroup": { + "description": "The name of the arm in the study the subject is expected to follow as part of this study.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "What path should be followed", + "type": "string" + }, + "consent": { + "backref": "consent_research_subject", + "description": "[Text representation of Reference] A record of the patient's informed agreement to participate in the study.", + "element_property": true, + "enum_reference_types": [ + "Consent" + ], + "items": { + "type": "string" + }, + "title": "Agreement to participate in study", + "type": "array" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Identifiers assigned to this research subject for a study.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business Identifier for research subject in a study", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Identifiers assigned to this research subject for a study.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business Identifier for research subject in a study", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Identifiers assigned to this research subject for a study.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business Identifier for research subject in a study", + "type": "array" + }, + "period": { + "description": "[Text representation of Period] The dates the subject began and ended their participation in the study.", + "element_property": true, + "title": "Start and end of participation", + "type": "string" + }, + "progress": { + "description": "[Text representation of ResearchSubjectProgress] The current state (status) of the subject and resons for status change where appropriate.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Subject status", + "type": "array" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "resourceType": { + "const": "ResearchSubject", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "status": { + "binding_description": "Codes that convey the current publication status of the research study resource.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/publication-status", + "binding_version": "5.0.0", + "description": "The publication state of the resource (not of the subject).", + "element_property": true, + "element_required": true, + "enum_values": [ + "draft", + "active", + "retired", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "draft | active | retired | unknown", + "type": "string" + }, + "study": { + "backref": "research_subject", + "description": "[Text representation of Reference] Reference to the study the subject is participating in.", + "element_property": true, + "enum_reference_types": [ + "ResearchStudy" + ], + "title": "Study subject is part of", + "type": "string" + }, + "subject": { + "backref": "research_subject", + "description": "[Text representation of Reference] The record of the person, animal or other entity involved in the study.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group", + "Specimen", + "Device", + "Medication", + "Substance", + "BiologicallyDerivedProduct" + ], + "title": "Who or what is part of study", + "type": "string" + } + }, + "systemProperties": [ + "id" + ], + "title": "ResearchSubject", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "diagnostic_report.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Clinical", + "description": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports. The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. [See https://hl7.org/fhir/R5/DiagnosticReport.html]", + "id": "diagnostic_report", + "links": [ + { + "backref": "subject_diagnostic_report", + "label": "DiagnosticReport_subject_Patient_subject_diagnostic_report", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" + }, + { + "backref": "subject_diagnostic_report", + "label": "DiagnosticReport_subject_Organization_subject_diagnostic_report", + "multiplicity": "many_to_many", + "name": "subject_Organization", + "required": false, + "target_type": "organization" + }, + { + "backref": "subject_diagnostic_report", + "label": "DiagnosticReport_subject_Practitioner_subject_diagnostic_report", + "multiplicity": "many_to_many", + "name": "subject_Practitioner", + "required": false, + "target_type": "practitioner" + }, + { + "backref": "subject_diagnostic_report", + "label": "DiagnosticReport_subject_Medication_subject_diagnostic_report", + "multiplicity": "many_to_many", + "name": "subject_Medication", + "required": false, + "target_type": "medication" + }, + { + "backref": "subject_diagnostic_report", + "label": "DiagnosticReport_subject_Substance_subject_diagnostic_report", + "multiplicity": "many_to_many", + "name": "subject_Substance", + "required": false, + "target_type": "substance" + }, + { + "backref": "performer_diagnostic_report", + "label": "DiagnosticReport_performer_PractitionerRole_performer_diagnostic_report", + "multiplicity": "many_to_many", + "name": "performer_PractitionerRole", + "required": false, + "target_type": "practitioner_role" + }, + { + "backref": "result_diagnostic_report", + "label": "DiagnosticReport_result_Observation_result_diagnostic_report", + "multiplicity": "many_to_many", + "name": "result", + "required": false, + "target_type": "observation" + }, + { + "backref": "specimen_diagnostic_report", + "label": "DiagnosticReport_specimen_Specimen_specimen_diagnostic_report", + "multiplicity": "many_to_many", + "name": "specimen", + "required": false, + "target_type": "specimen" + }, + { + "backref": "study_diagnostic_report", + "label": "DiagnosticReport_study_ImagingStudy_study_diagnostic_report", + "multiplicity": "many_to_many", + "name": "study_ImagingStudy", + "required": false, + "target_type": "imaging_study" + } + ], + "program": "*", + "project": "*", + "properties": { + "basedOn": { + "backref": "basedOn_diagnostic_report", + "description": "[Text representation of Reference] Details concerning a service requested.", + "element_property": true, + "enum_reference_types": [ + "CarePlan", + "ImmunizationRecommendation", + "MedicationRequest", + "NutritionOrder", + "ServiceRequest" + ], + "items": { + "type": "string" + }, + "title": "What was requested", + "type": "array" + }, + "category": { + "binding_description": "HL7 V2 table 0074", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "binding_version": null, + "description": "text representation. A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "HL7 V2 table 0074", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "term_url": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" + } + }, + "title": "Service category", + "type": "array" + }, + "category_coding": { + "binding_description": "HL7 V2 table 0074", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "binding_version": null, + "description": "[system#code representation.] A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "HL7 V2 table 0074", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "term_url": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" + } + }, + "title": "Service category", + "type": "array" + }, + "category_text": { + "binding_description": "HL7 V2 table 0074", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "binding_version": null, + "description": "[system#code representation.] A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "HL7 V2 table 0074", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections", + "term_url": "http://hl7.org/fhir/ValueSet/diagnostic-service-sections" + } + }, + "title": "Service category", + "type": "array" + }, + "code": { + "binding_description": "LOINC Codes for Diagnostic Reports", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/report-codes", + "binding_version": null, + "description": "text representation. A code or name that describes this diagnostic report.", + "element_property": true, + "term": { + "description": "LOINC Codes for Diagnostic Reports", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/report-codes", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/report-codes", + "term_url": "http://hl7.org/fhir/ValueSet/report-codes" + } + }, + "title": "Name/Code for this diagnostic report", + "type": "string" + }, + "code_coding": { + "binding_description": "LOINC Codes for Diagnostic Reports", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/report-codes", + "binding_version": null, + "description": "[system#code representation.] A code or name that describes this diagnostic report.", + "element_property": true, + "term": { + "description": "LOINC Codes for Diagnostic Reports", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/report-codes", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/report-codes", + "term_url": "http://hl7.org/fhir/ValueSet/report-codes" + } + }, + "title": "Name/Code for this diagnostic report", + "type": "string" + }, + "code_text": { + "binding_description": "LOINC Codes for Diagnostic Reports", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/report-codes", + "binding_version": null, + "description": "[system#code representation.] A code or name that describes this diagnostic report.", + "element_property": true, + "term": { + "description": "LOINC Codes for Diagnostic Reports", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/report-codes", + "cde_version": null, + "source": "fhir", + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/report-codes", + "term_url": "http://hl7.org/fhir/ValueSet/report-codes" + } + }, + "title": "Name/Code for this diagnostic report", + "type": "string" + }, + "composition": { + "backref": "diagnostic_report", + "description": "[Text representation of Reference] Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.", + "element_property": true, + "enum_reference_types": [ + "Composition" + ], + "title": "Reference to a Composition resource for the DiagnosticReport structure", + "type": "string" + }, + "conclusion": { + "description": "Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.", + "element_property": true, + "pattern": "\\s*(\\S|\\s)*", + "title": "Clinical conclusion (interpretation) of test results", + "type": "string" + }, + "conclusionCode": { + "binding_description": "SNOMED CT Clinical Findings", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "text representation. One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "SNOMED CT Clinical Findings", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Codes for the clinical conclusion of test results", + "type": "array" + }, + "conclusionCode_coding": { + "binding_description": "SNOMED CT Clinical Findings", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "[system#code representation.] One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "SNOMED CT Clinical Findings", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Codes for the clinical conclusion of test results", + "type": "array" + }, + "conclusionCode_text": { + "binding_description": "SNOMED CT Clinical Findings", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "[system#code representation.] One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "SNOMED CT Clinical Findings", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Codes for the clinical conclusion of test results", + "type": "array" + }, + "effectiveDateTime": { + "description": "The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", + "element_property": true, + "format": "date-time", + "one_of_many": "effective", + "one_of_many_required": false, + "title": "Clinically relevant time/time-period for report", + "type": "string" + }, + "effectivePeriod": { + "description": "[Text representation of Period] The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.", + "element_property": true, + "one_of_many": "effective", + "one_of_many_required": false, + "title": "Clinically relevant time/time-period for report", + "type": "string" + }, + "encounter": { + "backref": "diagnostic_report", + "description": "[Text representation of Reference] The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "Health care event when test ordered", + "type": "string" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Identifiers assigned to this report by the performer or other systems.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business identifier for report", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Identifiers assigned to this report by the performer or other systems.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business identifier for report", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Identifiers assigned to this report by the performer or other systems.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Business identifier for report", + "type": "array" + }, + "issued": { + "description": "The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.", + "element_property": true, + "format": "date-time", + "title": "DateTime this version was made", + "type": "string" + }, + "media": { + "description": "[Text representation of DiagnosticReportMedia] A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Key images or data associated with this report", + "type": "array" + }, + "note": { + "description": "[Text representation of Annotation] Comments about the diagnostic report", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Comments about the diagnostic report", + "type": "array" + }, + "performer": { + "backref": "performer_diagnostic_report", + "description": "[Text representation of Reference] The diagnostic service that is responsible for issuing the report.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam" + ], + "items": { + "type": "string" + }, + "title": "Responsible Diagnostic Service", + "type": "array" + }, + "presentedForm": { + "description": "[Text representation of Attachment] Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Entire report as issued", + "type": "array" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "resourceType": { + "const": "DiagnosticReport", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "result": { + "backref": "result_diagnostic_report", + "description": "[Text representation of Reference] [Observations](observation.html) that are part of this diagnostic report.", + "element_property": true, + "enum_reference_types": [ + "Observation" + ], + "items": { + "type": "string" + }, + "title": "Observations", + "type": "array" + }, + "resultsInterpreter": { + "backref": "resultsInterpreter_diagnostic_report", + "description": "[Text representation of Reference] The practitioner or organization that is responsible for the report's conclusions and interpretations.", + "element_property": true, + "enum_reference_types": [ + "Practitioner", + "PractitionerRole", + "Organization", + "CareTeam" + ], + "items": { + "type": "string" + }, + "title": "Primary result interpreter", + "type": "array" + }, + "specimen": { + "backref": "specimen_diagnostic_report", + "description": "[Text representation of Reference] Details about the specimens on which this diagnostic report is based.", + "element_property": true, + "enum_reference_types": [ + "Specimen" + ], + "items": { + "type": "string" + }, + "title": "Specimens this report is based on", + "type": "array" + }, + "status": { + "binding_description": "The status of the diagnostic report.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/diagnostic-report-status", + "binding_version": "5.0.0", + "description": "The status of the diagnostic report.", + "element_property": true, + "element_required": true, + "enum_values": [ + "registered", + "partial", + "preliminary", + "modified", + "final", + "amended", + "corrected", + "appended", + "cancelled", + "entered-in-error", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown", + "type": "string" + }, + "study": { + "backref": "study_diagnostic_report", + "description": "[Text representation of Reference] One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted.", + "element_property": true, + "enum_reference_types": [ + "GenomicStudy", + "ImagingStudy" + ], + "items": { + "type": "string" + }, + "title": "Reference to full details of an analysis associated with the diagnostic report", + "type": "array" + }, + "subject": { + "backref": "subject_diagnostic_report", + "description": "[Text representation of Reference] The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group", + "Device", + "Location", + "Organization", + "Practitioner", + "Medication", + "Substance", + "BiologicallyDerivedProduct" + ], + "title": "The subject of the report - usually, but not always, the patient", + "type": "string" + }, + "supportingInfo": { + "description": "[Text representation of DiagnosticReportSupportingInfo] This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional information supporting the diagnostic report", + "type": "array" + } + }, + "systemProperties": [ + "id" + ], + "title": "DiagnosticReport", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "procedure.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Clinical", + "description": "An action that is being or was performed on an individual or entity. An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing. [See https://hl7.org/fhir/R5/Procedure.html]", + "id": "procedure", + "links": [ + { + "backref": "subject_procedure", + "label": "Procedure_subject_Patient_subject_procedure", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" + }, + { + "backref": "subject_procedure", + "label": "Procedure_subject_Practitioner_subject_procedure", + "multiplicity": "many_to_many", + "name": "subject_Practitioner", + "required": false, + "target_type": "practitioner" + }, + { + "backref": "partOf_procedure", + "label": "Procedure_partOf_Procedure_partOf_procedure", + "multiplicity": "many_to_many", + "name": "partOf_Procedure", + "required": false, + "target_type": "procedure" + } + ], + "program": "*", + "project": "*", + "properties": { + "basedOn": { + "backref": "basedOn_procedure", + "description": "[Text representation of Reference] A reference to a resource that contains details of the request for this procedure.", + "element_property": true, + "enum_reference_types": [ + "CarePlan", + "ServiceRequest" + ], + "items": { + "type": "string" + }, + "title": "A request for this procedure", + "type": "array" + }, + "bodySite": { + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "text representation. Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Target body sites", + "type": "array" + }, + "bodySite_coding": { + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Target body sites", + "type": "array" + }, + "bodySite_text": { + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Target body sites", + "type": "array" + }, + "category": { + "binding_description": "A code that classifies a procedure for searching, sorting and display purposes.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-category", + "binding_version": null, + "description": "text representation. A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "A code that classifies a procedure for searching, sorting and display purposes.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-category", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-category", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-category" + } + }, + "title": "Classification of the procedure", + "type": "array" + }, + "category_coding": { + "binding_description": "A code that classifies a procedure for searching, sorting and display purposes.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-category", + "binding_version": null, + "description": "[system#code representation.] A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "A code that classifies a procedure for searching, sorting and display purposes.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-category", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-category", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-category" + } + }, + "title": "Classification of the procedure", + "type": "array" + }, + "category_text": { + "binding_description": "A code that classifies a procedure for searching, sorting and display purposes.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-category", + "binding_version": null, + "description": "[system#code representation.] A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "A code that classifies a procedure for searching, sorting and display purposes.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-category", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-category", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-category" + } + }, + "title": "Classification of the procedure", + "type": "array" + }, + "code": { + "binding_description": "A code to identify a specific procedure .", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-code", + "binding_version": null, + "description": "text representation. The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").", + "element_property": true, + "term": { + "description": "A code to identify a specific procedure .", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-code", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-code" + } + }, + "title": "Identification of the procedure", + "type": "string" + }, + "code_coding": { + "binding_description": "A code to identify a specific procedure .", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-code", + "binding_version": null, + "description": "[system#code representation.] The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").", + "element_property": true, + "term": { + "description": "A code to identify a specific procedure .", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-code", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-code" + } + }, + "title": "Identification of the procedure", + "type": "string" + }, + "code_text": { + "binding_description": "A code to identify a specific procedure .", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-code", + "binding_version": null, + "description": "[system#code representation.] The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").", + "element_property": true, + "term": { + "description": "A code to identify a specific procedure .", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-code", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-code" + } + }, + "title": "Identification of the procedure", + "type": "string" + }, + "complication": { + "backref": "complication_procedure", + "binding_description": "Codes describing complications that resulted from a procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "text representation. Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.", + "element_property": true, + "enum_reference_types": [ + "Condition" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes describing complications that resulted from a procedure.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Complication following the procedure", + "type": "array" + }, + "complication_coding": { + "backref": "complication_procedure", + "binding_description": "Codes describing complications that resulted from a procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "[system#code representation.] Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.", + "element_property": true, + "enum_reference_types": [ + "Condition" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes describing complications that resulted from a procedure.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Complication following the procedure", + "type": "array" + }, + "complication_text": { + "backref": "complication_procedure", + "binding_description": "Codes describing complications that resulted from a procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/condition-code", + "binding_version": null, + "description": "[system#code representation.] Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.", + "element_property": true, + "enum_reference_types": [ + "Condition" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes describing complications that resulted from a procedure.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/condition-code", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/condition-code", + "term_url": "http://hl7.org/fhir/ValueSet/condition-code" + } + }, + "title": "Complication following the procedure", + "type": "array" + }, + "encounter": { + "backref": "procedure", + "description": "[Text representation of Reference] The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "The Encounter during which this Procedure was created", + "type": "string" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "focalDevice": { + "description": "[Text representation of ProcedureFocalDevice] A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Manipulated, implanted, or removed device", + "type": "array" + }, + "focus": { + "backref": "focus_procedure", + "description": "[Text representation of Reference] Who is the target of the procedure when it is not the subject of record only. If focus is not present, then subject is the focus. If focus is present and the subject is one of the targets of the procedure, include subject as a focus as well. If focus is present and the subject is not included in focus, it implies that the procedure was only targeted on the focus. For example, when a caregiver is given education for a patient, the caregiver would be the focus and the procedure record is associated with the subject (e.g. patient). For example, use focus when recording the target of the education, training, or counseling is the parent or relative of a patient.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group", + "RelatedPerson", + "Practitioner", + "Organization", + "CareTeam", + "PractitionerRole", + "Specimen" + ], + "title": "Who is the target of the procedure when it is not the subject of record only", + "type": "string" + }, + "followUp": { + "binding_description": "Specific follow up required for a procedure e.g. removal of sutures.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-followup", + "binding_version": null, + "description": "text representation. If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "Specific follow up required for a procedure e.g. removal of sutures.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-followup", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-followup", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-followup" + } + }, + "title": "Instructions for follow up", + "type": "array" + }, + "followUp_coding": { + "binding_description": "Specific follow up required for a procedure e.g. removal of sutures.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-followup", + "binding_version": null, + "description": "[system#code representation.] If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "Specific follow up required for a procedure e.g. removal of sutures.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-followup", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-followup", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-followup" + } + }, + "title": "Instructions for follow up", + "type": "array" + }, + "followUp_text": { + "binding_description": "Specific follow up required for a procedure e.g. removal of sutures.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-followup", + "binding_version": null, + "description": "[system#code representation.] If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "Specific follow up required for a procedure e.g. removal of sutures.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-followup", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-followup", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-followup" + } + }, + "title": "Instructions for follow up", + "type": "array" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Identifiers for this procedure", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Identifiers for this procedure", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Identifiers for this procedure", + "type": "array" + }, + "instantiatesCanonical": { + "description": "The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.", + "element_property": true, + "enum_reference_types": [ + "PlanDefinition", + "ActivityDefinition", + "Measure", + "OperationDefinition", + "Questionnaire" + ], + "items": { + "pattern": "\\S*", + "type": "string" + }, + "title": "Instantiates FHIR protocol or definition", + "type": "array" + }, + "instantiatesUri": { + "description": "The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.", + "element_property": true, + "items": { + "pattern": "\\S*", + "type": "string" + }, + "title": "Instantiates external protocol or definition", + "type": "array" + }, + "location": { + "backref": "location_procedure", + "description": "[Text representation of Reference] The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.", + "element_property": true, + "enum_reference_types": [ + "Location" + ], + "title": "Where the procedure happened", + "type": "string" + }, + "note": { + "description": "[Text representation of Annotation] Any other notes and comments about the procedure.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional information about the procedure", + "type": "array" + }, + "occurrenceAge": { + "description": "[Text representation of Age] Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "occurrence", + "one_of_many_required": false, + "title": "When the procedure occurred or is occurring", + "type": "string" + }, + "occurrenceDateTime": { + "description": "Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "format": "date-time", + "one_of_many": "occurrence", + "one_of_many_required": false, + "title": "When the procedure occurred or is occurring", + "type": "string" + }, + "occurrencePeriod": { + "description": "[Text representation of Period] Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "occurrence", + "one_of_many_required": false, + "title": "When the procedure occurred or is occurring", + "type": "string" + }, + "occurrenceRange": { + "description": "[Text representation of Range] Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "occurrence", + "one_of_many_required": false, + "title": "When the procedure occurred or is occurring", + "type": "string" + }, + "occurrenceString": { + "description": "Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "occurrence", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "When the procedure occurred or is occurring", + "type": "string" + }, + "occurrenceTiming": { + "description": "[Text representation of Timing] Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", + "element_property": true, + "one_of_many": "occurrence", + "one_of_many_required": false, + "title": "When the procedure occurred or is occurring", + "type": "string" + }, + "outcome": { + "binding_description": "An outcome of a procedure - whether it was resolved or otherwise.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "binding_version": null, + "description": "text representation. The outcome of the procedure - did it resolve the reasons for the procedure being performed?", + "element_property": true, + "term": { + "description": "An outcome of a procedure - whether it was resolved or otherwise.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-outcome" + } + }, + "title": "The result of procedure", + "type": "string" + }, + "outcome_coding": { + "binding_description": "An outcome of a procedure - whether it was resolved or otherwise.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "binding_version": null, + "description": "[system#code representation.] The outcome of the procedure - did it resolve the reasons for the procedure being performed?", + "element_property": true, + "term": { + "description": "An outcome of a procedure - whether it was resolved or otherwise.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-outcome" + } + }, + "title": "The result of procedure", + "type": "string" + }, + "outcome_text": { + "binding_description": "An outcome of a procedure - whether it was resolved or otherwise.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "binding_version": null, + "description": "[system#code representation.] The outcome of the procedure - did it resolve the reasons for the procedure being performed?", + "element_property": true, + "term": { + "description": "An outcome of a procedure - whether it was resolved or otherwise.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-outcome", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-outcome" + } + }, + "title": "The result of procedure", + "type": "string" + }, + "partOf": { + "backref": "partOf_procedure", + "description": "[Text representation of Reference] A larger event of which this particular procedure is a component or step.", + "element_property": true, + "enum_reference_types": [ + "Procedure", + "Observation", + "MedicationAdministration" + ], + "items": { + "type": "string" + }, + "title": "Part of referenced event", + "type": "array" + }, + "performer": { + "description": "[Text representation of ProcedurePerformer] Indicates who or what performed the procedure and how they were involved.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Who performed the procedure and what they did", + "type": "array" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "reason": { + "backref": "reason_procedure", + "binding_description": "A code that identifies the reason a procedure is required.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-reason", + "binding_version": null, + "description": "text representation. The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "Procedure", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, + "term": { + "description": "A code that identifies the reason a procedure is required.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-reason" + } + }, + "title": "The justification that the procedure was performed", + "type": "array" + }, + "reason_coding": { + "backref": "reason_procedure", + "binding_description": "A code that identifies the reason a procedure is required.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-reason", + "binding_version": null, + "description": "[system#code representation.] The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "Procedure", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, + "term": { + "description": "A code that identifies the reason a procedure is required.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-reason" + } + }, + "title": "The justification that the procedure was performed", + "type": "array" + }, + "reason_text": { + "backref": "reason_procedure", + "binding_description": "A code that identifies the reason a procedure is required.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-reason", + "binding_version": null, + "description": "[system#code representation.] The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "Procedure", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, + "term": { + "description": "A code that identifies the reason a procedure is required.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-reason" + } + }, + "title": "The justification that the procedure was performed", + "type": "array" + }, + "recorded": { + "description": "The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).", + "element_property": true, + "format": "date-time", + "title": "When the procedure was first captured in the subject's record", + "type": "string" + }, + "recorder": { + "backref": "recorder_procedure", + "description": "[Text representation of Reference] Individual who recorded the record and takes responsibility for its content.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "RelatedPerson", + "Practitioner", + "PractitionerRole" + ], + "title": "Who recorded the procedure", + "type": "string" + }, + "report": { + "backref": "report_procedure", + "description": "[Text representation of Reference] This could be a histology result, pathology report, surgical report, etc.", + "element_property": true, + "enum_reference_types": [ + "DiagnosticReport", + "DocumentReference", + "Composition" + ], + "items": { + "type": "string" + }, + "title": "Any report resulting from the procedure", + "type": "array" + }, + "reportedBoolean": { + "description": "Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.", + "element_property": true, + "one_of_many": "reported", + "one_of_many_required": false, + "title": "Reported rather than primary record", + "type": "boolean" + }, + "reportedReference": { + "backref": "reportedReference_procedure", + "description": "[Text representation of Reference] Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "RelatedPerson", + "Practitioner", + "PractitionerRole", + "Organization" + ], + "one_of_many": "reported", + "one_of_many_required": false, + "title": "Reported rather than primary record", + "type": "string" + }, + "resourceType": { + "const": "Procedure", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "status": { + "binding_description": "A code specifying the state of the procedure.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/event-status", + "binding_version": "5.0.0", + "description": "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.", + "element_property": true, + "element_required": true, + "enum_values": [ + "preparation", + "in-progress", + "not-done", + "on-hold", + "stopped", + "completed", + "entered-in-error", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", + "type": "string" + }, + "statusReason": { + "binding_description": "A code that identifies the reason a procedure was not performed.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "binding_version": null, + "description": "text representation. Captures the reason for the current state of the procedure.", + "element_property": true, + "term": { + "description": "A code that identifies the reason a procedure was not performed.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason" + } + }, + "title": "Reason for current status", + "type": "string" + }, + "statusReason_coding": { + "binding_description": "A code that identifies the reason a procedure was not performed.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "binding_version": null, + "description": "[system#code representation.] Captures the reason for the current state of the procedure.", + "element_property": true, + "term": { + "description": "A code that identifies the reason a procedure was not performed.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason" + } + }, + "title": "Reason for current status", + "type": "string" + }, + "statusReason_text": { + "binding_description": "A code that identifies the reason a procedure was not performed.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "binding_version": null, + "description": "[system#code representation.] Captures the reason for the current state of the procedure.", + "element_property": true, + "term": { + "description": "A code that identifies the reason a procedure was not performed.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason" + } + }, + "title": "Reason for current status", + "type": "string" + }, + "subject": { + "backref": "subject_procedure", + "description": "[Text representation of Reference] On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group", + "Device", + "Practitioner", + "Organization", + "Location" + ], + "title": "Individual or entity the procedure was performed on", + "type": "string" + }, + "supportingInfo": { + "backref": "supportingInfo_procedure", + "description": "[Text representation of Reference] Other resources from the patient record that may be relevant to the procedure. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension should not be used if more specific inline elements or extensions are available.", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "items": { + "type": "string" + }, + "title": "Extra information relevant to the procedure", + "type": "array" + }, + "used": { + "backref": "used_procedure", + "binding_description": "Codes describing items used during a procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/device-type", + "binding_version": null, + "description": "text representation. Identifies medications, devices and any other substance used as part of the procedure.", + "element_property": true, + "enum_reference_types": [ + "Device", + "Medication", + "Substance", + "BiologicallyDerivedProduct" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes describing items used during a procedure.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/device-type", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/device-type", + "term_url": "http://hl7.org/fhir/ValueSet/device-type" + } + }, + "title": "Items used during procedure", + "type": "array" + }, + "used_coding": { + "backref": "used_procedure", + "binding_description": "Codes describing items used during a procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/device-type", + "binding_version": null, + "description": "[system#code representation.] Identifies medications, devices and any other substance used as part of the procedure.", + "element_property": true, + "enum_reference_types": [ + "Device", + "Medication", + "Substance", + "BiologicallyDerivedProduct" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes describing items used during a procedure.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/device-type", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/device-type", + "term_url": "http://hl7.org/fhir/ValueSet/device-type" + } + }, + "title": "Items used during procedure", + "type": "array" + }, + "used_text": { + "backref": "used_procedure", + "binding_description": "Codes describing items used during a procedure.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/device-type", + "binding_version": null, + "description": "[system#code representation.] Identifies medications, devices and any other substance used as part of the procedure.", + "element_property": true, + "enum_reference_types": [ + "Device", + "Medication", + "Substance", + "BiologicallyDerivedProduct" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes describing items used during a procedure.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/device-type", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/device-type", + "term_url": "http://hl7.org/fhir/ValueSet/device-type" + } + }, + "title": "Items used during procedure", + "type": "array" + } + }, + "systemProperties": [ + "id" + ], + "title": "Procedure", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "organization.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Administrative", + "description": "A grouping of people or organizations with a common purpose. A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. [See https://hl7.org/fhir/R5/Organization.html]", + "id": "organization", + "links": [ + { + "backref": "organization", + "label": "Organization_partOf_Organization_organization", + "multiplicity": "many_to_many", + "name": "partOf", + "required": false, + "target_type": "organization" + } + ], + "program": "*", + "project": "*", + "properties": { + "active": { + "description": "Whether the organization's record is still in active use", + "element_property": true, + "title": "Whether the organization's record is still in active use", + "type": "boolean" + }, + "alias": { + "description": "A list of alternate names that the organization is known as, or was known as in the past", + "element_property": true, + "items": { + "pattern": "[ \\r\\n\\t\\S]+", + "type": "string" + }, + "title": "A list of alternate names that the organization is known as, or was known as in the past", + "type": "array" + }, + "contact": { + "description": "[Text representation of ExtendedContactDetail] The contact details of communication devices available relevant to the specific Organization. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Official contact details for the Organization", + "type": "array" + }, + "description": { + "description": "Description of the organization, which helps provide additional general context on the organization to ensure that the correct organization is selected.", + "element_property": true, + "pattern": "\\s*(\\S|\\s)*", + "title": "Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name", + "type": "string" + }, + "endpoint": { + "backref": "endpoint_organization", + "description": "[Text representation of Reference] Technical endpoints providing access to services operated for the organization", + "element_property": true, + "enum_reference_types": [ + "Endpoint" + ], + "items": { + "type": "string" + }, + "title": "Technical endpoints providing access to services operated for the organization", + "type": "array" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Identifies this organization across multiple systems", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Identifier for the organization that is used to identify the organization across multiple disparate systems.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Identifies this organization across multiple systems", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Identifier for the organization that is used to identify the organization across multiple disparate systems.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Identifies this organization across multiple systems", + "type": "array" + }, + "name": { + "description": "A name associated with the organization.", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Name used for the organization", + "type": "string" + }, + "partOf": { + "backref": "organization", + "description": "[Text representation of Reference] The organization of which this organization forms a part", + "element_property": true, + "enum_reference_types": [ + "Organization" + ], + "title": "The organization of which this organization forms a part", + "type": "string" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "qualification": { + "description": "[Text representation of OrganizationQualification] The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization. For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care", + "type": "array" + }, + "resourceType": { + "const": "Organization", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "type": { + "binding_description": "Used to categorize the organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/organization-type", + "binding_version": null, + "description": "text representation. The kind(s) of organization that this is.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "Used to categorize the organization.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/organization-type", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/organization-type", + "term_url": "http://hl7.org/fhir/ValueSet/organization-type" + } + }, + "title": "Kind of organization", + "type": "array" + }, + "type_coding": { + "binding_description": "Used to categorize the organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/organization-type", + "binding_version": null, + "description": "[system#code representation.] The kind(s) of organization that this is.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "Used to categorize the organization.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/organization-type", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/organization-type", + "term_url": "http://hl7.org/fhir/ValueSet/organization-type" + } + }, + "title": "Kind of organization", + "type": "array" + }, + "type_text": { + "binding_description": "Used to categorize the organization.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/organization-type", + "binding_version": null, + "description": "[system#code representation.] The kind(s) of organization that this is.", + "element_property": true, + "items": { + "type": "string" + }, + "term": { + "description": "Used to categorize the organization.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/organization-type", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/organization-type", + "term_url": "http://hl7.org/fhir/ValueSet/organization-type" + } + }, + "title": "Kind of organization", + "type": "array" + } + }, + "systemProperties": [ + "id" + ], + "title": "Organization", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "_terms.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "RIN": { + "description": "A numerical assessment of the integrity of RNA based on the entire electrophoretic trace of the RNA sample including the presence or absence of degradation products.\n", + "termDef": { + "cde_id": 5278775, + "cde_version": 1.0, + "source": "caDSR", + "term": "Biospecimen RNA Integrity Number Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5278775&version=1.0" + } + }, + "UUID": { + "description": "A 128-bit identifier. Depending on the mechanism used to generate it, it is either guaranteed to be different from all other UUIDs/GUIDs generated until 3400 AD or extremely likely to be different. Its relatively small size lends itself well to sorting, ordering, and hashing of all sorts, storing in databases, simple allocation, and ease of programming in general.\n", + "termDef": { + "cde_id": "C54100", + "cde_version": null, + "source": "NCIt", + "term": "Universally Unique Identifier", + "term_url": "https://ncit.nci.nih.gov/ncitbrowser/ConceptReport.jsp?dictionary=NCI_Thesaurus&version=16.02d&ns=NCI_Thesaurus&code=C54100" + } + }, + "data_category": { + "description": "Broad categorization of the contents of the data file.\n" + }, + "data_file_error_type": { + "description": "Type of error for the data file object.\n" + }, + "data_format": { + "description": "Format of the data files.\n" + }, + "data_type": { + "description": "Specific content type of the data file. (CMG)\n" + }, + "datetime": { + "description": "A combination of date and time of day in the form [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]\n" + }, + "encoding": { + "description": "Version of ASCII encoding of quality values found in the file.\n", + "termDef": { + "cde_id": null, + "cde_version": null, + "source": "FastQC", + "term": "Encoding", + "term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/1%20Basic%20Statistics.html" + } + }, + "file_format": { + "description": "The format of the data file object.\n" + }, + "file_name": { + "description": "The name (or part of a name) of a file (of any type).\n" + }, + "file_size": { + "description": "The size of the data file (object) in bytes.\n" + }, + "file_state": { + "description": "The current state of the data file object.\n" + }, + "ga4gh_drs_uri": { + "description": "DRS URI as defined by GA4GH DRS spec for pointers to file objects.\n" + }, + "id": "_terms", + "md5sum": { + "description": "The 128-bit hash value expressed as a 32 digit hexadecimal number used as a file's digital fingerprint.\n" + }, + "microsatellite_instability_abnormal": { + "description": "The yes/no indicator to signify the status of a tumor for microsatellite instability.\n", + "termDef": { + "cde_id": 3123142, + "cde_version": 1.0, + "source": "caDSR", + "term": "Microsatellite Instability Occurrence Indicator", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3123142&version=1.0" + } + }, + "morphology": { + "description": "The third edition of the International Classification of Diseases for Oncology, published in 2000 used principally in tumor and cancer registries for coding the site (topography) and the histology (morphology) of neoplasms. The study of the structure of the cells and their arrangement to constitute tissues and, finally, the association among these to form organs. In pathology, the microscopic process of identifying normal and abnormal morphologic characteristics in tissues, by employing various cytochemical and immunocytochemical stains. A system of numbered categories for representation of data.\n", + "termDef": { + "cde_id": 3226275, + "cde_version": 1.0, + "source": "caDSR", + "term": "International Classification of Diseases for Oncology, Third Edition ICD-O-3 Histology Code", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3226275&version=1.0" + } + }, + "new_event_anatomic_site": { + "description": "Text term to specify the anatomic location of the return of tumor after treatment.\n", + "termDef": { + "cde_id": 3108271, + "cde_version": 2.0, + "source": "caDSR", + "term": "New Neoplasm Event Occurrence Anatomic Site", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3108271&version=2.0" + } + }, + "new_event_type": { + "description": "Text term to identify a new tumor event.\n", + "termDef": { + "cde_id": 3119721, + "cde_version": 1.0, + "source": "caDSR", + "term": "New Neoplasm Event Type", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3119721&version=1.0" + } + }, + "normal_tumor_genotype_snp_match": { + "description": "Text term that represents whether or not the genotype of the normal tumor matches or if the data is not available.\n", + "termDef": { + "cde_id": 4588156, + "cde_version": 1.0, + "source": "caDSR", + "term": "Normal Tumor Genotype Match Indicator", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=4588156&version=1.0" + } + }, + "number_proliferating_cells": { + "description": "Numeric value that represents the count of proliferating cells determined during pathologic review of the sample slide(s).\n", + "termDef": { + "cde_id": 5432636, + "cde_version": 1.0, + "source": "caDSR", + "term": "Pathology Review Slide Proliferating Cell Count", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432636&version=1.0" + } + }, + "oct_embedded": { + "description": "Indicator of whether or not the sample was embedded in Optimal Cutting Temperature (OCT) compound.\n", + "termDef": { + "cde_id": 5432538, + "cde_version": 1.0, + "source": "caDSR", + "term": "Tissue Sample Optimal Cutting Temperature Compound Embedding Indicator", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432538&version=1.0" + } + }, + "percent_eosinophil_infiltration": { + "description": "Numeric value to represent the percentage of infiltration by eosinophils in a tumor sample or specimen.\n", + "termDef": { + "cde_id": 2897700, + "cde_version": 2.0, + "source": "caDSR", + "term": "Specimen Eosinophilia Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897700&version=2.0" + } + }, + "percent_gc_content": { + "description": "The overall %GC of all bases in all sequences.\n", + "termDef": { + "cde_id": null, + "cde_version": null, + "source": "FastQC", + "term": "%GC", + "term_url": "http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/3%20Analysis%20Modules/1%20Basic%20Statistics.html" + } + }, + "percent_granulocyte_infiltration": { + "description": "Numeric value to represent the percentage of infiltration by granulocytes in a tumor sample or specimen.\n", + "termDef": { + "cde_id": 2897705, + "cde_version": 2.0, + "source": "caDSR", + "term": "Specimen Granulocyte Infiltration Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897705&version=2.0" + } + }, + "percent_inflam_infiltration": { + "description": "Numeric value to represent local response to cellular injury, marked by capillary dilatation, edema and leukocyte infiltration; clinically, inflammation is manifest by reddness, heat, pain, swelling and loss of function, with the need to heal damaged tissue.\n", + "termDef": { + "cde_id": 2897695, + "cde_version": 1.0, + "source": "caDSR", + "term": "Specimen Inflammation Change Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897695&version=1.0" + } + }, + "percent_lymphocyte_infiltration": { + "description": "Numeric value to represent the percentage of infiltration by lymphocytes in a solid tissue normal sample or specimen.\n", + "termDef": { + "cde_id": 2897710, + "cde_version": 2.0, + "source": "caDSR", + "term": "Specimen Lymphocyte Infiltration Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2897710&version=2.0" + } + }, + "percent_monocyte_infiltration": { + "description": "Numeric value to represent the percentage of monocyte infiltration in a sample or specimen.\n", + "termDef": { + "cde_id": 5455535, + "cde_version": 1.0, + "source": "caDSR", + "term": "Specimen Monocyte Infiltration Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5455535&version=1.0" + } + }, + "percent_necrosis": { + "description": "Numeric value to represent the percentage of cell death in a malignant tumor sample or specimen.\n", + "termDef": { + "cde_id": 2841237, + "cde_version": 1.0, + "source": "caDSR", + "term": "Malignant Neoplasm Necrosis Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841237&version=1.0" + } + }, + "percent_neutrophil_infiltration": { + "description": "Numeric value to represent the percentage of infiltration by neutrophils in a tumor sample or specimen.\n", + "termDef": { + "cde_id": 2841267, + "cde_version": 1.0, + "source": "caDSR", + "term": "Malignant Neoplasm Neutrophil Infiltration Percentage Cell Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841267&version=1.0" + } + }, + "percent_normal_cells": { + "description": "Numeric value to represent the percentage of normal cell content in a malignant tumor sample or specimen.\n", + "termDef": { + "cde_id": 2841233, + "cde_version": 1.0, + "source": "caDSR", + "term": "Malignant Neoplasm Normal Cell Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841233&version=1.0" + } + }, + "percent_stromal_cells": { + "description": "Numeric value to represent the percentage of reactive cells that are present in a malignant tumor sample or specimen but are not malignant such as fibroblasts, vascular structures, etc.\n", + "termDef": { + "cde_id": 2841241, + "cde_version": 1.0, + "source": "caDSR", + "term": "Malignant Neoplasm Stromal Cell Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=2841241&version=1.0" + } + }, + "percent_tumor_cells": { + "description": "Numeric value that represents the percentage of infiltration by granulocytes in a sample.\n", + "termDef": { + "cde_id": 5432686, + "cde_version": 1.0, + "source": "caDSR", + "term": "Specimen Tumor Cell Percentage Value", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=5432686&version=1.0" + } + }, + "percent_tumor_nuclei": { "description": "Numeric value to represent the percentage of tumor nuclei in a malignant neoplasm sample or specimen.\n", "termDef": { "cde_id": 2841225, @@ -7974,614 +10618,1345 @@ "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3137957&version=1.0" } }, - "years_smoked_gt89": { - "description": "Indicate whether the numeric value to represent the number of years a person has been smoking (HARMONIZED) is greater than 89 years.\n", - "termDef": { - "cde_id": 3137957, - "cde_version": 1.0, - "source": "caDSR", - "term": "Person Smoking Duration Year Count", - "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3137957&version=1.0" - } - } + "years_smoked_gt89": { + "description": "Indicate whether the numeric value to represent the number of years a person has been smoking (HARMONIZED) is greater than 89 years.\n", + "termDef": { + "cde_id": 3137957, + "cde_version": 1.0, + "source": "caDSR", + "term": "Person Smoking Duration Year Count", + "term_url": "https://cdebrowser.nci.nih.gov/CDEBrowser/search?elementDetails=9&FirstTimer=0&PageId=ElementDetailsGroup&publicId=3137957&version=1.0" + } + } + }, + "family_member_history.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Clinical", + "description": "Information about patient's relatives, relevant for patient. Significant health conditions for a person related to the patient relevant in the context of care for the patient. [See https://hl7.org/fhir/R5/FamilyMemberHistory.html]", + "id": "family_member_history", + "links": [ + { + "backref": "family_member_history", + "label": "FamilyMemberHistory_patient_Patient_family_member_history", + "multiplicity": "many_to_many", + "name": "patient", + "required": false, + "target_type": "patient" + } + ], + "program": "*", + "project": "*", + "properties": { + "ageAge": { + "description": "[Text representation of Age] The age of the relative at the time the family member history is recorded.", + "element_property": true, + "one_of_many": "age", + "one_of_many_required": false, + "title": "(approximate) age", + "type": "string" + }, + "ageRange": { + "description": "[Text representation of Range] The age of the relative at the time the family member history is recorded.", + "element_property": true, + "one_of_many": "age", + "one_of_many_required": false, + "title": "(approximate) age", + "type": "string" + }, + "ageString": { + "description": "The age of the relative at the time the family member history is recorded.", + "element_property": true, + "one_of_many": "age", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "(approximate) age", + "type": "string" + }, + "bornDate": { + "description": "The actual or approximate date of birth of the relative.", + "element_property": true, + "format": "date", + "one_of_many": "born", + "one_of_many_required": false, + "title": "(approximate) date of birth", + "type": "string" + }, + "bornPeriod": { + "description": "[Text representation of Period] The actual or approximate date of birth of the relative.", + "element_property": true, + "one_of_many": "born", + "one_of_many_required": false, + "title": "(approximate) date of birth", + "type": "string" + }, + "bornString": { + "description": "The actual or approximate date of birth of the relative.", + "element_property": true, + "one_of_many": "born", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "(approximate) date of birth", + "type": "string" + }, + "condition": { + "description": "[Text representation of FamilyMemberHistoryCondition] The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Condition that the related person had", + "type": "array" + }, + "dataAbsentReason": { + "binding_description": "Codes describing the reason why a family member's history is not available.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "binding_version": null, + "description": "text representation. Describes why the family member's history is not available.", + "element_property": true, + "term": { + "description": "Codes describing the reason why a family member's history is not available.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/history-absent-reason" + } + }, + "title": "subject-unknown | withheld | unable-to-obtain | deferred", + "type": "string" + }, + "dataAbsentReason_coding": { + "binding_description": "Codes describing the reason why a family member's history is not available.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "binding_version": null, + "description": "[system#code representation.] Describes why the family member's history is not available.", + "element_property": true, + "term": { + "description": "Codes describing the reason why a family member's history is not available.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/history-absent-reason" + } + }, + "title": "subject-unknown | withheld | unable-to-obtain | deferred", + "type": "string" + }, + "dataAbsentReason_text": { + "binding_description": "Codes describing the reason why a family member's history is not available.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "binding_version": null, + "description": "[system#code representation.] Describes why the family member's history is not available.", + "element_property": true, + "term": { + "description": "Codes describing the reason why a family member's history is not available.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/history-absent-reason" + } + }, + "title": "subject-unknown | withheld | unable-to-obtain | deferred", + "type": "string" + }, + "date": { + "description": "The date (and possibly time) when the family member history was recorded or last updated.", + "element_property": true, + "format": "date-time", + "title": "When history was recorded or last updated", + "type": "string" + }, + "deceasedAge": { + "description": "[Text representation of Age] Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "element_property": true, + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Dead? How old/when?", + "type": "string" + }, + "deceasedBoolean": { + "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "element_property": true, + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Dead? How old/when?", + "type": "boolean" + }, + "deceasedDate": { + "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "element_property": true, + "format": "date", + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Dead? How old/when?", + "type": "string" + }, + "deceasedRange": { + "description": "[Text representation of Range] Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "element_property": true, + "one_of_many": "deceased", + "one_of_many_required": false, + "title": "Dead? How old/when?", + "type": "string" + }, + "deceasedString": { + "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "element_property": true, + "one_of_many": "deceased", + "one_of_many_required": false, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Dead? How old/when?", + "type": "string" + }, + "estimatedAge": { + "description": "If true, indicates that the age value specified is an estimated value.", + "element_property": true, + "title": "Age is estimated?", + "type": "boolean" + }, + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" + }, + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Id(s) for this record", + "type": "array" + }, + "identifier_coding": { + "description": "[system#code representation of identifier] Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Id(s) for this record", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "External Id(s) for this record", + "type": "array" + }, + "instantiatesCanonical": { + "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", + "element_property": true, + "enum_reference_types": [ + "PlanDefinition", + "Questionnaire", + "ActivityDefinition", + "Measure", + "OperationDefinition" + ], + "items": { + "pattern": "\\S*", + "type": "string" + }, + "title": "Instantiates FHIR protocol or definition", + "type": "array" + }, + "instantiatesUri": { + "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", + "element_property": true, + "items": { + "pattern": "\\S*", + "type": "string" + }, + "title": "Instantiates external protocol or definition", + "type": "array" + }, + "name": { + "description": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".", + "element_property": true, + "pattern": "[ \\r\\n\\t\\S]+", + "title": "The family member described", + "type": "string" + }, + "note": { + "description": "[Text representation of Annotation] This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "General note about related person", + "type": "array" + }, + "participant": { + "description": "[Text representation of FamilyMemberHistoryParticipant] Indicates who or what participated in the activities related to the family member history and how they were involved.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Who or what participated in the activities related to the family member history and how they were involved", + "type": "array" + }, + "patient": { + "backref": "family_member_history", + "description": "[Text representation of Reference] The person who this history concerns.", + "element_property": true, + "enum_reference_types": [ + "Patient" + ], + "title": "Patient history is about", + "type": "string" + }, + "procedure": { + "description": "[Text representation of FamilyMemberHistoryProcedure] The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Procedures that the related person had", + "type": "array" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "reason": { + "backref": "reason_family_member_history", + "binding_description": "Codes indicating why the family member history was done.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "text representation. Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "AllergyIntolerance", + "QuestionnaireResponse", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes indicating why the family member history was done.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Why was family member history performed?", + "type": "array" + }, + "reason_coding": { + "backref": "reason_family_member_history", + "binding_description": "Codes indicating why the family member history was done.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "[system#code representation.] Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "AllergyIntolerance", + "QuestionnaireResponse", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes indicating why the family member history was done.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Why was family member history performed?", + "type": "array" + }, + "reason_text": { + "backref": "reason_family_member_history", + "binding_description": "Codes indicating why the family member history was done.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", + "binding_version": null, + "description": "[system#code representation.] Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "AllergyIntolerance", + "QuestionnaireResponse", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, + "term": { + "description": "Codes indicating why the family member history was done.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/clinical-findings", + "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" + } + }, + "title": "Why was family member history performed?", + "type": "array" + }, + "relationship": { + "binding_description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "binding_version": null, + "description": "text representation. The type of relationship this person has to the patient (father, mother, brother etc.).", + "element_property": true, + "term": { + "description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "term_url": "http://terminology.hl7.org/ValueSet/v3-FamilyMember" + } + }, + "title": "Relationship to the subject", + "type": "string" + }, + "relationship_coding": { + "binding_description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "binding_version": null, + "description": "[system#code representation.] The type of relationship this person has to the patient (father, mother, brother etc.).", + "element_property": true, + "term": { + "description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "term_url": "http://terminology.hl7.org/ValueSet/v3-FamilyMember" + } + }, + "title": "Relationship to the subject", + "type": "string" + }, + "relationship_text": { + "binding_description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "binding_version": null, + "description": "[system#code representation.] The type of relationship this person has to the patient (father, mother, brother etc.).", + "element_property": true, + "term": { + "description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "term_url": "http://terminology.hl7.org/ValueSet/v3-FamilyMember" + } + }, + "title": "Relationship to the subject", + "type": "string" + }, + "resourceType": { + "const": "FamilyMemberHistory", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "sex": { + "binding_description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "binding_version": null, + "description": "text representation. The birth sex of the family member.", + "element_property": true, + "term": { + "description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/administrative-gender", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/administrative-gender", + "term_url": "http://hl7.org/fhir/ValueSet/administrative-gender" + } + }, + "title": "male | female | other | unknown", + "type": "string" + }, + "sex_coding": { + "binding_description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "binding_version": null, + "description": "[system#code representation.] The birth sex of the family member.", + "element_property": true, + "term": { + "description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/administrative-gender", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/administrative-gender", + "term_url": "http://hl7.org/fhir/ValueSet/administrative-gender" + } + }, + "title": "male | female | other | unknown", + "type": "string" + }, + "sex_text": { + "binding_description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "binding_strength": "extensible", + "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "binding_version": null, + "description": "[system#code representation.] The birth sex of the family member.", + "element_property": true, + "term": { + "description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/administrative-gender", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://hl7.org/fhir/ValueSet/administrative-gender", + "term_url": "http://hl7.org/fhir/ValueSet/administrative-gender" + } + }, + "title": "male | female | other | unknown", + "type": "string" + }, + "status": { + "binding_description": "A code that identifies the status of the family history record.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/history-status", + "binding_version": "5.0.0", + "description": "A code specifying the status of the record of the family history of a specific family member.", + "element_property": true, + "element_required": true, + "enum_values": [ + "partial", + "completed", + "entered-in-error", + "health-unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "partial | completed | entered-in-error | health-unknown", + "type": "string" + } + }, + "systemProperties": [ + "id" + ], + "title": "FamilyMemberHistory", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] }, - "family_member_history.yaml": { + "body_structure.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, "category": "Clinical", - "description": "Information about patient's relatives, relevant for patient. Significant health conditions for a person related to the patient relevant in the context of care for the patient. [See https://hl7.org/fhir/R5/FamilyMemberHistory.html]", - "id": "family_member_history", + "description": "Specific and identified anatomical structure. Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case. [See https://hl7.org/fhir/R5/BodyStructure.html]", + "id": "body_structure", "links": [ { - "backref": "family_member_history", - "label": "FamilyMemberHistory_patient_Patient_family_member_history", + "backref": "body_structure", + "label": "BodyStructure_patient_Patient_body_structure", "multiplicity": "many_to_many", "name": "patient", "required": false, "target_type": "patient" - }, - { - "backref": "reason_family_member_history", - "label": "FamilyMemberHistory_reason_Condition_reason_family_member_history", - "multiplicity": "many_to_many", - "name": "reason_Condition", - "required": false, - "target_type": "condition" - }, - { - "backref": "reason_family_member_history", - "label": "FamilyMemberHistory_reason_Observation_reason_family_member_history", - "multiplicity": "many_to_many", - "name": "reason_Observation", - "required": false, - "target_type": "observation" - }, - { - "backref": "reason_family_member_history", - "label": "FamilyMemberHistory_reason_DocumentReference_reason_family_member_history", - "multiplicity": "many_to_many", - "name": "reason_DocumentReference", - "required": false, - "target_type": "document_reference" } ], "program": "*", "project": "*", "properties": { - "ageAge": { - "description": "[Text representation of Age] The age of the relative at the time the family member history is recorded.", + "active": { + "description": "Whether this body site is in active use.", + "element_property": true, + "title": "Whether this record is in active use", + "type": "boolean" + }, + "description": { + "description": "A summary, characterization or explanation of the body structure.", "element_property": true, - "one_of_many": "age", - "one_of_many_required": false, - "title": "(approximate) age", + "pattern": "\\s*(\\S|\\s)*", + "title": "Text description", "type": "string" }, - "ageRange": { - "description": "[Text representation of Range] The age of the relative at the time the family member history is recorded.", + "excludedStructure": { + "description": "[Text representation of BodyStructureIncludedStructure] The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.", "element_property": true, - "one_of_many": "age", - "one_of_many_required": false, - "title": "(approximate) age", - "type": "string" + "items": { + "type": "string" + }, + "title": "Excluded anatomic locations(s)", + "type": "array" }, - "ageString": { - "description": "The age of the relative at the time the family member history is recorded.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, - "one_of_many": "age", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "(approximate) age", - "type": "string" + "items": { + "type": "string" + }, + "title": "Additional content defined by implementations", + "type": "array" }, - "bornDate": { - "description": "The actual or approximate date of birth of the relative.", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, - "format": "date", - "one_of_many": "born", - "one_of_many_required": false, - "title": "(approximate) date of birth", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", "type": "string" }, - "bornPeriod": { - "description": "[Text representation of Period] The actual or approximate date of birth of the relative.", + "identifier": { + "description": "Identifier for this instance of the anatomical structure.", "element_property": true, - "one_of_many": "born", - "one_of_many_required": false, - "title": "(approximate) date of birth", - "type": "string" + "items": { + "type": "string" + }, + "title": "Bodystructure identifier", + "type": "array" }, - "bornString": { - "description": "The actual or approximate date of birth of the relative.", + "identifier_coding": { + "description": "[system#code representation of identifier] Identifier for this instance of the anatomical structure.", "element_property": true, - "one_of_many": "born", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "(approximate) date of birth", - "type": "string" + "items": { + "type": "string" + }, + "title": "Bodystructure identifier", + "type": "array" }, - "condition": { - "description": "[Text representation of FamilyMemberHistoryCondition] The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.", + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Identifier for this instance of the anatomical structure.", "element_property": true, "items": { "type": "string" }, - "title": "Condition that the related person had", + "title": "Bodystructure identifier", "type": "array" }, - "dataAbsentReason": { - "binding_description": "Codes describing the reason why a family member's history is not available.", + "image": { + "description": "[Text representation of Attachment] Image or images used to identify a location.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Attached images", + "type": "array" + }, + "includedStructure": { + "description": "[Text representation of BodyStructureIncludedStructure] The anatomical location(s) or region(s) of the specimen, lesion, or body structure.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Included anatomic location(s)", + "type": "array" + }, + "morphology": { + "binding_description": "Codes describing anatomic morphology.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "binding_uri": "http://hl7.org/fhir/ValueSet/bodystructure-code", "binding_version": null, - "description": "text representation. Describes why the family member's history is not available.", + "description": "text representation. The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.", "element_property": true, "term": { - "description": "Codes describing the reason why a family member's history is not available.", + "description": "Codes describing anatomic morphology.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "cde_id": "http://hl7.org/fhir/ValueSet/bodystructure-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/history-absent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/history-absent-reason" + "term": "http://hl7.org/fhir/ValueSet/bodystructure-code", + "term_url": "http://hl7.org/fhir/ValueSet/bodystructure-code" } }, - "title": "subject-unknown | withheld | unable-to-obtain | deferred", + "title": "Kind of Structure", "type": "string" }, - "dataAbsentReason_coding": { - "binding_description": "Codes describing the reason why a family member's history is not available.", + "morphology_coding": { + "binding_description": "Codes describing anatomic morphology.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "binding_uri": "http://hl7.org/fhir/ValueSet/bodystructure-code", "binding_version": null, - "description": "[system#code representation.] Describes why the family member's history is not available.", + "description": "[system#code representation.] The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.", "element_property": true, "term": { - "description": "Codes describing the reason why a family member's history is not available.", + "description": "Codes describing anatomic morphology.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "cde_id": "http://hl7.org/fhir/ValueSet/bodystructure-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/history-absent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/history-absent-reason" + "term": "http://hl7.org/fhir/ValueSet/bodystructure-code", + "term_url": "http://hl7.org/fhir/ValueSet/bodystructure-code" } }, - "title": "subject-unknown | withheld | unable-to-obtain | deferred", + "title": "Kind of Structure", "type": "string" }, - "dataAbsentReason_text": { - "binding_description": "Codes describing the reason why a family member's history is not available.", + "morphology_text": { + "binding_description": "Codes describing anatomic morphology.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "binding_uri": "http://hl7.org/fhir/ValueSet/bodystructure-code", "binding_version": null, - "description": "[system#code representation.] Describes why the family member's history is not available.", + "description": "[system#code representation.] The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.", "element_property": true, "term": { - "description": "Codes describing the reason why a family member's history is not available.", + "description": "Codes describing anatomic morphology.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/history-absent-reason", + "cde_id": "http://hl7.org/fhir/ValueSet/bodystructure-code", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/history-absent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/history-absent-reason" + "term": "http://hl7.org/fhir/ValueSet/bodystructure-code", + "term_url": "http://hl7.org/fhir/ValueSet/bodystructure-code" } }, - "title": "subject-unknown | withheld | unable-to-obtain | deferred", + "title": "Kind of Structure", "type": "string" }, - "date": { - "description": "The date (and possibly time) when the family member history was recorded or last updated.", + "patient": { + "backref": "body_structure", + "description": "[Text representation of Reference] The person to which the body site belongs.", "element_property": true, - "format": "date-time", - "title": "When history was recorded or last updated", + "enum_reference_types": [ + "Patient" + ], + "title": "Who this is about", "type": "string" }, - "deceasedAge": { - "description": "[Text representation of Age] Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "resourceType": { + "const": "BodyStructure", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + } + }, + "systemProperties": [ + "id" + ], + "title": "BodyStructure", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "specimen.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Biospecimen", + "description": "Sample for analysis. A sample to be used for analysis. [See https://hl7.org/fhir/R5/Specimen.html]", + "id": "specimen", + "links": [ + { + "backref": "specimen", + "label": "Specimen_subject_Patient_specimen", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" + }, + { + "backref": "specimen", + "label": "Specimen_subject_Substance_specimen", + "multiplicity": "many_to_many", + "name": "subject_Substance", + "required": false, + "target_type": "substance" + }, + { + "backref": "parent_specimen", + "label": "Specimen_parent_Specimen_parent_specimen", + "multiplicity": "many_to_many", + "name": "parent", + "required": false, + "target_type": "specimen" + }, + { + "backref": "specimen", + "label": "Specimen_bodySite_BodyStructure_specimen", + "multiplicity": "many_to_many", + "name": "bodySite", + "required": false, + "target_type": "body_structure" + } + ], + "program": "*", + "project": "*", + "properties": { + "accessionIdentifier": { + "description": "[Text representation of Identifier] The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.", "element_property": true, - "one_of_many": "deceased", - "one_of_many_required": false, - "title": "Dead? How old/when?", + "title": "Identifier assigned by the lab", "type": "string" }, - "deceasedBoolean": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "bodySite": { + "backref": "specimen", + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "text representation. Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", "element_property": true, - "one_of_many": "deceased", - "one_of_many_required": false, - "title": "Dead? How old/when?", - "type": "boolean" + "enum_reference_types": [ + "BodyStructure" + ], + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Anatomical collection site", + "type": "string" }, - "deceasedDate": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "bodySite_coding": { + "backref": "specimen", + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", "element_property": true, - "format": "date", - "one_of_many": "deceased", - "one_of_many_required": false, - "title": "Dead? How old/when?", + "enum_reference_types": [ + "BodyStructure" + ], + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Anatomical collection site", + "type": "string" + }, + "bodySite_text": { + "backref": "specimen", + "binding_description": "SNOMED CT Body site concepts", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_version": null, + "description": "[system#code representation.] Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", + "element_property": true, + "enum_reference_types": [ + "BodyStructure" + ], + "term": { + "description": "SNOMED CT Body site concepts", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/body-site", + "term_url": "http://hl7.org/fhir/ValueSet/body-site" + } + }, + "title": "Anatomical collection site", "type": "string" }, - "deceasedRange": { - "description": "[Text representation of Range] Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "collection": { + "description": "[Text representation of SpecimenCollection] Details concerning the specimen collection.", "element_property": true, - "one_of_many": "deceased", - "one_of_many_required": false, - "title": "Dead? How old/when?", + "title": "Collection details", "type": "string" }, - "deceasedString": { - "description": "Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.", + "combined": { + "binding_description": "Codes for the combined status of a specimen.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-combined", + "binding_version": "5.0.0", + "description": "This element signifies if the specimen is part of a group or pooled.", "element_property": true, - "one_of_many": "deceased", - "one_of_many_required": false, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "Dead? How old/when?", + "enum_values": [ + "grouped", + "pooled" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "grouped | pooled", "type": "string" }, - "estimatedAge": { - "description": "If true, indicates that the age value specified is an estimated value.", - "element_property": true, - "title": "Age is estimated?", - "type": "boolean" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", + "condition": { + "binding_description": "Codes describing the state of the specimen.", + "binding_strength": "extensible", + "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0493", + "binding_version": null, + "description": "text representation. A mode or state of being that describes the nature of the specimen.", "element_property": true, "items": { "type": "string" }, - "title": "Additional content defined by implementations", + "term": { + "description": "Codes describing the state of the specimen.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v2-0493", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://terminology.hl7.org/ValueSet/v2-0493", + "term_url": "http://terminology.hl7.org/ValueSet/v2-0493" + } + }, + "title": "State of the specimen", "type": "array" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", - "type": "string" - }, - "identifier": { - "description": "Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "condition_coding": { + "binding_description": "Codes describing the state of the specimen.", + "binding_strength": "extensible", + "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0493", + "binding_version": null, + "description": "[system#code representation.] A mode or state of being that describes the nature of the specimen.", "element_property": true, "items": { "type": "string" }, - "title": "External Id(s) for this record", + "term": { + "description": "Codes describing the state of the specimen.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v2-0493", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://terminology.hl7.org/ValueSet/v2-0493", + "term_url": "http://terminology.hl7.org/ValueSet/v2-0493" + } + }, + "title": "State of the specimen", "type": "array" }, - "identifier_coding": { - "description": "[system#code representation of identifier] Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "condition_text": { + "binding_description": "Codes describing the state of the specimen.", + "binding_strength": "extensible", + "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0493", + "binding_version": null, + "description": "[system#code representation.] A mode or state of being that describes the nature of the specimen.", "element_property": true, "items": { "type": "string" }, - "title": "External Id(s) for this record", + "term": { + "description": "Codes describing the state of the specimen.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v2-0493", + "cde_version": null, + "source": "fhir", + "strength": "extensible", + "term": "http://terminology.hl7.org/ValueSet/v2-0493", + "term_url": "http://terminology.hl7.org/ValueSet/v2-0493" + } + }, + "title": "State of the specimen", "type": "array" }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.", + "container": { + "description": "[Text representation of SpecimenContainer] The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.", "element_property": true, "items": { "type": "string" }, - "title": "External Id(s) for this record", + "title": "Direct container of specimen (tube/slide, etc.)", "type": "array" }, - "instantiatesCanonical": { - "description": "The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, - "enum_reference_types": [ - "PlanDefinition", - "Questionnaire", - "ActivityDefinition", - "Measure", - "OperationDefinition" - ], "items": { - "pattern": "\\S*", "type": "string" }, - "title": "Instantiates FHIR protocol or definition", + "title": "Additional content defined by implementations", "type": "array" }, - "instantiatesUri": { - "description": "The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.", + "feature": { + "description": "[Text representation of SpecimenFeature] A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).", "element_property": true, "items": { - "pattern": "\\S*", "type": "string" }, - "title": "Instantiates external protocol or definition", + "title": "The physical feature of a specimen", "type": "array" }, - "name": { - "description": "This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\".", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, - "pattern": "[ \\r\\n\\t\\S]+", - "title": "The family member described", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", "type": "string" }, - "note": { - "description": "[Text representation of Annotation] This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.", + "identifier": { + "description": "Id for specimen.", "element_property": true, "items": { "type": "string" }, - "title": "General note about related person", + "title": "External Identifier", "type": "array" }, - "participant": { - "description": "[Text representation of FamilyMemberHistoryParticipant] Indicates who or what participated in the activities related to the family member history and how they were involved.", + "identifier_coding": { + "description": "[system#code representation of identifier] Id for specimen.", "element_property": true, "items": { "type": "string" }, - "title": "Who or what participated in the activities related to the family member history and how they were involved", + "title": "External Identifier", "type": "array" }, - "patient": { - "backref": "family_member_history", - "description": "[Text representation of Reference] The person who this history concerns.", - "element_property": true, - "enum_reference_types": [ - "Patient" - ], - "title": "Patient history is about", - "type": "string" - }, - "procedure": { - "description": "[Text representation of FamilyMemberHistoryProcedure] The significant Procedures (or procedure) that the family member had. This is a repeating section to allow a system to represent more than one procedure per resource, though there is nothing stopping multiple resources - one per procedure.", + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Id for specimen.", "element_property": true, "items": { "type": "string" }, - "title": "Procedures that the related person had", + "title": "External Identifier", "type": "array" }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" - }, - "type": "string" - }, - "reason": { - "backref": "reason_family_member_history", - "binding_description": "Codes indicating why the family member history was done.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", - "binding_version": null, - "description": "text representation. Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", + "note": { + "description": "[Text representation of Annotation] To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).", "element_property": true, - "enum_reference_types": [ - "Condition", - "Observation", - "AllergyIntolerance", - "QuestionnaireResponse", - "DiagnosticReport", - "DocumentReference" - ], "items": { "type": "string" }, - "term": { - "description": "Codes indicating why the family member history was done.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/clinical-findings", - "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" - } - }, - "title": "Why was family member history performed?", + "title": "Comments", "type": "array" }, - "reason_coding": { - "backref": "reason_family_member_history", - "binding_description": "Codes indicating why the family member history was done.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", - "binding_version": null, - "description": "[system#code representation.] Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", + "parent": { + "backref": "parent_specimen", + "description": "[Text representation of Reference] Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.", "element_property": true, "enum_reference_types": [ - "Condition", - "Observation", - "AllergyIntolerance", - "QuestionnaireResponse", - "DiagnosticReport", - "DocumentReference" + "Specimen" ], "items": { "type": "string" }, - "term": { - "description": "Codes indicating why the family member history was done.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/clinical-findings", - "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" - } + "title": "Specimen from which this specimen originated", + "type": "array" + }, + "patient_identifier": { + "description": "Denormalized patient identifier", + "items": { + "type": "string" }, - "title": "Why was family member history performed?", "type": "array" }, - "reason_text": { - "backref": "reason_family_member_history", - "binding_description": "Codes indicating why the family member history was done.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/clinical-findings", - "binding_version": null, - "description": "[system#code representation.] Describes why the family member history occurred in coded or textual form, or Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.", + "processing_additive": { + "backref": "additive_specimen_processing", + "description": "[Text representation of Reference] [Plucked from Specimen.processing] Material used in the processing step", "element_property": true, "enum_reference_types": [ - "Condition", - "Observation", - "AllergyIntolerance", - "QuestionnaireResponse", - "DiagnosticReport", - "DocumentReference" + "Substance" ], "items": { "type": "string" }, - "term": { - "description": "Codes indicating why the family member history was done.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/clinical-findings", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/clinical-findings", - "term_url": "http://hl7.org/fhir/ValueSet/clinical-findings" - } - }, - "title": "Why was family member history performed?", + "title": "Material used in the processing step", "type": "array" }, - "relationship": { - "binding_description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "processing_method": { + "binding_description": "Type indicating the technique used to process the specimen.", "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-processing-method", "binding_version": null, - "description": "text representation. The type of relationship this person has to the patient (father, mother, brother etc.).", + "description": "text representation. [Plucked from Specimen.processing] A coded value specifying the method used to process the specimen.", "element_property": true, "term": { - "description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "description": "Type indicating the technique used to process the specimen.", "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "cde_id": "http://hl7.org/fhir/ValueSet/specimen-processing-method", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", - "term_url": "http://terminology.hl7.org/ValueSet/v3-FamilyMember" + "term": "http://hl7.org/fhir/ValueSet/specimen-processing-method", + "term_url": "http://hl7.org/fhir/ValueSet/specimen-processing-method" } }, - "title": "Relationship to the subject", + "title": "Indicates the treatment step applied to the specimen", "type": "string" }, - "relationship_coding": { - "binding_description": "The nature of the relationship between the patient and the related person being described in the family member history.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "receivedTime": { + "description": "Time when specimen is received by the testing laboratory for processing or testing.", + "element_property": true, + "format": "date-time", + "title": "The time when specimen is received by the testing laboratory", + "type": "string" + }, + "request": { + "backref": "request_specimen", + "description": "[Text representation of Reference] Details concerning a service request that required a specimen to be collected.", + "element_property": true, + "enum_reference_types": [ + "ServiceRequest" + ], + "items": { + "type": "string" + }, + "title": "Why the specimen was collected", + "type": "array" + }, + "resourceType": { + "const": "Specimen", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "role": { + "binding_description": "Codes describing specimen role.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-role", "binding_version": null, - "description": "[system#code representation.] The type of relationship this person has to the patient (father, mother, brother etc.).", + "description": "text representation. The role or reason for the specimen in the testing workflow.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "description": "Codes describing specimen role.", "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "cde_id": "http://hl7.org/fhir/ValueSet/specimen-role", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", - "term_url": "http://terminology.hl7.org/ValueSet/v3-FamilyMember" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/specimen-role", + "term_url": "http://hl7.org/fhir/ValueSet/specimen-role" } }, - "title": "Relationship to the subject", - "type": "string" + "title": "The role the specimen serves", + "type": "array" }, - "relationship_text": { - "binding_description": "The nature of the relationship between the patient and the related person being described in the family member history.", - "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "role_coding": { + "binding_description": "Codes describing specimen role.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-role", "binding_version": null, - "description": "[system#code representation.] The type of relationship this person has to the patient (father, mother, brother etc.).", + "description": "[system#code representation.] The role or reason for the specimen in the testing workflow.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The nature of the relationship between the patient and the related person being described in the family member history.", + "description": "Codes describing specimen role.", "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", + "cde_id": "http://hl7.org/fhir/ValueSet/specimen-role", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v3-FamilyMember", - "term_url": "http://terminology.hl7.org/ValueSet/v3-FamilyMember" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/specimen-role", + "term_url": "http://hl7.org/fhir/ValueSet/specimen-role" } }, - "title": "Relationship to the subject", - "type": "string" - }, - "resourceType": { - "const": "FamilyMemberHistory", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", - "type": "string" + "title": "The role the specimen serves", + "type": "array" }, - "sex": { - "binding_description": "Codes describing the sex assigned at birth as documented on the birth registration.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "role_text": { + "binding_description": "Codes describing specimen role.", + "binding_strength": "preferred", + "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-role", "binding_version": null, - "description": "text representation. The birth sex of the family member.", + "description": "[system#code representation.] The role or reason for the specimen in the testing workflow.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "description": "Codes describing specimen role.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/administrative-gender", + "cde_id": "http://hl7.org/fhir/ValueSet/specimen-role", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/administrative-gender", - "term_url": "http://hl7.org/fhir/ValueSet/administrative-gender" + "strength": "preferred", + "term": "http://hl7.org/fhir/ValueSet/specimen-role", + "term_url": "http://hl7.org/fhir/ValueSet/specimen-role" } }, - "title": "male | female | other | unknown", + "title": "The role the specimen serves", + "type": "array" + }, + "status": { + "binding_description": "Codes providing the status/availability of a specimen.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-status", + "binding_version": "5.0.0", + "description": "The availability of the specimen.", + "element_property": true, + "enum_values": [ + "available", + "unavailable", + "unsatisfactory", + "entered-in-error" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "available | unavailable | unsatisfactory | entered-in-error", "type": "string" }, - "sex_coding": { - "binding_description": "Codes describing the sex assigned at birth as documented on the birth registration.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "subject": { + "backref": "specimen", + "description": "[Text representation of Reference] Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group", + "Device", + "BiologicallyDerivedProduct", + "Substance", + "Location" + ], + "title": "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device", + "type": "string" + }, + "type": { + "binding_description": "The type of the specimen.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0487", "binding_version": null, - "description": "[system#code representation.] The birth sex of the family member.", + "description": "text representation. The kind of material that forms the specimen.", "element_property": true, "term": { - "description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "description": "The type of the specimen.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/administrative-gender", + "cde_id": "http://terminology.hl7.org/ValueSet/v2-0487", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/administrative-gender", - "term_url": "http://hl7.org/fhir/ValueSet/administrative-gender" + "strength": "example", + "term": "http://terminology.hl7.org/ValueSet/v2-0487", + "term_url": "http://terminology.hl7.org/ValueSet/v2-0487" } }, - "title": "male | female | other | unknown", + "title": "Kind of material that forms the specimen", "type": "string" }, - "sex_text": { - "binding_description": "Codes describing the sex assigned at birth as documented on the birth registration.", - "binding_strength": "extensible", - "binding_uri": "http://hl7.org/fhir/ValueSet/administrative-gender", + "type_coding": { + "binding_description": "The type of the specimen.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0487", "binding_version": null, - "description": "[system#code representation.] The birth sex of the family member.", + "description": "[system#code representation.] The kind of material that forms the specimen.", "element_property": true, "term": { - "description": "Codes describing the sex assigned at birth as documented on the birth registration.", + "description": "The type of the specimen.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/administrative-gender", + "cde_id": "http://terminology.hl7.org/ValueSet/v2-0487", "cde_version": null, "source": "fhir", - "strength": "extensible", - "term": "http://hl7.org/fhir/ValueSet/administrative-gender", - "term_url": "http://hl7.org/fhir/ValueSet/administrative-gender" + "strength": "example", + "term": "http://terminology.hl7.org/ValueSet/v2-0487", + "term_url": "http://terminology.hl7.org/ValueSet/v2-0487" } }, - "title": "male | female | other | unknown", + "title": "Kind of material that forms the specimen", "type": "string" }, - "status": { - "binding_description": "A code that identifies the status of the family history record.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/history-status", - "binding_version": "5.0.0", - "description": "A code specifying the status of the record of the family history of a specific family member.", - "element_property": true, - "element_required": true, - "enum_values": [ - "partial", - "completed", - "entered-in-error", - "health-unknown" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "partial | completed | entered-in-error | health-unknown", + "type_text": { + "binding_description": "The type of the specimen.", + "binding_strength": "example", + "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0487", + "binding_version": null, + "description": "[system#code representation.] The kind of material that forms the specimen.", + "element_property": true, + "term": { + "description": "The type of the specimen.", + "termDef": { + "cde_id": "http://terminology.hl7.org/ValueSet/v2-0487", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://terminology.hl7.org/ValueSet/v2-0487", + "term_url": "http://terminology.hl7.org/ValueSet/v2-0487" + } + }, + "title": "Kind of material that forms the specimen", "type": "string" } }, "systemProperties": [ "id" ], - "title": "FamilyMemberHistory", + "title": "Specimen", "type": "object", "uniqueKeys": [ [ @@ -8589,222 +11964,184 @@ ] ] }, - "specimen.yaml": { + "medication_administration.yaml": { "$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, - "category": "Biospecimen", - "description": "Sample for analysis. A sample to be used for analysis. [See https://hl7.org/fhir/R5/Specimen.html]", - "id": "specimen", + "category": "Clinical", + "description": "Administration of medication to a patient. Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. [See https://hl7.org/fhir/R5/MedicationAdministration.html]", + "id": "medication_administration", "links": [ { - "backref": "specimen", - "label": "Specimen_subject_Patient_specimen", + "backref": "medication_administration", + "label": "MedicationAdministration_subject_Patient_medication_administration", "multiplicity": "many_to_many", "name": "subject_Patient", "required": false, "target_type": "patient" }, { - "backref": "specimen", - "label": "Specimen_subject_Substance_specimen", - "multiplicity": "many_to_many", - "name": "subject_Substance", - "required": false, - "target_type": "substance" - }, - { - "backref": "parent_specimen", - "label": "Specimen_parent_Specimen_parent_specimen", + "backref": "medication_administration", + "label": "MedicationAdministration_medication_Medication_medication_administration", "multiplicity": "many_to_many", - "name": "parent", + "name": "medication", "required": false, - "target_type": "specimen" + "target_type": "medication" } ], "program": "*", "project": "*", "properties": { - "accessionIdentifier": { - "description": "[Text representation of Identifier] The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.", + "basedOn": { + "backref": "basedOn_medication_administration", + "description": "[Text representation of Reference] A plan that is fulfilled in whole or in part by this MedicationAdministration.", "element_property": true, - "title": "Identifier assigned by the lab", - "type": "string" + "enum_reference_types": [ + "CarePlan" + ], + "items": { + "type": "string" + }, + "title": "Plan this is fulfilled by this administration", + "type": "array" }, - "bodySite": { - "backref": "specimen", - "binding_description": "SNOMED CT Body site concepts", + "category": { + "binding_description": "A coded concept describing where the medication administered is expected to occur.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-location", "binding_version": null, - "description": "text representation. Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", + "description": "text representation. The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).", "element_property": true, - "enum_reference_types": [ - "BodyStructure" - ], + "items": { + "type": "string" + }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "A coded concept describing where the medication administered is expected to occur.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-admin-location", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "term_url": "http://hl7.org/fhir/ValueSet/medication-admin-location" } }, - "title": "Anatomical collection site", - "type": "string" + "title": "Type of medication administration", + "type": "array" }, - "bodySite_coding": { - "backref": "specimen", - "binding_description": "SNOMED CT Body site concepts", + "category_coding": { + "binding_description": "A coded concept describing where the medication administered is expected to occur.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-location", "binding_version": null, - "description": "[system#code representation.] Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", + "description": "[system#code representation.] The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).", "element_property": true, - "enum_reference_types": [ - "BodyStructure" - ], + "items": { + "type": "string" + }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "A coded concept describing where the medication administered is expected to occur.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-admin-location", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "term_url": "http://hl7.org/fhir/ValueSet/medication-admin-location" } }, - "title": "Anatomical collection site", - "type": "string" + "title": "Type of medication administration", + "type": "array" }, - "bodySite_text": { - "backref": "specimen", - "binding_description": "SNOMED CT Body site concepts", + "category_text": { + "binding_description": "A coded concept describing where the medication administered is expected to occur.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/body-site", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-location", "binding_version": null, - "description": "[system#code representation.] Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.", + "description": "[system#code representation.] The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).", "element_property": true, - "enum_reference_types": [ - "BodyStructure" - ], + "items": { + "type": "string" + }, "term": { - "description": "SNOMED CT Body site concepts", + "description": "A coded concept describing where the medication administered is expected to occur.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/body-site", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-admin-location", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/body-site", - "term_url": "http://hl7.org/fhir/ValueSet/body-site" + "term": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "term_url": "http://hl7.org/fhir/ValueSet/medication-admin-location" } }, - "title": "Anatomical collection site", - "type": "string" - }, - "collection": { - "description": "[Text representation of SpecimenCollection] Details concerning the specimen collection.", - "element_property": true, - "title": "Collection details", - "type": "string" + "title": "Type of medication administration", + "type": "array" }, - "combined": { - "binding_description": "Codes for the combined status of a specimen.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-combined", - "binding_version": "5.0.0", - "description": "This element signifies if the specimen is part of a group or pooled.", + "device": { + "backref": "device_medication_administration", + "description": "text representation. The device that is to be used for the administration of the medication (for example, PCA Pump).", "element_property": true, - "enum_values": [ - "grouped", - "pooled" + "enum_reference_types": [ + "Device" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "grouped | pooled", - "type": "string" - }, - "condition": { - "binding_description": "Codes describing the state of the specimen.", - "binding_strength": "extensible", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0493", - "binding_version": null, - "description": "text representation. A mode or state of being that describes the nature of the specimen.", - "element_property": true, "items": { "type": "string" }, - "term": { - "description": "Codes describing the state of the specimen.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v2-0493", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://terminology.hl7.org/ValueSet/v2-0493", - "term_url": "http://terminology.hl7.org/ValueSet/v2-0493" - } - }, - "title": "State of the specimen", + "title": "Device used to administer", "type": "array" }, - "condition_coding": { - "binding_description": "Codes describing the state of the specimen.", - "binding_strength": "extensible", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0493", - "binding_version": null, - "description": "[system#code representation.] A mode or state of being that describes the nature of the specimen.", + "device_coding": { + "backref": "device_medication_administration", + "description": "[system#code representation.] The device that is to be used for the administration of the medication (for example, PCA Pump).", "element_property": true, + "enum_reference_types": [ + "Device" + ], "items": { "type": "string" }, - "term": { - "description": "Codes describing the state of the specimen.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v2-0493", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://terminology.hl7.org/ValueSet/v2-0493", - "term_url": "http://terminology.hl7.org/ValueSet/v2-0493" - } - }, - "title": "State of the specimen", + "title": "Device used to administer", "type": "array" }, - "condition_text": { - "binding_description": "Codes describing the state of the specimen.", - "binding_strength": "extensible", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0493", - "binding_version": null, - "description": "[system#code representation.] A mode or state of being that describes the nature of the specimen.", + "device_text": { + "backref": "device_medication_administration", + "description": "[system#code representation.] The device that is to be used for the administration of the medication (for example, PCA Pump).", "element_property": true, + "enum_reference_types": [ + "Device" + ], "items": { "type": "string" }, - "term": { - "description": "Codes describing the state of the specimen.", - "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v2-0493", - "cde_version": null, - "source": "fhir", - "strength": "extensible", - "term": "http://terminology.hl7.org/ValueSet/v2-0493", - "term_url": "http://terminology.hl7.org/ValueSet/v2-0493" - } - }, - "title": "State of the specimen", + "title": "Device used to administer", "type": "array" }, - "container": { - "description": "[Text representation of SpecimenContainer] The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.", + "dosage": { + "description": "[Text representation of MedicationAdministrationDosage] Describes the medication dosage information details e.g. dose, rate, site, route, etc.", + "element_property": true, + "title": "Details of how medication was taken", + "type": "string" + }, + "encounter": { + "backref": "medication_administration", + "description": "[Text representation of Reference] The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.", + "element_property": true, + "enum_reference_types": [ + "Encounter" + ], + "title": "Encounter administered as part of", + "type": "string" + }, + "eventHistory": { + "backref": "eventHistory_medication_administration", + "description": "[Text representation of Reference] A summary of the events of interest that have occurred, such as when the administration was verified.", "element_property": true, + "enum_reference_types": [ + "Provenance" + ], "items": { "type": "string" }, - "title": "Direct container of specimen (tube/slide, etc.)", + "title": "A list of events of interest in the lifecycle", "type": "array" }, "extension": { @@ -8816,15 +12153,6 @@ "title": "Additional content defined by implementations", "type": "array" }, - "feature": { - "description": "[Text representation of SpecimenFeature] A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).", - "element_property": true, - "items": { - "type": "string" - }, - "title": "The physical feature of a specimen", - "type": "array" - }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, @@ -8835,1278 +12163,1351 @@ "type": "string" }, "identifier": { - "description": "Id for specimen.", + "description": "Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", "element_property": true, "items": { "type": "string" }, - "title": "External Identifier", + "title": "External identifier", "type": "array" }, "identifier_coding": { - "description": "[system#code representation of identifier] Id for specimen.", + "description": "[system#code representation of identifier] Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", "element_property": true, "items": { "type": "string" }, - "title": "External Identifier", + "title": "External identifier", "type": "array" }, "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Id for specimen.", + "description": "[system#code representation of identifier.text] Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", "element_property": true, "items": { "type": "string" }, - "title": "External Identifier", + "title": "External identifier", "type": "array" }, + "isSubPotent": { + "description": "An indication that the full dose was not administered.", + "element_property": true, + "title": "Full dose was not administered", + "type": "boolean" + }, + "medication": { + "backref": "medication_administration", + "binding_description": "Codes identifying substance or product that can be administered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_version": null, + "description": "text representation. Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", + "element_property": true, + "enum_reference_types": [ + "Medication" + ], + "term": { + "description": "Codes identifying substance or product that can be administered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + } + }, + "title": "What was administered", + "type": "string" + }, + "medication_coding": { + "backref": "medication_administration", + "binding_description": "Codes identifying substance or product that can be administered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_version": null, + "description": "[system#code representation.] Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", + "element_property": true, + "enum_reference_types": [ + "Medication" + ], + "term": { + "description": "Codes identifying substance or product that can be administered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + } + }, + "title": "What was administered", + "type": "string" + }, + "medication_text": { + "backref": "medication_administration", + "binding_description": "Codes identifying substance or product that can be administered.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_version": null, + "description": "[system#code representation.] Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", + "element_property": true, + "enum_reference_types": [ + "Medication" + ], + "term": { + "description": "Codes identifying substance or product that can be administered.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + } + }, + "title": "What was administered", + "type": "string" + }, "note": { - "description": "[Text representation of Annotation] To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).", + "description": "[Text representation of Annotation] Extra information about the medication administration that is not conveyed by the other attributes.", "element_property": true, "items": { "type": "string" }, - "title": "Comments", + "title": "Information about the administration", "type": "array" }, - "parent": { - "backref": "parent_specimen", - "description": "[Text representation of Reference] Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.", + "occurenceDateTime": { + "description": "A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", + "element_property": true, + "format": "date-time", + "one_of_many": "occurence", + "one_of_many_required": true, + "title": "Specific date/time or interval of time during which the administration took place (or did not take place)", + "type": "string" + }, + "occurencePeriod": { + "description": "[Text representation of Period] A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", + "element_property": true, + "one_of_many": "occurence", + "one_of_many_required": true, + "title": "Specific date/time or interval of time during which the administration took place (or did not take place)", + "type": "string" + }, + "occurenceTiming": { + "description": "[Text representation of Timing] A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", + "element_property": true, + "one_of_many": "occurence", + "one_of_many_required": true, + "title": "Specific date/time or interval of time during which the administration took place (or did not take place)", + "type": "string" + }, + "partOf": { + "backref": "partOf_medication_administration", + "description": "[Text representation of Reference] A larger event of which this particular event is a component or step.", "element_property": true, "enum_reference_types": [ - "Specimen" + "MedicationAdministration", + "Procedure", + "MedicationDispense" ], "items": { "type": "string" }, - "title": "Specimen from which this specimen originated", + "title": "Part of referenced event", "type": "array" }, - "processing_additive": { - "backref": "additive_specimen_processing", - "description": "[Text representation of Reference] [Plucked from Specimen.processing] Material used in the processing step", + "performer": { + "description": "[Text representation of MedicationAdministrationPerformer] The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.", + "element_property": true, + "items": { + "type": "string" + }, + "title": "Who or what performed the medication administration and what type of performance they did", + "type": "array" + }, + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, + "type": "string" + }, + "reason": { + "backref": "reason_medication_administration", + "binding_description": "A set of codes indicating the reason why the MedicationAdministration was made.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "binding_version": null, + "description": "text representation. A code, Condition or observation that supports why the medication was administered.", "element_property": true, "enum_reference_types": [ - "Substance" + "Condition", + "Observation", + "DiagnosticReport" ], "items": { "type": "string" }, - "title": "Material used in the processing step", + "term": { + "description": "A set of codes indicating the reason why the MedicationAdministration was made.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes" + } + }, + "title": "Concept, condition or observation that supports why the medication was administered", "type": "array" }, - "processing_method": { - "binding_description": "Type indicating the technique used to process the specimen.", + "reason_coding": { + "backref": "reason_medication_administration", + "binding_description": "A set of codes indicating the reason why the MedicationAdministration was made.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-processing-method", + "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", "binding_version": null, - "description": "text representation. [Plucked from Specimen.processing] A coded value specifying the method used to process the specimen.", + "description": "[system#code representation.] A code, Condition or observation that supports why the medication was administered.", "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "DiagnosticReport" + ], + "items": { + "type": "string" + }, "term": { - "description": "Type indicating the technique used to process the specimen.", + "description": "A set of codes indicating the reason why the MedicationAdministration was made.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/specimen-processing-method", + "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/specimen-processing-method", - "term_url": "http://hl7.org/fhir/ValueSet/specimen-processing-method" + "term": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes" } }, - "title": "Indicates the treatment step applied to the specimen", - "type": "string" + "title": "Concept, condition or observation that supports why the medication was administered", + "type": "array" }, - "project_id": { + "reason_text": { + "backref": "reason_medication_administration", + "binding_description": "A set of codes indicating the reason why the MedicationAdministration was made.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "binding_version": null, + "description": "[system#code representation.] A code, Condition or observation that supports why the medication was administered.", + "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "DiagnosticReport" + ], + "items": { + "type": "string" + }, "term": { - "$ref": "_terms.yaml#/project_id" + "description": "A set of codes indicating the reason why the MedicationAdministration was made.", + "termDef": { + "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "cde_version": null, + "source": "fhir", + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes" + } }, - "type": "string" + "title": "Concept, condition or observation that supports why the medication was administered", + "type": "array" }, - "receivedTime": { - "description": "Time when specimen is received by the testing laboratory for processing or testing.", + "recorded": { + "description": "The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.", "element_property": true, "format": "date-time", - "title": "The time when specimen is received by the testing laboratory", + "title": "When the MedicationAdministration was first captured in the subject's record", "type": "string" }, - "request": { - "backref": "request_specimen", - "description": "[Text representation of Reference] Details concerning a service request that required a specimen to be collected.", + "request": { + "backref": "medication_administration", + "description": "[Text representation of Reference] The original request, instruction or authority to perform the administration.", "element_property": true, "enum_reference_types": [ - "ServiceRequest" + "MedicationRequest" ], - "items": { - "type": "string" - }, - "title": "Why the specimen was collected", - "type": "array" + "title": "Request administration performed against", + "type": "string" }, "resourceType": { - "const": "Specimen", + "const": "MedicationAdministration", "description": "One of the resource types defined as part of FHIR", "title": "Resource Type", "type": "string" }, - "role": { - "binding_description": "Codes describing specimen role.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-role", + "status": { + "binding_description": "A set of codes indicating the current status of a MedicationAdministration.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-status", + "binding_version": "5.0.0", + "description": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.", + "element_property": true, + "element_required": true, + "enum_values": [ + "in-progress", + "not-done", + "on-hold", + "completed", + "entered-in-error", + "stopped", + "unknown" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown", + "type": "string" + }, + "statusReason": { + "binding_description": "A set of codes indicating the reason why the MedicationAdministration is negated.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", "binding_version": null, - "description": "text representation. The role or reason for the specimen in the testing workflow.", + "description": "text representation. A code indicating why the administration was not performed.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes describing specimen role.", + "description": "A set of codes indicating the reason why the MedicationAdministration is negated.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/specimen-role", + "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/specimen-role", - "term_url": "http://hl7.org/fhir/ValueSet/specimen-role" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", + "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes" } }, - "title": "The role the specimen serves", + "title": "Reason administration not performed", "type": "array" }, - "role_coding": { - "binding_description": "Codes describing specimen role.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-role", + "statusReason_coding": { + "binding_description": "A set of codes indicating the reason why the MedicationAdministration is negated.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", "binding_version": null, - "description": "[system#code representation.] The role or reason for the specimen in the testing workflow.", + "description": "[system#code representation.] A code indicating why the administration was not performed.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes describing specimen role.", + "description": "A set of codes indicating the reason why the MedicationAdministration is negated.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/specimen-role", + "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/specimen-role", - "term_url": "http://hl7.org/fhir/ValueSet/specimen-role" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", + "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes" } }, - "title": "The role the specimen serves", + "title": "Reason administration not performed", "type": "array" }, - "role_text": { - "binding_description": "Codes describing specimen role.", - "binding_strength": "preferred", - "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-role", + "statusReason_text": { + "binding_description": "A set of codes indicating the reason why the MedicationAdministration is negated.", + "binding_strength": "example", + "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", "binding_version": null, - "description": "[system#code representation.] The role or reason for the specimen in the testing workflow.", + "description": "[system#code representation.] A code indicating why the administration was not performed.", "element_property": true, "items": { "type": "string" }, "term": { - "description": "Codes describing specimen role.", + "description": "A set of codes indicating the reason why the MedicationAdministration is negated.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/specimen-role", + "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", "cde_version": null, "source": "fhir", - "strength": "preferred", - "term": "http://hl7.org/fhir/ValueSet/specimen-role", - "term_url": "http://hl7.org/fhir/ValueSet/specimen-role" + "strength": "example", + "term": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", + "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes" } }, - "title": "The role the specimen serves", + "title": "Reason administration not performed", "type": "array" }, - "status": { - "binding_description": "Codes providing the status/availability of a specimen.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/specimen-status", - "binding_version": "5.0.0", - "description": "The availability of the specimen.", - "element_property": true, - "enum_values": [ - "available", - "unavailable", - "unsatisfactory", - "entered-in-error" - ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "available | unavailable | unsatisfactory | entered-in-error", - "type": "string" - }, - "subject": { - "backref": "specimen", - "description": "[Text representation of Reference] Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device", - "element_property": true, - "enum_reference_types": [ - "Patient", - "Group", - "Device", - "BiologicallyDerivedProduct", - "Substance", - "Location" - ], - "title": "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device", - "type": "string" - }, - "type": { - "binding_description": "The type of the specimen.", + "subPotentReason": { + "binding_description": null, "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0487", + "binding_uri": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", "binding_version": null, - "description": "text representation. The kind of material that forms the specimen.", + "description": "text representation. The reason or reasons why the full dose was not administered.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The type of the specimen.", + "description": null, "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v2-0487", + "cde_id": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v2-0487", - "term_url": "http://terminology.hl7.org/ValueSet/v2-0487" + "term": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason" } }, - "title": "Kind of material that forms the specimen", - "type": "string" + "title": "Reason full dose was not administered", + "type": "array" }, - "type_coding": { - "binding_description": "The type of the specimen.", + "subPotentReason_coding": { + "binding_description": null, "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0487", + "binding_uri": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", "binding_version": null, - "description": "[system#code representation.] The kind of material that forms the specimen.", + "description": "[system#code representation.] The reason or reasons why the full dose was not administered.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The type of the specimen.", + "description": null, "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v2-0487", + "cde_id": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v2-0487", - "term_url": "http://terminology.hl7.org/ValueSet/v2-0487" + "term": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason" } }, - "title": "Kind of material that forms the specimen", - "type": "string" + "title": "Reason full dose was not administered", + "type": "array" }, - "type_text": { - "binding_description": "The type of the specimen.", + "subPotentReason_text": { + "binding_description": null, "binding_strength": "example", - "binding_uri": "http://terminology.hl7.org/ValueSet/v2-0487", + "binding_uri": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", "binding_version": null, - "description": "[system#code representation.] The kind of material that forms the specimen.", + "description": "[system#code representation.] The reason or reasons why the full dose was not administered.", "element_property": true, + "items": { + "type": "string" + }, "term": { - "description": "The type of the specimen.", + "description": null, "termDef": { - "cde_id": "http://terminology.hl7.org/ValueSet/v2-0487", + "cde_id": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://terminology.hl7.org/ValueSet/v2-0487", - "term_url": "http://terminology.hl7.org/ValueSet/v2-0487" + "term": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "term_url": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason" } }, - "title": "Kind of material that forms the specimen", + "title": "Reason full dose was not administered", + "type": "array" + }, + "subject": { + "backref": "medication_administration", + "description": "[Text representation of Reference] The person or animal or group receiving the medication.", + "element_property": true, + "enum_reference_types": [ + "Patient", + "Group" + ], + "title": "Who received medication", "type": "string" + }, + "supportingInformation": { + "backref": "supportingInformation_medication_administration", + "description": "[Text representation of Reference] Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says \"give \"x\" if the heartrate exceeds \"y\"\", then the heart rate can be included using this attribute.", + "element_property": true, + "enum_reference_types": [ + "Resource" + ], + "items": { + "type": "string" + }, + "title": "Additional information to support administration", + "type": "array" } }, "systemProperties": [ "id" ], - "title": "Specimen", + "title": "MedicationAdministration", "type": "object", "uniqueKeys": [ [ "id" ] - ] - }, - "medication_administration.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": true, - "category": "Clinical", - "description": "Administration of medication to a patient. Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner. [See https://hl7.org/fhir/R5/MedicationAdministration.html]", - "id": "medication_administration", - "links": [ - { - "backref": "medication_administration", - "label": "MedicationAdministration_subject_Patient_medication_administration", - "multiplicity": "many_to_many", - "name": "subject_Patient", - "required": false, - "target_type": "patient" - }, - { - "backref": "medication_administration", - "label": "MedicationAdministration_medication_Medication_medication_administration", - "multiplicity": "many_to_many", - "name": "medication", - "required": false, - "target_type": "medication" - }, - { - "backref": "partOf_medication_administration", - "label": "MedicationAdministration_partOf_MedicationAdministration_partOf_medication_administration", - "multiplicity": "many_to_many", - "name": "partOf_MedicationAdministration", - "required": false, - "target_type": "medication_administration" - }, + ] + }, + "medication.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Clinical", + "description": "Definition of a Medication. This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. [See https://hl7.org/fhir/R5/Medication.html]", + "id": "medication", + "links": [ { - "backref": "reason_medication_administration", - "label": "MedicationAdministration_reason_Condition_reason_medication_administration", + "backref": "medication", + "label": "Medication_marketingAuthorizationHolder_Organization_medication", "multiplicity": "many_to_many", - "name": "reason_Condition", + "name": "marketingAuthorizationHolder", "required": false, - "target_type": "condition" + "target_type": "organization" }, { - "backref": "reason_medication_administration", - "label": "MedicationAdministration_reason_Observation_reason_medication_administration", + "backref": "medication_ingredient", + "label": "Medication_ingredient_item_Substance_medication_ingredient", "multiplicity": "many_to_many", - "name": "reason_Observation", + "name": "ingredient_item_Substance", "required": false, - "target_type": "observation" + "target_type": "substance" }, { - "backref": "medication_administration", - "label": "MedicationAdministration_request_MedicationRequest_medication_administration", + "backref": "medication_ingredient", + "label": "Medication_ingredient_item_Medication_medication_ingredient", "multiplicity": "many_to_many", - "name": "request", + "name": "ingredient_item_Medication", "required": false, - "target_type": "medication_request" + "target_type": "medication" } ], "program": "*", "project": "*", "properties": { - "basedOn": { - "backref": "basedOn_medication_administration", - "description": "[Text representation of Reference] A plan that is fulfilled in whole or in part by this MedicationAdministration.", + "batch": { + "description": "[Text representation of MedicationBatch] Information that only applies to packages (not products).", "element_property": true, - "enum_reference_types": [ - "CarePlan" - ], - "items": { - "type": "string" - }, - "title": "Plan this is fulfilled by this administration", - "type": "array" + "title": "Details about packaged medications", + "type": "string" }, - "category": { - "binding_description": "A coded concept describing where the medication administered is expected to occur.", + "code": { + "binding_description": "A coded concept that defines the type of a medication.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", "binding_version": null, - "description": "text representation. The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).", + "description": "text representation. A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A coded concept describing where the medication administered is expected to occur.", + "description": "A coded concept that defines the type of a medication.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-admin-location", - "term_url": "http://hl7.org/fhir/ValueSet/medication-admin-location" + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" } }, - "title": "Type of medication administration", - "type": "array" + "title": "Codes that identify this medication", + "type": "string" }, - "category_coding": { - "binding_description": "A coded concept describing where the medication administered is expected to occur.", + "code_coding": { + "binding_description": "A coded concept that defines the type of a medication.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", "binding_version": null, - "description": "[system#code representation.] The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).", + "description": "[system#code representation.] A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A coded concept describing where the medication administered is expected to occur.", + "description": "A coded concept that defines the type of a medication.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-admin-location", - "term_url": "http://hl7.org/fhir/ValueSet/medication-admin-location" + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" } }, - "title": "Type of medication administration", - "type": "array" + "title": "Codes that identify this medication", + "type": "string" }, - "category_text": { - "binding_description": "A coded concept describing where the medication administered is expected to occur.", + "code_text": { + "binding_description": "A coded concept that defines the type of a medication.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", "binding_version": null, - "description": "[system#code representation.] The type of medication administration (for example, drug classification like ATC, where meds would be administered, legal category of the medication).", + "description": "[system#code representation.] A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", "element_property": true, - "items": { - "type": "string" - }, "term": { - "description": "A coded concept describing where the medication administered is expected to occur.", + "description": "A coded concept that defines the type of a medication.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-admin-location", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-admin-location", - "term_url": "http://hl7.org/fhir/ValueSet/medication-admin-location" + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" } }, - "title": "Type of medication administration", - "type": "array" - }, - "device": { - "backref": "device_medication_administration", - "description": "text representation. The device that is to be used for the administration of the medication (for example, PCA Pump).", - "element_property": true, - "enum_reference_types": [ - "Device" - ], - "items": { - "type": "string" - }, - "title": "Device used to administer", - "type": "array" - }, - "device_coding": { - "backref": "device_medication_administration", - "description": "[system#code representation.] The device that is to be used for the administration of the medication (for example, PCA Pump).", - "element_property": true, - "enum_reference_types": [ - "Device" - ], - "items": { - "type": "string" - }, - "title": "Device used to administer", - "type": "array" - }, - "device_text": { - "backref": "device_medication_administration", - "description": "[system#code representation.] The device that is to be used for the administration of the medication (for example, PCA Pump).", - "element_property": true, - "enum_reference_types": [ - "Device" - ], - "items": { - "type": "string" - }, - "title": "Device used to administer", - "type": "array" - }, - "dosage": { - "description": "[Text representation of MedicationAdministrationDosage] Describes the medication dosage information details e.g. dose, rate, site, route, etc.", - "element_property": true, - "title": "Details of how medication was taken", - "type": "string" - }, - "encounter": { - "backref": "medication_administration", - "description": "[Text representation of Reference] The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.", - "element_property": true, - "enum_reference_types": [ - "Encounter" - ], - "title": "Encounter administered as part of", + "title": "Codes that identify this medication", "type": "string" }, - "eventHistory": { - "backref": "eventHistory_medication_administration", - "description": "[Text representation of Reference] A summary of the events of interest that have occurred, such as when the administration was verified.", + "definition": { + "backref": "medication", + "description": "[Text representation of Reference] A reference to a knowledge resource that provides more information about this medication.", "element_property": true, "enum_reference_types": [ - "Provenance" + "MedicationKnowledge" ], - "items": { - "type": "string" - }, - "title": "A list of events of interest in the lifecycle", - "type": "array" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Additional content defined by implementations", - "type": "array" - }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", - "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", + "title": "Knowledge about this medication", "type": "string" }, - "identifier": { - "description": "Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "External identifier", - "type": "array" - }, - "identifier_coding": { - "description": "[system#code representation of identifier] Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "External identifier", - "type": "array" - }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "External identifier", - "type": "array" - }, - "isSubPotent": { - "description": "An indication that the full dose was not administered.", - "element_property": true, - "title": "Full dose was not administered", - "type": "boolean" - }, - "medication": { - "backref": "medication_administration", - "binding_description": "Codes identifying substance or product that can be administered.", + "doseForm": { + "binding_description": "A coded concept defining the form of a medication.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-form-codes", "binding_version": null, - "description": "text representation. Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", + "description": "text representation. Describes the form of the item. Powder; tablets; capsule.", "element_property": true, - "enum_reference_types": [ - "Medication" - ], "term": { - "description": "Codes identifying substance or product that can be administered.", + "description": "A coded concept defining the form of a medication.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-form-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + "term": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-form-codes" } }, - "title": "What was administered", + "title": "powder | tablets | capsule +", "type": "string" }, - "medication_coding": { - "backref": "medication_administration", - "binding_description": "Codes identifying substance or product that can be administered.", + "doseForm_coding": { + "binding_description": "A coded concept defining the form of a medication.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-form-codes", "binding_version": null, - "description": "[system#code representation.] Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", + "description": "[system#code representation.] Describes the form of the item. Powder; tablets; capsule.", "element_property": true, - "enum_reference_types": [ - "Medication" - ], "term": { - "description": "Codes identifying substance or product that can be administered.", + "description": "A coded concept defining the form of a medication.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-form-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + "term": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-form-codes" } }, - "title": "What was administered", + "title": "powder | tablets | capsule +", "type": "string" }, - "medication_text": { - "backref": "medication_administration", - "binding_description": "Codes identifying substance or product that can be administered.", + "doseForm_text": { + "binding_description": "A coded concept defining the form of a medication.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-form-codes", "binding_version": null, - "description": "[system#code representation.] Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", + "description": "[system#code representation.] Describes the form of the item. Powder; tablets; capsule.", "element_property": true, - "enum_reference_types": [ - "Medication" - ], "term": { - "description": "Codes identifying substance or product that can be administered.", + "description": "A coded concept defining the form of a medication.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-form-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + "term": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-form-codes" } }, - "title": "What was administered", + "title": "powder | tablets | capsule +", "type": "string" }, - "note": { - "description": "[Text representation of Annotation] Extra information about the medication administration that is not conveyed by the other attributes.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "type": "string" }, - "title": "Information about the administration", + "title": "Additional content defined by implementations", "type": "array" }, - "occurenceDateTime": { - "description": "A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", - "element_property": true, - "format": "date-time", - "one_of_many": "occurence", - "one_of_many_required": true, - "title": "Specific date/time or interval of time during which the administration took place (or did not take place)", - "type": "string" - }, - "occurencePeriod": { - "description": "[Text representation of Period] A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", - "element_property": true, - "one_of_many": "occurence", - "one_of_many_required": true, - "title": "Specific date/time or interval of time during which the administration took place (or did not take place)", - "type": "string" - }, - "occurenceTiming": { - "description": "[Text representation of Timing] A specific date/time or interval of time during which the administration took place (or did not take place). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "element_property": true, - "one_of_many": "occurence", - "one_of_many_required": true, - "title": "Specific date/time or interval of time during which the administration took place (or did not take place)", + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", "type": "string" }, - "partOf": { - "backref": "partOf_medication_administration", - "description": "[Text representation of Reference] A larger event of which this particular event is a component or step.", + "identifier": { + "description": "Business identifier for this medication", "element_property": true, - "enum_reference_types": [ - "MedicationAdministration", - "Procedure", - "MedicationDispense" - ], "items": { "type": "string" }, - "title": "Part of referenced event", + "title": "Business identifier for this medication", "type": "array" }, - "performer": { - "description": "[Text representation of MedicationAdministrationPerformer] The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.", + "identifier_coding": { + "description": "[system#code representation of identifier] Business identifier for this medication", "element_property": true, "items": { "type": "string" }, - "title": "Who or what performed the medication administration and what type of performance they did", + "title": "Business identifier for this medication", "type": "array" }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Business identifier for this medication", + "element_property": true, + "items": { + "type": "string" }, - "type": "string" + "title": "Business identifier for this medication", + "type": "array" }, - "reason": { - "backref": "reason_medication_administration", - "binding_description": "A set of codes indicating the reason why the MedicationAdministration was made.", + "ingredient_item": { + "backref": "medication_ingredient", + "binding_description": null, "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", "binding_version": null, - "description": "text representation. A code, Condition or observation that supports why the medication was administered.", + "description": "text representation. [Plucked from Medication.ingredient] The ingredient (substance or medication) that the ingredient.strength relates to. This is represented as a concept from a code system or described in another resource (Substance or Medication).", "element_property": true, "enum_reference_types": [ - "Condition", - "Observation", - "DiagnosticReport" + "Substance", + "Medication" ], - "items": { - "type": "string" - }, "term": { - "description": "A set of codes indicating the reason why the MedicationAdministration was made.", + "description": null, "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", - "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes" + "term": "http://hl7.org/fhir/ValueSet/medication-codes", + "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" } }, - "title": "Concept, condition or observation that supports why the medication was administered", - "type": "array" + "title": "The ingredient (substance or medication) that the ingredient.strength relates to", + "type": "string" }, - "reason_coding": { - "backref": "reason_medication_administration", - "binding_description": "A set of codes indicating the reason why the MedicationAdministration was made.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", - "binding_version": null, - "description": "[system#code representation.] A code, Condition or observation that supports why the medication was administered.", + "marketingAuthorizationHolder": { + "backref": "medication", + "description": "[Text representation of Reference] The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).", "element_property": true, "enum_reference_types": [ - "Condition", - "Observation", - "DiagnosticReport" + "Organization" ], - "items": { - "type": "string" - }, + "title": "Organization that has authorization to market medication", + "type": "string" + }, + "project_id": { "term": { - "description": "A set of codes indicating the reason why the MedicationAdministration was made.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", - "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes" - } + "$ref": "_terms.yaml#/project_id" }, - "title": "Concept, condition or observation that supports why the medication was administered", - "type": "array" + "type": "string" }, - "reason_text": { - "backref": "reason_medication_administration", - "binding_description": "A set of codes indicating the reason why the MedicationAdministration was made.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", - "binding_version": null, - "description": "[system#code representation.] A code, Condition or observation that supports why the medication was administered.", + "resourceType": { + "const": "Medication", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" + }, + "status": { + "binding_description": "A coded concept defining if the medication is in active use.", + "binding_strength": "required", + "binding_uri": "http://hl7.org/fhir/ValueSet/medication-status", + "binding_version": "5.0.0", + "description": "A code to indicate if the medication is in active use.", + "element_property": true, + "enum_values": [ + "active", + "inactive", + "entered-in-error" + ], + "pattern": "^[^\\s]+(\\s[^\\s]+)*$", + "title": "active | inactive | entered-in-error", + "type": "string" + }, + "totalVolume": { + "description": "[Text representation of Quantity] text representation. When the specified product code does not infer a package size, this is the specific amount of drug in the product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).", + "element_property": true, + "title": "When the specified product code does not infer a package size, this is the specific amount of drug in the product", + "type": "string" + }, + "totalVolume_unit": { + "title": "Unit representation. When the specified product code does not infer a package size, this is the specific amount of drug in the product", + "type": "string" + }, + "totalVolume_value": { + "title": "Numerical value (with implicit precision) representation. When the specified product code does not infer a package size, this is the specific amount of drug in the product", + "type": "number" + } + }, + "systemProperties": [ + "id" + ], + "title": "Medication", + "type": "object", + "uniqueKeys": [ + [ + "id" + ] + ] + }, + "imaging_study.yaml": { + "$schema": "http://json-schema.org/draft-04/schema#", + "additionalProperties": true, + "category": "Clinical", + "description": "A set of images produced in single study (one or more series of references images). Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. [See https://hl7.org/fhir/R5/ImagingStudy.html]", + "id": "imaging_study", + "links": [ + { + "backref": "imaging_study", + "label": "ImagingStudy_subject_Patient_imaging_study", + "multiplicity": "many_to_many", + "name": "subject_Patient", + "required": false, + "target_type": "patient" + }, + { + "backref": "basedOn_imaging_study", + "label": "ImagingStudy_basedOn_Task_basedOn_imaging_study", + "multiplicity": "many_to_many", + "name": "basedOn_Task", + "required": false, + "target_type": "task" + }, + { + "backref": "partOf_imaging_study", + "label": "ImagingStudy_partOf_Procedure_partOf_imaging_study", + "multiplicity": "many_to_many", + "name": "partOf", + "required": false, + "target_type": "procedure" + }, + { + "backref": "reason_imaging_study", + "label": "ImagingStudy_reason_Condition_reason_imaging_study", + "multiplicity": "many_to_many", + "name": "reason_Condition", + "required": false, + "target_type": "condition" + }, + { + "backref": "reason_imaging_study", + "label": "ImagingStudy_reason_Observation_reason_imaging_study", + "multiplicity": "many_to_many", + "name": "reason_Observation", + "required": false, + "target_type": "observation" + }, + { + "backref": "reason_imaging_study", + "label": "ImagingStudy_reason_DiagnosticReport_reason_imaging_study", + "multiplicity": "many_to_many", + "name": "reason_DiagnosticReport", + "required": false, + "target_type": "diagnostic_report" + }, + { + "backref": "reason_imaging_study", + "label": "ImagingStudy_reason_DocumentReference_reason_imaging_study", + "multiplicity": "many_to_many", + "name": "reason_DocumentReference", + "required": false, + "target_type": "document_reference" + }, + { + "backref": "imaging_study", + "label": "ImagingStudy_referrer_Practitioner_imaging_study", + "multiplicity": "many_to_many", + "name": "referrer_Practitioner", + "required": false, + "target_type": "practitioner" + }, + { + "backref": "imaging_study", + "label": "ImagingStudy_referrer_PractitionerRole_imaging_study", + "multiplicity": "many_to_many", + "name": "referrer_PractitionerRole", + "required": false, + "target_type": "practitioner_role" + } + ], + "program": "*", + "project": "*", + "properties": { + "basedOn": { + "backref": "basedOn_imaging_study", + "description": "[Text representation of Reference] A list of the diagnostic requests that resulted in this imaging study being performed.", "element_property": true, "enum_reference_types": [ - "Condition", - "Observation", - "DiagnosticReport" + "CarePlan", + "ServiceRequest", + "Appointment", + "AppointmentResponse", + "Task" ], "items": { "type": "string" }, - "term": { - "description": "A set of codes indicating the reason why the MedicationAdministration was made.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes", - "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes" - } - }, - "title": "Concept, condition or observation that supports why the medication was administered", + "title": "Request fulfilled", "type": "array" }, - "recorded": { - "description": "The date the occurrence of the MedicationAdministration was first captured in the record - potentially significantly after the occurrence of the event.", + "description": { + "description": "The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.", "element_property": true, - "format": "date-time", - "title": "When the MedicationAdministration was first captured in the subject's record", + "pattern": "[ \\r\\n\\t\\S]+", + "title": "Institution-generated description", "type": "string" }, - "request": { - "backref": "medication_administration", - "description": "[Text representation of Reference] The original request, instruction or authority to perform the administration.", + "encounter": { + "backref": "imaging_study", + "description": "[Text representation of Reference] The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.", "element_property": true, "enum_reference_types": [ - "MedicationRequest" + "Encounter" ], - "title": "Request administration performed against", - "type": "string" - }, - "resourceType": { - "const": "MedicationAdministration", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", + "title": "Encounter with which this imaging study is associated", "type": "string" }, - "status": { - "binding_description": "A set of codes indicating the current status of a MedicationAdministration.", - "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-admin-status", - "binding_version": "5.0.0", - "description": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.", + "endpoint": { + "backref": "endpoint_imaging_study", + "description": "[Text representation of Reference] The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.", "element_property": true, - "element_required": true, - "enum_values": [ - "in-progress", - "not-done", - "on-hold", - "completed", - "entered-in-error", - "stopped", - "unknown" + "enum_reference_types": [ + "Endpoint" ], - "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown", - "type": "string" + "items": { + "type": "string" + }, + "title": "Study access endpoint", + "type": "array" }, - "statusReason": { - "binding_description": "A set of codes indicating the reason why the MedicationAdministration is negated.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "binding_version": null, - "description": "text representation. A code indicating why the administration was not performed.", + "extension": { + "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "A set of codes indicating the reason why the MedicationAdministration is negated.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes" - } - }, - "title": "Reason administration not performed", + "title": "Additional content defined by implementations", "type": "array" }, - "statusReason_coding": { - "binding_description": "A set of codes indicating the reason why the MedicationAdministration is negated.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "binding_version": null, - "description": "[system#code representation.] A code indicating why the administration was not performed.", + "id": { + "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "element_property": true, + "maxLength": 64, + "minLength": 1, + "pattern": "^[A-Za-z0-9\\-.]+$", + "title": "Logical id of this artifact", + "type": "string" + }, + "identifier": { + "description": "Identifiers for the ImagingStudy such as DICOM Study Instance UID.", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "A set of codes indicating the reason why the MedicationAdministration is negated.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes" - } - }, - "title": "Reason administration not performed", + "title": "Identifiers for the whole study", "type": "array" }, - "statusReason_text": { - "binding_description": "A set of codes indicating the reason why the MedicationAdministration is negated.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "binding_version": null, - "description": "[system#code representation.] A code indicating why the administration was not performed.", + "identifier_coding": { + "description": "[system#code representation of identifier] Identifiers for the ImagingStudy such as DICOM Study Instance UID.", "element_property": true, "items": { "type": "string" }, - "term": { - "description": "A set of codes indicating the reason why the MedicationAdministration is negated.", - "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "cde_version": null, - "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes", - "term_url": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes" - } + "title": "Identifiers for the whole study", + "type": "array" + }, + "identifier_text_coding": { + "description": "[system#code representation of identifier.text] Identifiers for the ImagingStudy such as DICOM Study Instance UID.", + "element_property": true, + "items": { + "type": "string" }, - "title": "Reason administration not performed", + "title": "Identifiers for the whole study", "type": "array" }, - "subPotentReason": { - "binding_description": null, - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "location": { + "backref": "imaging_study", + "description": "[Text representation of Reference] The principal physical location where the ImagingStudy was performed.", + "element_property": true, + "enum_reference_types": [ + "Location" + ], + "title": "Where ImagingStudy occurred", + "type": "string" + }, + "modality": { + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "binding_version": null, - "description": "text representation. The reason or reasons why the full dose was not administered.", + "description": "text representation. A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.", "element_property": true, "items": { "type": "string" }, "term": { - "description": null, + "description": "Type of acquired data in the instance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason" + "strength": "extensible", + "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" } }, - "title": "Reason full dose was not administered", + "title": "All of the distinct values for series' modalities", "type": "array" }, - "subPotentReason_coding": { - "binding_description": null, - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "modality_coding": { + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "binding_version": null, - "description": "[system#code representation.] The reason or reasons why the full dose was not administered.", + "description": "[system#code representation.] A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.", "element_property": true, "items": { "type": "string" }, "term": { - "description": null, + "description": "Type of acquired data in the instance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason" + "strength": "extensible", + "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" } }, - "title": "Reason full dose was not administered", + "title": "All of the distinct values for series' modalities", "type": "array" }, - "subPotentReason_text": { - "binding_description": null, - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "modality_text": { + "binding_description": "Type of acquired data in the instance.", + "binding_strength": "extensible", + "binding_uri": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "binding_version": null, - "description": "[system#code representation.] The reason or reasons why the full dose was not administered.", + "description": "[system#code representation.] A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.", "element_property": true, "items": { "type": "string" }, "term": { - "description": null, + "description": "Type of acquired data in the instance.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", + "cde_id": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason", - "term_url": "http://hl7.org/fhir/ValueSet/administration-subpotent-reason" + "strength": "extensible", + "term": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html", + "term_url": "http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html" } }, - "title": "Reason full dose was not administered", + "title": "All of the distinct values for series' modalities", "type": "array" }, - "subject": { - "backref": "medication_administration", - "description": "[Text representation of Reference] The person or animal or group receiving the medication.", - "element_property": true, - "enum_reference_types": [ - "Patient", - "Group" - ], - "title": "Who received medication", - "type": "string" - }, - "supportingInformation": { - "backref": "supportingInformation_medication_administration", - "description": "[Text representation of Reference] Additional information (for example, patient height and weight) that supports the administration of the medication. This attribute can be used to provide documentation of specific characteristics of the patient present at the time of administration. For example, if the dose says \"give \"x\" if the heartrate exceeds \"y\"\", then the heart rate can be included using this attribute.", + "note": { + "description": "[Text representation of Annotation] Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.", "element_property": true, - "enum_reference_types": [ - "Resource" - ], "items": { "type": "string" }, - "title": "Additional information to support administration", + "title": "User-defined comments", "type": "array" - } - }, - "systemProperties": [ - "id" - ], - "title": "MedicationAdministration", - "type": "object", - "uniqueKeys": [ - [ - "id" - ] - ] - }, - "medication.yaml": { - "$schema": "http://json-schema.org/draft-04/schema#", - "additionalProperties": true, - "category": "Clinical", - "description": "Definition of a Medication. This resource is primarily used for the identification and definition of a medication, including ingredients, for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. [See https://hl7.org/fhir/R5/Medication.html]", - "id": "medication", - "links": [], - "program": "*", - "project": "*", - "properties": { - "batch": { - "description": "[Text representation of MedicationBatch] Information that only applies to packages (not products).", + }, + "numberOfInstances": { + "description": "Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.", + "element_property": true, + "minimum": 0, + "title": "Number of Study Related Instances", + "type": "integer" + }, + "numberOfSeries": { + "description": "Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.", "element_property": true, - "title": "Details about packaged medications", - "type": "string" + "minimum": 0, + "title": "Number of Study Related Series", + "type": "integer" }, - "code": { - "binding_description": "A coded concept that defines the type of a medication.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "partOf": { + "backref": "partOf_imaging_study", + "description": "[Text representation of Reference] A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure.", + "element_property": true, + "enum_reference_types": [ + "Procedure" + ], + "items": { + "type": "string" + }, + "title": "Part of referenced event", + "type": "array" + }, + "procedure": { + "backref": "procedure_imaging_study", + "binding_description": "Use of RadLex is preferred", + "binding_strength": "preferred", + "binding_uri": "http://loinc.org/vs/loinc-rsna-radiology-playbook", "binding_version": null, - "description": "text representation. A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", + "description": "text representation. This field corresponds to the DICOM Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure resource that may include the ImagingStudy.", "element_property": true, + "enum_reference_types": [ + "PlanDefinition", + "ActivityDefinition" + ], + "items": { + "type": "string" + }, "term": { - "description": "A coded concept that defines the type of a medication.", + "description": "Use of RadLex is preferred", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_id": "http://loinc.org/vs/loinc-rsna-radiology-playbook", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + "strength": "preferred", + "term": "http://loinc.org/vs/loinc-rsna-radiology-playbook", + "term_url": "http://loinc.org/vs/loinc-rsna-radiology-playbook" } }, - "title": "Codes that identify this medication", - "type": "string" + "title": "The performed procedure or code", + "type": "array" }, - "code_coding": { - "binding_description": "A coded concept that defines the type of a medication.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "procedure_coding": { + "backref": "procedure_imaging_study", + "binding_description": "Use of RadLex is preferred", + "binding_strength": "preferred", + "binding_uri": "http://loinc.org/vs/loinc-rsna-radiology-playbook", "binding_version": null, - "description": "[system#code representation.] A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", + "description": "[system#code representation.] This field corresponds to the DICOM Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure resource that may include the ImagingStudy.", "element_property": true, + "enum_reference_types": [ + "PlanDefinition", + "ActivityDefinition" + ], + "items": { + "type": "string" + }, "term": { - "description": "A coded concept that defines the type of a medication.", + "description": "Use of RadLex is preferred", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_id": "http://loinc.org/vs/loinc-rsna-radiology-playbook", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + "strength": "preferred", + "term": "http://loinc.org/vs/loinc-rsna-radiology-playbook", + "term_url": "http://loinc.org/vs/loinc-rsna-radiology-playbook" } }, - "title": "Codes that identify this medication", - "type": "string" + "title": "The performed procedure or code", + "type": "array" }, - "code_text": { - "binding_description": "A coded concept that defines the type of a medication.", - "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-codes", + "procedure_text": { + "backref": "procedure_imaging_study", + "binding_description": "Use of RadLex is preferred", + "binding_strength": "preferred", + "binding_uri": "http://loinc.org/vs/loinc-rsna-radiology-playbook", "binding_version": null, - "description": "[system#code representation.] A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.", + "description": "[system#code representation.] This field corresponds to the DICOM Procedure Code Sequence (0008,1032). This is different from the FHIR Procedure resource that may include the ImagingStudy.", "element_property": true, + "enum_reference_types": [ + "PlanDefinition", + "ActivityDefinition" + ], + "items": { + "type": "string" + }, "term": { - "description": "A coded concept that defines the type of a medication.", + "description": "Use of RadLex is preferred", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-codes", + "cde_id": "http://loinc.org/vs/loinc-rsna-radiology-playbook", "cde_version": null, "source": "fhir", - "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-codes" + "strength": "preferred", + "term": "http://loinc.org/vs/loinc-rsna-radiology-playbook", + "term_url": "http://loinc.org/vs/loinc-rsna-radiology-playbook" } }, - "title": "Codes that identify this medication", - "type": "string" + "title": "The performed procedure or code", + "type": "array" }, - "definition": { - "backref": "medication", - "description": "[Text representation of Reference] A reference to a knowledge resource that provides more information about this medication.", - "element_property": true, - "enum_reference_types": [ - "MedicationKnowledge" - ], - "title": "Knowledge about this medication", + "project_id": { + "term": { + "$ref": "_terms.yaml#/project_id" + }, "type": "string" }, - "doseForm": { - "binding_description": "A coded concept defining the form of a medication.", + "reason": { + "backref": "reason_imaging_study", + "binding_description": "The reason for the study.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-reason", "binding_version": null, - "description": "text representation. Describes the form of the item. Powder; tablets; capsule.", + "description": "text representation. Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.", "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, "term": { - "description": "A coded concept defining the form of a medication.", + "description": "The reason for the study.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-form-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-form-codes" + "term": "http://hl7.org/fhir/ValueSet/procedure-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-reason" } }, - "title": "powder | tablets | capsule +", - "type": "string" + "title": "Why the study was requested / performed", + "type": "array" }, - "doseForm_coding": { - "binding_description": "A coded concept defining the form of a medication.", + "reason_coding": { + "backref": "reason_imaging_study", + "binding_description": "The reason for the study.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-reason", "binding_version": null, - "description": "[system#code representation.] Describes the form of the item. Powder; tablets; capsule.", + "description": "[system#code representation.] Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.", "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, "term": { - "description": "A coded concept defining the form of a medication.", + "description": "The reason for the study.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-form-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-form-codes" + "term": "http://hl7.org/fhir/ValueSet/procedure-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-reason" } }, - "title": "powder | tablets | capsule +", - "type": "string" + "title": "Why the study was requested / performed", + "type": "array" }, - "doseForm_text": { - "binding_description": "A coded concept defining the form of a medication.", + "reason_text": { + "backref": "reason_imaging_study", + "binding_description": "The reason for the study.", "binding_strength": "example", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "binding_uri": "http://hl7.org/fhir/ValueSet/procedure-reason", "binding_version": null, - "description": "[system#code representation.] Describes the form of the item. Powder; tablets; capsule.", + "description": "[system#code representation.] Description of clinical condition indicating why the ImagingStudy was requested, and/or Indicates another resource whose existence justifies this Study.", "element_property": true, + "enum_reference_types": [ + "Condition", + "Observation", + "DiagnosticReport", + "DocumentReference" + ], + "items": { + "type": "string" + }, "term": { - "description": "A coded concept defining the form of a medication.", + "description": "The reason for the study.", "termDef": { - "cde_id": "http://hl7.org/fhir/ValueSet/medication-form-codes", + "cde_id": "http://hl7.org/fhir/ValueSet/procedure-reason", "cde_version": null, "source": "fhir", "strength": "example", - "term": "http://hl7.org/fhir/ValueSet/medication-form-codes", - "term_url": "http://hl7.org/fhir/ValueSet/medication-form-codes" + "term": "http://hl7.org/fhir/ValueSet/procedure-reason", + "term_url": "http://hl7.org/fhir/ValueSet/procedure-reason" } }, - "title": "powder | tablets | capsule +", - "type": "string" - }, - "extension": { - "description": "[Text representation of Extension] May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Additional content defined by implementations", + "title": "Why the study was requested / performed", "type": "array" }, - "id": { - "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", + "referrer": { + "backref": "imaging_study", + "description": "[Text representation of Reference] The requesting/referring physician.", "element_property": true, - "maxLength": 64, - "minLength": 1, - "pattern": "^[A-Za-z0-9\\-.]+$", - "title": "Logical id of this artifact", + "enum_reference_types": [ + "Practitioner", + "PractitionerRole" + ], + "title": "Referring physician", "type": "string" }, - "identifier": { - "description": "Business identifier for this medication", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Business identifier for this medication", - "type": "array" - }, - "identifier_coding": { - "description": "[system#code representation of identifier] Business identifier for this medication", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Business identifier for this medication", - "type": "array" - }, - "identifier_text_coding": { - "description": "[system#code representation of identifier.text] Business identifier for this medication", - "element_property": true, - "items": { - "type": "string" - }, - "title": "Business identifier for this medication", - "type": "array" + "resourceType": { + "const": "ImagingStudy", + "description": "One of the resource types defined as part of FHIR", + "title": "Resource Type", + "type": "string" }, - "ingredient": { - "description": "[Text representation of MedicationIngredient] Identifies a particular constituent of interest in the product.", + "series": { + "description": "[Text representation of ImagingStudySeries] Each study has one or more series of images or other content.", "element_property": true, "items": { "type": "string" }, - "title": "Active or inactive ingredient", + "title": "Each study has one or more series of instances", "type": "array" }, - "marketingAuthorizationHolder": { - "backref": "medication", - "description": "[Text representation of Reference] The company or other legal entity that has authorization, from the appropriate drug regulatory authority, to market a medicine in one or more jurisdictions. Typically abbreviated MAH.Note: The MAH may manufacture the product and may also contract the manufacturing of the product to one or more companies (organizations).", + "started": { + "description": "Date and time the study started.", "element_property": true, - "enum_reference_types": [ - "Organization" - ], - "title": "Organization that has authorization to market medication", - "type": "string" - }, - "project_id": { - "term": { - "$ref": "_terms.yaml#/project_id" - }, - "type": "string" - }, - "resourceType": { - "const": "Medication", - "description": "One of the resource types defined as part of FHIR", - "title": "Resource Type", + "format": "date-time", + "title": "When the study was started", "type": "string" }, "status": { - "binding_description": "A coded concept defining if the medication is in active use.", + "binding_description": "The status of the ImagingStudy.", "binding_strength": "required", - "binding_uri": "http://hl7.org/fhir/ValueSet/medication-status", + "binding_uri": "http://hl7.org/fhir/ValueSet/imagingstudy-status", "binding_version": "5.0.0", - "description": "A code to indicate if the medication is in active use.", + "description": "The current state of the ImagingStudy resource. This is not the status of any ServiceRequest or Task resources associated with the ImagingStudy.", "element_property": true, + "element_required": true, "enum_values": [ - "active", - "inactive", - "entered-in-error" + "registered", + "available", + "cancelled", + "entered-in-error", + "unknown" ], "pattern": "^[^\\s]+(\\s[^\\s]+)*$", - "title": "active | inactive | entered-in-error", + "title": "registered | available | cancelled | entered-in-error | unknown", "type": "string" }, - "totalVolume": { - "description": "[Text representation of Quantity] text representation. When the specified product code does not infer a package size, this is the specific amount of drug in the product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).", + "subject": { + "backref": "imaging_study", + "description": "[Text representation of Reference] The subject, typically a patient, of the imaging study.", "element_property": true, - "title": "When the specified product code does not infer a package size, this is the specific amount of drug in the product", - "type": "string" - }, - "totalVolume_unit": { - "title": "Unit representation. When the specified product code does not infer a package size, this is the specific amount of drug in the product", + "enum_reference_types": [ + "Patient", + "Device", + "Group" + ], + "title": "Who or what is the subject of the study", "type": "string" - }, - "totalVolume_value": { - "title": "Numerical value (with implicit precision) representation. When the specified product code does not infer a package size, this is the specific amount of drug in the product", - "type": "number" } }, "systemProperties": [ "id" ], - "title": "Medication", + "title": "ImagingStudy", "type": "object", "uniqueKeys": [ [ diff --git a/schemas/simplified/specimen.yaml b/schemas/simplified/specimen.yaml index 807e5a9..b8da1b4 100644 --- a/schemas/simplified/specimen.yaml +++ b/schemas/simplified/specimen.yaml @@ -22,6 +22,12 @@ links: name: parent required: false target_type: specimen +- backref: specimen + label: Specimen_bodySite_BodyStructure_specimen + multiplicity: many_to_many + name: bodySite + required: false + target_type: body_structure program: '*' project: '*' properties: @@ -224,6 +230,11 @@ properties: type: string title: Specimen from which this specimen originated type: array + patient_identifier: + description: Denormalized patient identifier + items: + type: string + type: array processing_additive: backref: additive_specimen_processing description: '[Text representation of Reference] [Plucked from Specimen.processing] diff --git a/schemas/simplified/task.yaml b/schemas/simplified/task.yaml index 078c04e..d6a6574 100644 --- a/schemas/simplified/task.yaml +++ b/schemas/simplified/task.yaml @@ -4,6 +4,24 @@ category: Analysis description: A task to be performed. [See https://hl7.org/fhir/R5/Task.html] id: task links: +- backref: owner_task + label: Task_owner_Practitioner_owner_task + multiplicity: many_to_many + name: owner_Practitioner + required: false + target_type: practitioner +- backref: owner_task + label: Task_owner_PractitionerRole_owner_task + multiplicity: many_to_many + name: owner_PractitionerRole + required: false + target_type: practitioner_role +- backref: owner_task + label: Task_owner_Organization_owner_task + multiplicity: many_to_many + name: owner_Organization + required: false + target_type: organization - backref: owner_task label: Task_owner_Patient_owner_task multiplicity: many_to_many