spark_auto_mapper_fhir.resources.supply_request
¶
Module Contents¶
Classes¶
SupplyRequest |
- class spark_auto_mapper_fhir.resources.supply_request.SupplyRequest(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, status=None, category=None, priority=None, itemCodeableConcept=None, itemReference=None, quantity, parameter=None, occurrenceDateTime=None, occurrencePeriod=None, occurrenceTiming=None, authoredOn=None, requester=None, supplier=None, reasonCode=None, reasonReference=None, deliverFrom=None, deliverTo=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase
SupplyRequest supplyrequest.xsd
A record of a request for a medication, substance or device used in the
- healthcare setting.
If the element is present, it must have either a @value, an @id, or extensions
A record of a request for a medication, substance or device used in the
- healthcare setting.
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
Business identifiers assigned to this SupplyRequest by the author and/or other
systems. These identifiers remain constant as the resource is updated and propagates from server to server.
- param status
Status of the supply request.
- param category
Category of supply, e.g. central, non-stock, etc. This is used to support
- work flows associated with the supply process.
- param priority
Indicates how quickly this SupplyRequest should be addressed with respect to
- other requests.
- param itemCodeableConcept
None
- param itemReference
None
- param quantity
The amount that is being ordered of the indicated item.
- param parameter
Specific parameters for the ordered item. For example, the size of the
- indicated item.
- param occurrenceDateTime
None
- param occurrencePeriod
None
- param occurrenceTiming
None
- param authoredOn
When the request was made.
- param requester
The device, practitioner, etc. who initiated the request.
- param supplier
Who is intended to fulfill the request.
- param reasonCode
The reason why the supply item was requested.
- param reasonReference
The reason why the supply item was requested.
- param deliverFrom
Where the supply is expected to come from.
- param deliverTo
Where the supply is destined to go.
- 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 (Optional[spark_auto_mapper_fhir.value_sets.supply_request_status.SupplyRequestStatusCode]) –
category (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.supply_type.SupplyTypeCode]]) –
priority (Optional[spark_auto_mapper_fhir.value_sets.request_priority.RequestPriorityCode]) –
itemCodeableConcept (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.snomedct_supply_item.SNOMEDCTSupplyItemCode]]) –
itemReference (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.medication.Medication, spark_auto_mapper_fhir.resources.substance.Substance, spark_auto_mapper_fhir.resources.device.Device]]]) –
quantity (spark_auto_mapper_fhir.complex_types.quantity.Quantity) –
parameter (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.supply_request_parameter.SupplyRequestParameter]]) –
occurrenceDateTime (Optional[spark_auto_mapper_fhir.fhir_types.date_time.FhirDateTime]) –
occurrencePeriod (Optional[spark_auto_mapper_fhir.complex_types.period.Period]) –
occurrenceTiming (Optional[spark_auto_mapper_fhir.backbone_elements.timing.Timing]) –
authoredOn (Optional[spark_auto_mapper_fhir.fhir_types.date_time.FhirDateTime]) –
requester (Optional[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.patient.Patient, spark_auto_mapper_fhir.resources.related_person.RelatedPerson, spark_auto_mapper_fhir.resources.device.Device]]]) –
supplier (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.healthcare_service.HealthcareService]]]]) –
reasonCode (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.supply_request_reason.SupplyRequestReasonCode]]]) –
reasonReference (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.condition.Condition, spark_auto_mapper_fhir.resources.observation.Observation, spark_auto_mapper_fhir.resources.diagnostic_report.DiagnosticReport, spark_auto_mapper_fhir.resources.document_reference.DocumentReference]]]]) –
deliverFrom (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.organization.Organization, spark_auto_mapper_fhir.resources.location.Location]]]) –
deliverTo (Optional[spark_auto_mapper_fhir.complex_types.reference.Reference[Union[spark_auto_mapper_fhir.resources.organization.Organization, spark_auto_mapper_fhir.resources.location.Location, spark_auto_mapper_fhir.resources.patient.Patient]]]) –
- get_schema(self, include_extension)¶
- Parameters
include_extension (bool) –
- Return type
Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]