spark_auto_mapper_fhir.backbone_elements.substance_specification_name
¶
Module Contents¶
Classes¶
SubstanceSpecification.Name |
- class spark_auto_mapper_fhir.backbone_elements.substance_specification_name.SubstanceSpecificationName(*, id_=None, extension=None, modifierExtension=None, name, type_=None, status=None, preferred=None, language=None, domain=None, jurisdiction=None, synonym=None, translation=None, official=None, source=None)¶
Bases:
spark_auto_mapper_fhir.base_types.fhir_backbone_element_base.FhirBackboneElementBase
- SubstanceSpecification.Name
The detailed description of a substance, typically at a level beyond what is used for prescribing.
The detailed description of a substance, typically at a level beyond what is
used for prescribing.
- param id_
None
- param extension
May be used to represent additional information that is not part of the basic
definition of the element. 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 element and that modifies the understanding of the element in which it is contained 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 can 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 name
The actual name.
- param type_
Name type.
- param status
The status of the name.
- param preferred
If this is the preferred name for this substance.
- param language
Language of the name.
- param domain
The use context of this name for example if there is a different name a drug
- active ingredient as opposed to a food colour additive.
- param jurisdiction
The jurisdiction where this name applies.
- param synonym
A synonym of this name.
- param translation
A translation for this name.
- param official
Details of the official nature of this name.
- param source
Supporting literature.
- Parameters
id_ (Optional[spark_auto_mapper_fhir.fhir_types.string.FhirString]) –
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]]) –
name (spark_auto_mapper_fhir.fhir_types.string.FhirString) –
type_ (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.generic_type.GenericTypeCode]]) –
status (Optional[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.generic_type.GenericTypeCode]]) –
preferred (Optional[spark_auto_mapper_fhir.fhir_types.boolean.FhirBoolean]) –
language (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.generic_type.GenericTypeCode]]]) –
domain (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.generic_type.GenericTypeCode]]]) –
jurisdiction (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.codeable_concept.CodeableConcept[spark_auto_mapper_fhir.value_sets.generic_type.GenericTypeCode]]]) –
synonym (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[SubstanceSpecificationName]]) –
translation (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[SubstanceSpecificationName]]) –
official (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.backbone_elements.substance_specification_official.SubstanceSpecificationOfficial]]) –
source (Optional[spark_auto_mapper_fhir.fhir_types.list.FhirList[spark_auto_mapper_fhir.complex_types.reference.Reference[spark_auto_mapper_fhir.resources.document_reference.DocumentReference]]]) –