spark_auto_mapper_fhir.resources.observation_definition
¶
Module Contents¶
Classes¶
ObservationDefinition |
- class spark_auto_mapper_fhir.resources.observation_definition.ObservationDefinition(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, category=None, code, identifier=None, permittedDataType=None, multipleResultsAllowed=None, method=None, preferredReportName=None, quantitativeDetails=None, qualifiedInterval=None, validCodedValueSet=None, normalCodedValueSet=None, abnormalCodedValueSet=None, criticalCodedValueSet=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase
ObservationDefinition observationdefinition.xsd
Set of definitional characteristics for a kind of observation or measurement
- produced or consumed by an orderable health care service.
If the element is present, it must have either a @value, an @id, or extensions
Set of definitional characteristics for a kind of observation or measurement
- produced or consumed by an orderable health care service.
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 category
A code that classifies the general type of observation.
- param code
Describes what will be observed. Sometimes this is called the observation
- “name”.
- param identifier
A unique identifier assigned to this ObservationDefinition artifact.
- param permittedDataType
The data types allowed for the value element of the instance observations
- conforming to this ObservationDefinition.
- param multipleResultsAllowed
Multiple results allowed for observations conforming to this
- ObservationDefinition.
- param method
The method or technique used to perform the observation.
- param preferredReportName
The preferred name to be used when reporting the results of observations
- conforming to this ObservationDefinition.
- param quantitativeDetails
Characteristics for quantitative results of this observation.
- param qualifiedInterval
Multiple ranges of results qualified by different contexts for ordinal or
- continuous observations conforming to this ObservationDefinition.
- param validCodedValueSet
The set of valid coded results for the observations conforming to this
- ObservationDefinition.
- param normalCodedValueSet
The set of normal coded results for the observations conforming to this
- ObservationDefinition.
- param abnormalCodedValueSet
The set of abnormal coded results for the observation conforming to this
- ObservationDefinition.
- param criticalCodedValueSet
The set of critical coded results for the observation conforming to this
ObservationDefinition.
- 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]]) –
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.observation_category_codes.ObservationCategoryCodesCode]]]) –
code (spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.loinc_codes.LOINCCodesCode]) –
identifier (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.identifier.Identifier]]) –
permittedDataType (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.value_sets.observation_data_type.ObservationDataTypeCode]]) –
multipleResultsAllowed (Optional[spark_auto_mapper_fhir.fhir_types.boolean.FhirBoolean]) –
method (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.observation_methods.ObservationMethodsCode]]) –
preferredReportName (Optional[spark_auto_mapper_fhir.fhir_types.string.FhirString]) –
quantitativeDetails (Optional[spark_auto_mapper_fhir.backbone_elements.observation_definition_quantitative_details.ObservationDefinitionQuantitativeDetails]) –
qualifiedInterval (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.observation_definition_qualified_interval.ObservationDefinitionQualifiedInterval]]) –
validCodedValueSet (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.value_set.ValueSet]]) –
normalCodedValueSet (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.value_set.ValueSet]]) –
abnormalCodedValueSet (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.value_set.ValueSet]]) –
criticalCodedValueSet (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.value_set.ValueSet]]) –
- get_schema(self, include_extension)¶
- Parameters
include_extension (bool) –
- Return type
Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]