spark_auto_mapper_fhir.resources.questionnaire_response
¶
Module Contents¶
Classes¶
QuestionnaireResponse |
- class spark_auto_mapper_fhir.resources.questionnaire_response.QuestionnaireResponse(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, basedOn=None, partOf=None, questionnaire=None, status, subject=None, encounter=None, authored=None, author=None, source=None, item=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase
QuestionnaireResponse questionnaireresponse.xsd
A structured set of questions and their answers. The questions are ordered and
grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
If the element is present, it must have either a @value, an @id, or extensions
A structured set of questions and their answers. The questions are ordered and
grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
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
A business identifier assigned to a particular completed (or partially
- completed) questionnaire.
- param basedOn
The order, proposal or plan that is fulfilled in whole or in part by this
QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
- param partOf
A procedure or observation that this questionnaire was performed as part of
the execution of. For example, the surgery a checklist was executed as part of.
- param questionnaire
The Questionnaire that defines and organizes the questions for which answers
- are being provided.
- param status
The position of the questionnaire response within its overall lifecycle.
- param subject
The subject of the questionnaire response. This could be a patient,
organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
- param encounter
The Encounter during which this questionnaire response was created or to which
- the creation of this record is tightly associated.
- param authored
The date and/or time that this set of answers were last changed.
- param author
Person who received the answers to the questions in the QuestionnaireResponse
- and recorded them in the system.
- param source
The person who answered the questions about the subject.
- param item
A group or question item from the original questionnaire for which answers are
provided.
- 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.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.service_request.ServiceRequest]]]]) –
partOf (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.observation.Observation, spark_auto_mapper_fhir.resources.procedure.Procedure]]]]) –
questionnaire (Optional[spark_auto_mapper_fhir.fhir_types.canonical.FhirCanonical]) –
status (spark_auto_mapper_fhir.value_sets.questionnaire_response_status.QuestionnaireResponseStatusCode) –
subject (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.resource.Resource]]) –
encounter (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.encounter.Encounter]]) –
authored (Optional[spark_auto_mapper_fhir.fhir_types.date_time.FhirDateTime]) –
author (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.device.Device, spark_auto_mapper_fhir.resources.practitioner.Practitioner, spark_auto_mapper_fhir.resources.practitioner_role.PractitionerRole, spark_auto_mapper_fhir.resources.patient.Patient, spark_auto_mapper_fhir.resources.related_person.RelatedPerson, spark_auto_mapper_fhir.resources.organization.Organization]]]) –
source (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.patient.Patient, spark_auto_mapper_fhir.resources.practitioner.Practitioner, spark_auto_mapper_fhir.resources.practitioner_role.PractitionerRole, spark_auto_mapper_fhir.resources.related_person.RelatedPerson]]]) –
item (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.questionnaire_response_item.QuestionnaireResponseItem]]) –
- get_schema(self, include_extension)¶
- Parameters
include_extension (bool) –
- Return type
Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]