spark_auto_mapper_fhir.resources.diagnostic_report
¶
Module Contents¶
Classes¶
DiagnosticReport |
- class spark_auto_mapper_fhir.resources.diagnostic_report.DiagnosticReport(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, basedOn=None, status, category=None, code, subject=None, encounter=None, effectiveDateTime=None, effectivePeriod=None, issued=None, performer=None, resultsInterpreter=None, specimen=None, result=None, imagingStudy=None, media=None, conclusion=None, conclusionCode=None, presentedForm=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase
DiagnosticReport diagnosticreport.xsd
The findings and interpretation of diagnostic tests performed on patients,
groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
If the element is present, it must have either a @value, an @id, or extensions
The findings and interpretation of diagnostic tests performed on patients,
groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
If the element is present, it must have either a @value, an @id, or extensions
- param id_
The logical id of the resource, as used in the URL for the resource. Once
- assigned, this value never changes.
- param meta
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.
- param implicitRules
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.
- param language
The base language in which the resource is written.
- param text
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.
- param contained
These resources do not have an independent existence apart from the resource
that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- param 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 manageable, 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.
- param modifierExtension
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 manageable, 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).
- param identifier
Identifiers assigned to this report by the performer or other systems.
- param basedOn
Details concerning a service requested.
- param status
The status of the diagnostic report.
- param category
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.
- param code
A code or name that describes this diagnostic report.
- param subject
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.
- param encounter
The healthcare event (e.g. a patient and healthcare provider interaction)
- which this DiagnosticReport is about.
- param effectiveDateTime
None
- param effectivePeriod
None
- param issued
The date and time that this version of the report was made available to
- providers, typically after the report was reviewed and verified.
- param performer
The diagnostic service that is responsible for issuing the report.
- param resultsInterpreter
The practitioner or organization that is responsible for the report’s
- conclusions and interpretations.
- param specimen
Details about the specimens on which this diagnostic report is based.
- param result
[Observations](observation.html) that are part of this diagnostic report.
- param imagingStudy
One or more links to full details of any imaging performed during the
diagnostic investigation. 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.
- param media
A list of key images associated with this report. The images are generally
created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
- param conclusion
Concise and clinically contextualized summary conclusion
- (interpretation/impression) of the diagnostic report.
- param conclusionCode
One or more codes that represent the summary conclusion
- (interpretation/impression) of the diagnostic report.
- param presentedForm
Rich text representation of the entire result as issued by the diagnostic
service. Multiple formats are allowed but they SHALL be semantically equivalent.
- Parameters
id_ (Optional[spark_auto_mapper_fhir.fhir_types.id.FhirId]) –
meta (Optional[spark_auto_mapper_fhir.complex_types.meta.Meta]) –
implicitRules (Optional[spark_auto_mapper_fhir.fhir_types.uri.FhirUri]) –
language (Optional[spark_auto_mapper_fhir.value_sets.common_languages.CommonLanguagesCode]) –
text (Optional[spark_auto_mapper_fhir.complex_types.narrative.Narrative]) –
contained (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.resource_container.ResourceContainer]]) –
extension (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.extensions.extension_base.ExtensionBase]]) –
modifierExtension (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.extensions.extension_base.ExtensionBase]]) –
identifier (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.identifier.Identifier]]) –
basedOn (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.care_plan.CarePlan, spark_auto_mapper_fhir.resources.immunization_recommendation.ImmunizationRecommendation, spark_auto_mapper_fhir.resources.medication_request.MedicationRequest, spark_auto_mapper_fhir.resources.nutrition_order.NutritionOrder, spark_auto_mapper_fhir.resources.service_request.ServiceRequest]]]]) –
status (spark_auto_mapper_fhir.value_sets.diagnostic_report_status.DiagnosticReportStatusCode) –
category (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.diagnostic_service_section_codes.DiagnosticServiceSectionCodesCode]]]) –
code (spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.loinc_diagnostic_report_codes.LOINCDiagnosticReportCodesCode]) –
subject (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.patient.Patient, spark_auto_mapper_fhir.resources.group.Group, spark_auto_mapper_fhir.resources.device.Device, spark_auto_mapper_fhir.resources.location.Location]]]) –
encounter (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.encounter.Encounter]]) –
effectiveDateTime (Optional[spark_auto_mapper_fhir.fhir_types.date_time.FhirDateTime]) –
effectivePeriod (Optional[spark_auto_mapper_fhir.complex_types.period.Period]) –
issued (Optional[spark_auto_mapper_fhir.fhir_types.instant.FhirInstant]) –
performer (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.practitioner.Practitioner, spark_auto_mapper_fhir.resources.practitioner_role.PractitionerRole, spark_auto_mapper_fhir.resources.organization.Organization, spark_auto_mapper_fhir.resources.care_team.CareTeam]]]]) –
resultsInterpreter (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.practitioner.Practitioner, spark_auto_mapper_fhir.resources.practitioner_role.PractitionerRole, spark_auto_mapper_fhir.resources.organization.Organization, spark_auto_mapper_fhir.resources.care_team.CareTeam]]]]) –
specimen (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.specimen.Specimen]]]) –
result (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.observation.Observation]]]) –
imagingStudy (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.imaging_study.ImagingStudy]]]) –
media (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.diagnostic_report_media.DiagnosticReportMedia]]) –
conclusion (Optional[spark_auto_mapper_fhir.fhir_types.string.FhirString]) –
conclusionCode (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.snomedct_clinical_findings.SNOMEDCTClinicalFindingsCode]]]) –
presentedForm (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.attachment.Attachment]]) –
- get_schema(self, include_extension)¶
- Parameters
include_extension (bool) –
- Return type
Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]