spark_auto_mapper_fhir.resources.consent
¶
Module Contents¶
Classes¶
Consent |
- class spark_auto_mapper_fhir.resources.consent.Consent(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, status, scope, category, patient=None, dateTime=None, performer=None, organization=None, sourceAttachment=None, sourceReference=None, policy=None, policyRule=None, verification=None, provision=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase
Consent consent.xsd
A record of a healthcare consumer’s choices, which permits or denies
identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
If the element is present, it must have either a @value, an @id, or extensions
A record of a healthcare consumer’s choices, which permits or denies
identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
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
Unique identifier for this copy of the Consent Statement.
- param status
Indicates the current state of this consent.
- param scope
A selector of the type of consent being presented: ADR, Privacy, Treatment,
- Research. This list is now extensible.
- param category
A classification of the type of consents found in the statement. This element
- supports indexing and retrieval of consent statements.
- param patient
The patient/healthcare consumer to whom this consent applies.
- param dateTime
When this Consent was issued / created / indexed.
- param performer
Either the Grantor, which is the entity responsible for granting the rights
listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
- param organization
The organization that manages the consent, and the framework within which it
- is executed.
- param sourceAttachment
None
- param sourceReference
None
- param policy
The references to the policies that are included in this consent scope.
Policies may be organizational, but are often defined jurisdictionally, or in law.
- param policyRule
A reference to the specific base computable regulation or policy.
- param verification
Whether a treatment instruction (e.g. artificial respiration yes or no) was
- verified with the patient, his/her family or another authorized person.
- param provision
An exception to the base policy of this consent. An exception can be an
addition or removal of access permissions.
- 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]]) –
status (spark_auto_mapper_fhir.value_sets.consent_state.ConsentStateCode) –
scope (spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.consent_scope_codes.ConsentScopeCodesCode]) –
category (spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.consent_category_codes.ConsentCategoryCodesCode]]) –
patient (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.patient.Patient]]) –
dateTime (Optional[spark_auto_mapper_fhir.fhir_types.date_time.FhirDateTime]) –
performer (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.organization.Organization, spark_auto_mapper_fhir.resources.patient.Patient, spark_auto_mapper_fhir.resources.practitioner.Practitioner, spark_auto_mapper_fhir.resources.related_person.RelatedPerson, spark_auto_mapper_fhir.resources.practitioner_role.PractitionerRole]]]]) –
organization (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.organization.Organization]]]) –
sourceAttachment (Optional[spark_auto_mapper_fhir.complex_types.attachment.Attachment]) –
sourceReference (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[Consent, spark_auto_mapper_fhir.resources.document_reference.DocumentReference, spark_auto_mapper_fhir.resources.contract.Contract, spark_auto_mapper_fhir.resources.questionnaire_response.QuestionnaireResponse]]]) –
policy (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.consent_policy.ConsentPolicy]]) –
policyRule (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.consent_policy_rule_codes.ConsentPolicyRuleCodesCode]]) –
verification (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.consent_verification.ConsentVerification]]) –
provision (Optional[spark_auto_mapper_fhir.backbone_elements.consent_provision.ConsentProvision]) –
- get_schema(self, include_extension)¶
- Parameters
include_extension (bool) –
- Return type
Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]