FHIR R4 Core Resources

Classes representing FHIR R4 core resources.

Account

Path: fhircraft.fhir.resources.datatypes.R4.core.account.Account

Bases: DomainResource

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Account'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Account number	None
status	Code | None	active | inactive | entered-in-error | on-hold | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	E.g. patient, expense, depreciation	None
name	String | None	Human-readable label	None
name_ext	Element | None	Placeholder element for name extensions	None
subject	List[Reference] | None	The entity that caused the expenses	None
servicePeriod	Period | None	Transaction window	None
coverage	List[AccountCoverage] | None	The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account	None
owner	Reference | None	Entity managing the Account	None
description	String | None	Explanation of purpose/use	None
description_ext	Element | None	Placeholder element for description extensions	None
guarantor	List[AccountGuarantor] | None	The parties ultimately responsible for balancing the Account	None
partOf	Reference | None	Reference to a parent Account	None
resourceType	Literal['Account']		'Account'

AccountCoverage

Path: fhircraft.fhir.resources.datatypes.R4.core.account.AccountCoverage

Bases: BackboneElement

The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
coverage	Reference | None	The party(s), such as insurances, that may contribute to the payment of this account	None
priority	PositiveInt | None	The priority of the coverage in the context of this account	None
priority_ext	Element | None	Placeholder element for priority extensions	None

AccountGuarantor

Path: fhircraft.fhir.resources.datatypes.R4.core.account.AccountGuarantor

Bases: BackboneElement

The parties responsible for balancing the account if other payment options fall short.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
party	Reference | None	Responsible entity	None
onHold	Boolean | None	Credit or other hold applied	None
onHold_ext	Element | None	Placeholder element for onHold extensions	None
period	Period | None	Guarantee account during	None

ActivityDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.activity_definition.ActivityDefinition

Bases: DomainResource

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ActivityDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this activity definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the activity definition	None
version	String | None	Business version of the activity definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this activity definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this activity definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
subtitle	String | None	Subordinate title of the activity definition	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
subjectCodeableConcept	CodeableConcept | None	Type of individual the activity definition is intended for	None
subjectReference	Reference | None	Type of individual the activity definition is intended for	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the activity definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for activity definition (if applicable)	None
purpose	Markdown | None	Why this activity definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
usage	String | None	Describes the clinical usage of the activity definition	None
usage_ext	Element | None	Placeholder element for usage extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the activity definition was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the activity definition was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the activity definition is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
library	List[Canonical] | None	Logic used by the activity definition	None
library_ext	Element | None	Placeholder element for library extensions	None
kind	Code | None	Kind of resource	None
kind_ext	Element | None	Placeholder element for kind extensions	None
profile	Canonical | None	What profile the resource needs to conform to	None
profile_ext	Element | None	Placeholder element for profile extensions	None
code	CodeableConcept | None	Detail type of activity	None
intent	Code | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
doNotPerform	Boolean | None	True if the activity should not be performed	None
doNotPerform_ext	Element | None	Placeholder element for doNotPerform extensions	None
timingTiming	Timing | None	When activity is to occur	None
timingDateTime	DateTime | None	When activity is to occur	None
timingDateTime_ext	Element | None	Placeholder element for timingDateTime extensions	None
timingAge	Age | None	When activity is to occur	None
timingPeriod	Period | None	When activity is to occur	None
timingRange	Range | None	When activity is to occur	None
timingDuration	Duration | None	When activity is to occur	None
location	Reference | None	Where it should happen	None
participant	List[ActivityDefinitionParticipant] | None	Who should participate in the action	None
productReference	Reference | None	What's administered/supplied	None
productCodeableConcept	CodeableConcept | None	What's administered/supplied	None
quantity	Quantity | None	How much is administered/consumed/supplied	None
dosage	List[Dosage] | None	Detailed dosage instructions	None
bodySite	List[CodeableConcept] | None	What part of body to perform on	None
specimenRequirement	List[Reference] | None	What specimens are required to perform this action	None
observationRequirement	List[Reference] | None	What observations are required to perform this action	None
observationResultRequirement	List[Reference] | None	What observations must be produced by this action	None
transform	Canonical | None	Transform to apply the template	None
transform_ext	Element | None	Placeholder element for transform extensions	None
dynamicValue	List[ActivityDefinitionDynamicValue] | None	Dynamic aspects of the definition	None
resourceType	Literal['ActivityDefinition']		'ActivityDefinition'

ActivityDefinitionDynamicValue

Path: fhircraft.fhir.resources.datatypes.R4.core.activity_definition.ActivityDefinitionDynamicValue

Bases: BackboneElement

Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
path	String | None	The path to the element to be set dynamically	None
path_ext	Element | None	Placeholder element for path extensions	None
expression	Expression | None	An expression that provides the dynamic value for the customization	None

ActivityDefinitionParticipant

Path: fhircraft.fhir.resources.datatypes.R4.core.activity_definition.ActivityDefinitionParticipant

Bases: BackboneElement

Indicates who should participate in performing the action described.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	patient | practitioner | related-person | device	None
type_ext	Element | None	Placeholder element for type extensions	None
role	CodeableConcept | None	E.g. Nurse, Surgeon, Parent, etc.	None

AdverseEvent

Path: fhircraft.fhir.resources.datatypes.R4.core.adverse_event.AdverseEvent

Bases: DomainResource

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/AdverseEvent'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	Identifier | None	Business identifier for the event	None
actuality	Code | None	actual | potential	None
actuality_ext	Element | None	Placeholder element for actuality extensions	None
category	List[CodeableConcept] | None	product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment	None
event	CodeableConcept | None	Type of the event itself in relation to the subject	None
subject	Reference | None	Subject impacted by event	None
encounter	Reference | None	Encounter created as part of	None
date	DateTime | None	When the event occurred	None
date_ext	Element | None	Placeholder element for date extensions	None
detected	DateTime | None	When the event was detected	None
detected_ext	Element | None	Placeholder element for detected extensions	None
recordedDate	DateTime | None	When the event was recorded	None
recordedDate_ext	Element | None	Placeholder element for recordedDate extensions	None
resultingCondition	List[Reference] | None	Effect on the subject due to this event	None
location	Reference | None	Location where adverse event occurred	None
seriousness	CodeableConcept | None	Seriousness of the event	None
severity	CodeableConcept | None	mild | moderate | severe	None
outcome	CodeableConcept | None	resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown	None
recorder	Reference | None	Who recorded the adverse event	None
contributor	List[Reference] | None	Who was involved in the adverse event or the potential adverse event	None
suspectEntity	List[AdverseEventSuspectEntity] | None	The suspected agent causing the adverse event	None
subjectMedicalHistory	List[Reference] | None	AdverseEvent.subjectMedicalHistory	None
referenceDocument	List[Reference] | None	AdverseEvent.referenceDocument	None
study	List[Reference] | None	AdverseEvent.study	None
resourceType	Literal['AdverseEvent']		'AdverseEvent'

AdverseEventSuspectEntity

Path: fhircraft.fhir.resources.datatypes.R4.core.adverse_event.AdverseEventSuspectEntity

Bases: BackboneElement

Describes the entity that is suspected to have caused the adverse event.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
instance	Reference | None	Refers to the specific entity that caused the adverse event	None
causality	List[AdverseEventSuspectEntityCausality] | None	Information on the possible cause of the event	None

AdverseEventSuspectEntityCausality

Path: fhircraft.fhir.resources.datatypes.R4.core.adverse_event.AdverseEventSuspectEntityCausality

Bases: BackboneElement

Information on the possible cause of the event.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
assessment	CodeableConcept | None	Assessment of if the entity caused the event	None
productRelatedness	String | None	AdverseEvent.suspectEntity.causalityProductRelatedness	None
productRelatedness_ext	Element | None	Placeholder element for productRelatedness extensions	None
author	Reference | None	AdverseEvent.suspectEntity.causalityAuthor	None
method	CodeableConcept | None	ProbabilityScale | Bayesian | Checklist	None

AllergyIntolerance

Path: fhircraft.fhir.resources.datatypes.R4.core.allergy_intolerance.AllergyIntolerance

Bases: DomainResource

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/AllergyIntolerance'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External ids for this item	None
clinicalStatus	CodeableConcept | None	active | inactive | resolved	None
verificationStatus	CodeableConcept | None	unconfirmed | confirmed | refuted | entered-in-error	None
type	Code | None	allergy | intolerance - Underlying mechanism (if known)	None
type_ext	Element | None	Placeholder element for type extensions	None
category	List[Code] | None	food | medication | environment | biologic	None
category_ext	Element | None	Placeholder element for category extensions	None
criticality	Code | None	low | high | unable-to-assess	None
criticality_ext	Element | None	Placeholder element for criticality extensions	None
code	CodeableConcept | None	Code that identifies the allergy or intolerance	None
patient	Reference | None	Who the sensitivity is for	None
encounter	Reference | None	Encounter when the allergy or intolerance was asserted	None
onsetDateTime	DateTime | None	When allergy or intolerance was identified	None
onsetDateTime_ext	Element | None	Placeholder element for onsetDateTime extensions	None
onsetAge	Age | None	When allergy or intolerance was identified	None
onsetPeriod	Period | None	When allergy or intolerance was identified	None
onsetRange	Range | None	When allergy or intolerance was identified	None
onsetString	String | None	When allergy or intolerance was identified	None
onsetString_ext	Element | None	Placeholder element for onsetString extensions	None
recordedDate	DateTime | None	Date first version of the resource instance was recorded	None
recordedDate_ext	Element | None	Placeholder element for recordedDate extensions	None
recorder	Reference | None	Who recorded the sensitivity	None
asserter	Reference | None	Source of the information about the allergy	None
lastOccurrence	DateTime | None	Date(/time) of last known occurrence of a reaction	None
lastOccurrence_ext	Element | None	Placeholder element for lastOccurrence extensions	None
note	List[Annotation] | None	Additional text not captured in other fields	None
reaction	List[AllergyIntoleranceReaction] | None	Adverse Reaction Events linked to exposure to substance	None
resourceType	Literal['AllergyIntolerance']		'AllergyIntolerance'

AllergyIntoleranceReaction

Path: fhircraft.fhir.resources.datatypes.R4.core.allergy_intolerance.AllergyIntoleranceReaction

Bases: BackboneElement

Details about each adverse reaction event linked to exposure to the identified substance.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
substance	CodeableConcept | None	Specific substance or pharmaceutical product considered to be responsible for event	None
manifestation	List[CodeableConcept] | None	Clinical symptoms/signs associated with the Event	None
description	String | None	Description of the event as a whole	None
description_ext	Element | None	Placeholder element for description extensions	None
onset	DateTime | None	Date(/time) when manifestations showed	None
onset_ext	Element | None	Placeholder element for onset extensions	None
severity	Code | None	mild | moderate | severe (of event as a whole)	None
severity_ext	Element | None	Placeholder element for severity extensions	None
exposureRoute	CodeableConcept | None	How the subject was exposed to the substance	None
note	List[Annotation] | None	Text about event not captured in other fields	None

Appointment

Path: fhircraft.fhir.resources.datatypes.R4.core.appointment.Appointment

Bases: DomainResource

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Appointment'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this item	None
status	Code | None	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist	None
status_ext	Element | None	Placeholder element for status extensions	None
cancelationReason	CodeableConcept | None	The coded reason for the appointment being cancelled	None
serviceCategory	List[CodeableConcept] | None	A broad categorization of the service that is to be performed during this appointment	None
serviceType	List[CodeableConcept] | None	The specific service that is to be performed during this appointment	None
specialty	List[CodeableConcept] | None	The specialty of a practitioner that would be required to perform the service requested in this appointment	None
appointmentType	CodeableConcept | None	The style of appointment or patient that has been booked in the slot (not service type)	None
reasonCode	List[CodeableConcept] | None	Coded reason this appointment is scheduled	None
reasonReference	List[Reference] | None	Reason the appointment is to take place (resource)	None
priority	UnsignedInt | None	Used to make informed decisions if needing to re-prioritize	None
priority_ext	Element | None	Placeholder element for priority extensions	None
description	String | None	Shown on a subject line in a meeting request, or appointment list	None
description_ext	Element | None	Placeholder element for description extensions	None
supportingInformation	List[Reference] | None	Additional information to support the appointment	None
start	Instant | None	When appointment is to take place	None
start_ext	Element | None	Placeholder element for start extensions	None
end	Instant | None	When appointment is to conclude	None
end_ext	Element | None	Placeholder element for end extensions	None
minutesDuration	PositiveInt | None	Can be less than start/end (e.g. estimate)	None
minutesDuration_ext	Element | None	Placeholder element for minutesDuration extensions	None
slot	List[Reference] | None	The slots that this appointment is filling	None
created	DateTime | None	The date that this appointment was initially created	None
created_ext	Element | None	Placeholder element for created extensions	None
comment	String | None	Additional comments	None
comment_ext	Element | None	Placeholder element for comment extensions	None
patientInstruction	String | None	Detailed information and instructions for the patient	None
patientInstruction_ext	Element | None	Placeholder element for patientInstruction extensions	None
basedOn	List[Reference] | None	The service request this appointment is allocated to assess	None
participant	List[AppointmentParticipant] | None	Participants involved in appointment	None
requestedPeriod	List[Period] | None	Potential date/time interval(s) requested to allocate the appointment within	None
resourceType	Literal['Appointment']		'Appointment'

AppointmentParticipant

Path: fhircraft.fhir.resources.datatypes.R4.core.appointment.AppointmentParticipant

Bases: BackboneElement

List of participants involved in the appointment.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	List[CodeableConcept] | None	Role of participant in the appointment	None
actor	Reference | None	Person, Location/HealthcareService or Device	None
required	Code | None	required | optional | information-only	None
required_ext	Element | None	Placeholder element for required extensions	None
status	Code | None	accepted | declined | tentative | needs-action	None
status_ext	Element | None	Placeholder element for status extensions	None
period	Period | None	Participation period of the actor	None

AppointmentResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.appointment_response.AppointmentResponse

Bases: DomainResource

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/AppointmentResponse'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this item	None
appointment	Reference | None	Appointment this response relates to	None
start	Instant | None	Time from appointment, or requested new start time	None
start_ext	Element | None	Placeholder element for start extensions	None
end	Instant | None	Time from appointment, or requested new end time	None
end_ext	Element | None	Placeholder element for end extensions	None
participantType	List[CodeableConcept] | None	Role of participant in the appointment	None
actor	Reference | None	Person, Location, HealthcareService, or Device	None
participantStatus	Code | None	accepted | declined | tentative | needs-action	None
participantStatus_ext	Element | None	Placeholder element for participantStatus extensions	None
comment	String | None	Additional comments	None
comment_ext	Element | None	Placeholder element for comment extensions	None
resourceType	Literal['AppointmentResponse']		'AppointmentResponse'

AuditEvent

Path: fhircraft.fhir.resources.datatypes.R4.core.audit_event.AuditEvent

Bases: DomainResource

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/AuditEvent'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
type	Coding | None	Type/identifier of event	None
subtype	List[Coding] | None	More specific type/id for the event	None
action	Code | None	Type of action performed during the event	None
action_ext	Element | None	Placeholder element for action extensions	None
period	Period | None	When the activity occurred	None
recorded	Instant | None	Time when the event was recorded	None
recorded_ext	Element | None	Placeholder element for recorded extensions	None
outcome	Code | None	Whether the event succeeded or failed	None
outcome_ext	Element | None	Placeholder element for outcome extensions	None
outcomeDesc	String | None	Description of the event outcome	None
outcomeDesc_ext	Element | None	Placeholder element for outcomeDesc extensions	None
purposeOfEvent	List[CodeableConcept] | None	The purposeOfUse of the event	None
agent	List[AuditEventAgent] | None	Actor involved in the event	None
source	AuditEventSource | None	Audit Event Reporter	None
entity	List[AuditEventEntity] | None	Data or objects used	None
resourceType	Literal['AuditEvent']		'AuditEvent'

AuditEventAgent

Path: fhircraft.fhir.resources.datatypes.R4.core.audit_event.AuditEventAgent

Bases: BackboneElement

An actor taking an active role in the event or activity that is logged.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	How agent participated	None
role	List[CodeableConcept] | None	Agent role in the event	None
who	Reference | None	Identifier of who	None
altId	String | None	Alternative User identity	None
altId_ext	Element | None	Placeholder element for altId extensions	None
name	String | None	Human friendly name for the agent	None
name_ext	Element | None	Placeholder element for name extensions	None
requestor	Boolean | None	Whether user is initiator	None
requestor_ext	Element | None	Placeholder element for requestor extensions	None
location	Reference | None	Where	None
policy	List[Uri] | None	Policy that authorized event	None
policy_ext	Element | None	Placeholder element for policy extensions	None
media	Coding | None	Type of media	None
network	AuditEventAgentNetwork | None	Logical network location for application activity	None
purposeOfUse	List[CodeableConcept] | None	Reason given for this user	None

AuditEventAgentNetwork

Path: fhircraft.fhir.resources.datatypes.R4.core.audit_event.AuditEventAgentNetwork

Bases: BackboneElement

Logical network location for application activity, if the activity has a network location.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
address	String | None	Identifier for the network access point of the user device	None
address_ext	Element | None	Placeholder element for address extensions	None
type	Code | None	The type of network access point	None
type_ext	Element | None	Placeholder element for type extensions	None

AuditEventEntity

Path: fhircraft.fhir.resources.datatypes.R4.core.audit_event.AuditEventEntity

Bases: BackboneElement

Specific instances of data or objects that have been accessed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
what	Reference | None	Specific instance of resource	None
type	Coding | None	Type of entity involved	None
role	Coding | None	What role the entity played	None
lifecycle	Coding | None	Life-cycle stage for the entity	None
securityLabel	List[Coding] | None	Security labels on the entity	None
name	String | None	Descriptor for entity	None
name_ext	Element | None	Placeholder element for name extensions	None
description	String | None	Descriptive text	None
description_ext	Element | None	Placeholder element for description extensions	None
query	Base64Binary | None	Query parameters	None
query_ext	Element | None	Placeholder element for query extensions	None
detail	List[AuditEventEntityDetail] | None	Additional Information about the entity	None

AuditEventEntityDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.audit_event.AuditEventEntityDetail

Bases: BackboneElement

Tagged value pairs for conveying additional information about the entity.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	String | None	Name of the property	None
type_ext	Element | None	Placeholder element for type extensions	None
valueString	String | None	Property value	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueBase64Binary	Base64Binary | None	Property value	None
valueBase64Binary_ext	Element | None	Placeholder element for valueBase64Binary extensions	None

AuditEventSource

Path: fhircraft.fhir.resources.datatypes.R4.core.audit_event.AuditEventSource

Bases: BackboneElement

The system that is reporting the event.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
site	String | None	Logical source location within the enterprise	None
site_ext	Element | None	Placeholder element for site extensions	None
observer	Reference | None	The identity of source detecting the event	None
type	List[Coding] | None	The type of source where event originated	None

Basic

Path: fhircraft.fhir.resources.datatypes.R4.core.basic.Basic

Bases: DomainResource

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Basic'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
code	CodeableConcept | None	Kind of Resource	None
subject	Reference | None	Identifies the focus of this resource	None
created	Date | None	When created	None
created_ext	Element | None	Placeholder element for created extensions	None
author	Reference | None	Who created	None
resourceType	Literal['Basic']		'Basic'

Binary

Path: fhircraft.fhir.resources.datatypes.R4.core.binary.Binary

Bases: Resource

A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Binary'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
contentType	Code | None	MimeType of the binary content	None
contentType_ext	Element | None	Placeholder element for contentType extensions	None
securityContext	Reference | None	Identifies another resource to use as proxy when enforcing access control	None
data	Base64Binary | None	The actual content	None
data_ext	Element | None	Placeholder element for data extensions	None
resourceType	Literal['Binary']		'Binary'

BiologicallyDerivedProduct

Path: fhircraft.fhir.resources.datatypes.R4.core.biologically_derived_product.BiologicallyDerivedProduct

Bases: DomainResource

A material substance originating from a biological entity intended to be transplanted or infused

into another (possibly the same) biological entity.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External ids for this item	None
productCategory	Code | None	organ | tissue | fluid | cells | biologicalAgent	None
productCategory_ext	Element | None	Placeholder element for productCategory extensions	None
productCode	CodeableConcept | None	What this biologically derived product is	None
status	Code | None	available | unavailable	None
status_ext	Element | None	Placeholder element for status extensions	None
request	List[Reference] | None	Procedure request	None
quantity	Integer | None	The amount of this biologically derived product	None
quantity_ext	Element | None	Placeholder element for quantity extensions	None
parent	List[Reference] | None	BiologicallyDerivedProduct parent	None
collection	BiologicallyDerivedProductCollection | None	How this product was collected	None
processing	List[BiologicallyDerivedProductProcessing] | None	Any processing of the product during collection	None
manipulation	BiologicallyDerivedProductManipulation | None	Any manipulation of product post-collection	None
storage	List[BiologicallyDerivedProductStorage] | None	Product storage	None
resourceType	Literal['BiologicallyDerivedProduct']		'BiologicallyDerivedProduct'

BiologicallyDerivedProductCollection

Path: fhircraft.fhir.resources.datatypes.R4.core.biologically_derived_product.BiologicallyDerivedProductCollection

Bases: BackboneElement

How this product was collected.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
collector	Reference | None	Individual performing collection	None
source	Reference | None	Who is product from	None
collectedDateTime	DateTime | None	Time of product collection	None
collectedDateTime_ext	Element | None	Placeholder element for collectedDateTime extensions	None
collectedPeriod	Period | None	Time of product collection	None

BiologicallyDerivedProductManipulation

Path: fhircraft.fhir.resources.datatypes.R4.core.biologically_derived_product.BiologicallyDerivedProductManipulation

Bases: BackboneElement

Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of manipulation	None
description_ext	Element | None	Placeholder element for description extensions	None
timeDateTime	DateTime | None	Time of manipulation	None
timeDateTime_ext	Element | None	Placeholder element for timeDateTime extensions	None
timePeriod	Period | None	Time of manipulation	None

BiologicallyDerivedProductProcessing

Path: fhircraft.fhir.resources.datatypes.R4.core.biologically_derived_product.BiologicallyDerivedProductProcessing

Bases: BackboneElement

Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of of processing	None
description_ext	Element | None	Placeholder element for description extensions	None
procedure	CodeableConcept | None	Procesing code	None
additive	Reference | None	Substance added during processing	None
timeDateTime	DateTime | None	Time of processing	None
timeDateTime_ext	Element | None	Placeholder element for timeDateTime extensions	None
timePeriod	Period | None	Time of processing	None

BiologicallyDerivedProductStorage

Path: fhircraft.fhir.resources.datatypes.R4.core.biologically_derived_product.BiologicallyDerivedProductStorage

Bases: BackboneElement

Product storage.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of storage	None
description_ext	Element | None	Placeholder element for description extensions	None
temperature	Decimal | None	Storage temperature	None
temperature_ext	Element | None	Placeholder element for temperature extensions	None
scale	Code | None	farenheit | celsius | kelvin	None
scale_ext	Element | None	Placeholder element for scale extensions	None
duration	Period | None	Storage timeperiod	None

BodyStructure

Path: fhircraft.fhir.resources.datatypes.R4.core.body_structure.BodyStructure

Bases: DomainResource

Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/BodyStructure'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Bodystructure identifier	None
active	Boolean | None	Whether this record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
morphology	CodeableConcept | None	Kind of Structure	None
location	CodeableConcept | None	Body site	None
locationQualifier	List[CodeableConcept] | None	Body site modifier	None
description	String | None	Text description	None
description_ext	Element | None	Placeholder element for description extensions	None
image	List[Attachment] | None	Attached images	None
patient	Reference | None	Who this is about	None
resourceType	Literal['BodyStructure']		'BodyStructure'

Bundle

Path: fhircraft.fhir.resources.datatypes.R4.core.bundle.Bundle

Bases: Resource

A container for a collection of resources.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Bundle'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
identifier	Identifier | None	Persistent identifier for the bundle	None
type	Code | None	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection	None
type_ext	Element | None	Placeholder element for type extensions	None
timestamp	Instant | None	When the bundle was assembled	None
timestamp_ext	Element | None	Placeholder element for timestamp extensions	None
total	UnsignedInt | None	If search, the total number of matches	None
total_ext	Element | None	Placeholder element for total extensions	None
link	List[BundleLink] | None	Links related to this Bundle	None
entry	List[BundleEntry] | None	Entry in the bundle - will have a resource or information	None
signature	Signature | None	Digital Signature	None
resourceType	Literal['Bundle']		'Bundle'

BundleEntry

Path: fhircraft.fhir.resources.datatypes.R4.core.bundle.BundleEntry

Bases: BackboneElement

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
link	List[BundleEntryLink] | None	Links related to this entry	None
fullUrl	Uri | None	URI for resource (Absolute URL server address or URI for UUID/OID)	None
fullUrl_ext	Element | None	Placeholder element for fullUrl extensions	None
resource	Resource | None	A resource in the bundle	None
search	BundleEntrySearch | None	Search related information	None
request	BundleEntryRequest | None	Additional execution information (transaction/batch/history)	None
response	BundleEntryResponse | None	Results of execution (transaction/batch/history)	None

BundleEntryLink

Path: fhircraft.fhir.resources.datatypes.R4.core.bundle.BundleEntryLink

Bases: BackboneElement

A series of links that provide context to this entry.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
relation	String | None	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1	None
relation_ext	Element | None	Placeholder element for relation extensions	None
url	Uri | None	Reference details for the link	None
url_ext	Element | None	Placeholder element for url extensions	None

BundleEntryRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.bundle.BundleEntryRequest

Bases: BackboneElement

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
method	Code | None	GET | HEAD | POST | PUT | DELETE | PATCH	None
method_ext	Element | None	Placeholder element for method extensions	None
url	Uri | None	URL for HTTP equivalent of this entry	None
url_ext	Element | None	Placeholder element for url extensions	None
ifNoneMatch	String | None	For managing cache currency	None
ifNoneMatch_ext	Element | None	Placeholder element for ifNoneMatch extensions	None
ifModifiedSince	Instant | None	For managing cache currency	None
ifModifiedSince_ext	Element | None	Placeholder element for ifModifiedSince extensions	None
ifMatch	String | None	For managing update contention	None
ifMatch_ext	Element | None	Placeholder element for ifMatch extensions	None
ifNoneExist	String | None	For conditional creates	None
ifNoneExist_ext	Element | None	Placeholder element for ifNoneExist extensions	None

BundleEntryResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.bundle.BundleEntryResponse

Bases: BackboneElement

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
status	String | None	Status response code (text optional)	None
status_ext	Element | None	Placeholder element for status extensions	None
location	Uri | None	The location (if the operation returns a location)	None
location_ext	Element | None	Placeholder element for location extensions	None
etag	String | None	The Etag for the resource (if relevant)	None
etag_ext	Element | None	Placeholder element for etag extensions	None
lastModified	Instant | None	Server's date time modified	None
lastModified_ext	Element | None	Placeholder element for lastModified extensions	None
outcome	Resource | None	OperationOutcome with hints and warnings (for batch/transaction)	None

BundleEntrySearch

Path: fhircraft.fhir.resources.datatypes.R4.core.bundle.BundleEntrySearch

Bases: BackboneElement

Information about the search process that lead to the creation of this entry.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
mode	Code | None	match | include | outcome - why this is in the result set	None
mode_ext	Element | None	Placeholder element for mode extensions	None
score	Decimal | None	Search ranking (between 0 and 1)	None
score_ext	Element | None	Placeholder element for score extensions	None

BundleLink

Path: fhircraft.fhir.resources.datatypes.R4.core.bundle.BundleLink

Bases: BackboneElement

A series of links that provide context to this bundle.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
relation	String | None	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1	None
relation_ext	Element | None	Placeholder element for relation extensions	None
url	Uri | None	Reference details for the link	None
url_ext	Element | None	Placeholder element for url extensions	None

CapabilityStatement

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatement

Bases: DomainResource

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CapabilityStatement'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this capability statement, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the capability statement	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this capability statement (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this capability statement (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the capability statement	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for capability statement (if applicable)	None
purpose	Markdown | None	Why this capability statement is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
kind	Code | None	instance | capability | requirements	None
kind_ext	Element | None	Placeholder element for kind extensions	None
instantiates	List[Canonical] | None	Canonical URL of another capability statement this implements	None
instantiates_ext	Element | None	Placeholder element for instantiates extensions	None
imports	List[Canonical] | None	Canonical URL of another capability statement this adds to	None
imports_ext	Element | None	Placeholder element for imports extensions	None
software	CapabilityStatementSoftware | None	Software that is covered by this capability statement	None
implementation	CapabilityStatementImplementation | None	If this describes a specific instance	None
fhirVersion	Code | None	FHIR Version the system supports	None
fhirVersion_ext	Element | None	Placeholder element for fhirVersion extensions	None
format	List[Code] | None	formats supported (xml | json | ttl | mime type)	None
format_ext	Element | None	Placeholder element for format extensions	None
patchFormat	List[Code] | None	Patch formats supported	None
patchFormat_ext	Element | None	Placeholder element for patchFormat extensions	None
implementationGuide	List[Canonical] | None	Implementation guides supported	None
implementationGuide_ext	Element | None	Placeholder element for implementationGuide extensions	None
rest	List[CapabilityStatementRest] | None	If the endpoint is a RESTful one	None
messaging	List[CapabilityStatementMessaging] | None	If messaging is supported	None
document	List[CapabilityStatementDocument] | None	Document definition	None
resourceType	Literal['CapabilityStatement']		'CapabilityStatement'

CapabilityStatementDocument

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementDocument

Bases: BackboneElement

A document definition.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
mode	Code | None	producer | consumer	None
mode_ext	Element | None	Placeholder element for mode extensions	None
documentation	Markdown | None	Description of document support	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None
profile	Canonical | None	Constraint on the resources used in the document	None
profile_ext	Element | None	Placeholder element for profile extensions	None

CapabilityStatementImplementation

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementImplementation

Bases: BackboneElement

Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Describes this specific instance	None
description_ext	Element | None	Placeholder element for description extensions	None
url	Url | None	Base URL for the installation	None
url_ext	Element | None	Placeholder element for url extensions	None
custodian	Reference | None	Organization that manages the data	None

CapabilityStatementMessaging

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementMessaging

Bases: BackboneElement

A description of the messaging capabilities of the solution.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
endpoint	List[CapabilityStatementMessagingEndpoint] | None	Where messages should be sent	None
reliableCache	UnsignedInt | None	Reliable Message Cache Length (min)	None
reliableCache_ext	Element | None	Placeholder element for reliableCache extensions	None
documentation	Markdown | None	Messaging interface behavior details	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None
supportedMessage	List[CapabilityStatementMessagingSupportedMessage] | None	Messages supported by this system	None

CapabilityStatementMessagingEndpoint

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementMessagingEndpoint

Bases: BackboneElement

An endpoint (network accessible address) to which messages and/or replies are to be sent.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
protocol	Coding | None	http | ftp | mllp +	None
address	Url | None	Network address or identifier of the end-point	None
address_ext	Element | None	Placeholder element for address extensions	None

CapabilityStatementMessagingSupportedMessage

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementMessagingSupportedMessage

Bases: BackboneElement

References to message definitions for messages this system can send or receive.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
mode	Code | None	sender | receiver	None
mode_ext	Element | None	Placeholder element for mode extensions	None
definition	Canonical | None	Message supported by this system	None
definition_ext	Element | None	Placeholder element for definition extensions	None

CapabilityStatementRest

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRest

Bases: BackboneElement

A definition of the restful capabilities of the solution, if any.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
mode	Code | None	client | server	None
mode_ext	Element | None	Placeholder element for mode extensions	None
documentation	Markdown | None	General description of implementation	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None
security	CapabilityStatementRestSecurity | None	Information about security of implementation	None
resource	List[CapabilityStatementRestResource] | None	Resource served on the REST interface	None
interaction	List[CapabilityStatementRestInteraction] | None	What operations are supported?	None
searchParam	List[CapabilityStatementRestSearchParam] | None	Search parameters for searching all resources	None
operation	List[CapabilityStatementRestOperation] | None	Definition of a system level operation	None
compartment	List[Canonical] | None	Compartments served/used by system	None
compartment_ext	Element | None	Placeholder element for compartment extensions	None

CapabilityStatementRestInteraction

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestInteraction

Bases: BackboneElement

A specification of restful operations supported by the system.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	transaction | batch | search-system | history-system	None
code_ext	Element | None	Placeholder element for code extensions	None
documentation	Markdown | None	Anything special about operation behavior	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

CapabilityStatementRestOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestOperation

Bases: BackboneElement

Definition of an operation or a named query together with its parameters and their meaning and type.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name by which the operation/query is invoked	None
name_ext	Element | None	Placeholder element for name extensions	None
definition	Canonical | None	The defined operation/query	None
definition_ext	Element | None	Placeholder element for definition extensions	None
documentation	Markdown | None	Specific details about operation behavior	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

CapabilityStatementRestResource

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestResource

Bases: BackboneElement

A specification of the restful capabilities of the solution for a specific resource type.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	A resource type that is supported	None
type_ext	Element | None	Placeholder element for type extensions	None
profile	Canonical | None	Base System profile for all uses of resource	None
profile_ext	Element | None	Placeholder element for profile extensions	None
supportedProfile	List[Canonical] | None	Profiles for use cases supported	None
supportedProfile_ext	Element | None	Placeholder element for supportedProfile extensions	None
documentation	Markdown | None	Additional information about the use of the resource type	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None
interaction	List[CapabilityStatementRestResourceInteraction] | None	What operations are supported?	None
versioning	Code | None	no-version | versioned | versioned-update	None
versioning_ext	Element | None	Placeholder element for versioning extensions	None
readHistory	Boolean | None	Whether vRead can return past versions	None
readHistory_ext	Element | None	Placeholder element for readHistory extensions	None
updateCreate	Boolean | None	If update can commit to a new identity	None
updateCreate_ext	Element | None	Placeholder element for updateCreate extensions	None
conditionalCreate	Boolean | None	If allows/uses conditional create	None
conditionalCreate_ext	Element | None	Placeholder element for conditionalCreate extensions	None
conditionalRead	Code | None	not-supported | modified-since | not-match | full-support	None
conditionalRead_ext	Element | None	Placeholder element for conditionalRead extensions	None
conditionalUpdate	Boolean | None	If allows/uses conditional update	None
conditionalUpdate_ext	Element | None	Placeholder element for conditionalUpdate extensions	None
conditionalDelete	Code | None	not-supported | single | multiple - how conditional delete is supported	None
conditionalDelete_ext	Element | None	Placeholder element for conditionalDelete extensions	None
referencePolicy	List[Code] | None	literal | logical | resolves | enforced | local	None
referencePolicy_ext	Element | None	Placeholder element for referencePolicy extensions	None
searchInclude	List[String] | None	_include values supported by the server	None
searchInclude_ext	Element | None	Placeholder element for searchInclude extensions	None
searchRevInclude	List[String] | None	_revinclude values supported by the server	None
searchRevInclude_ext	Element | None	Placeholder element for searchRevInclude extensions	None
searchParam	List[CapabilityStatementRestResourceSearchParam] | None	Search parameters supported by implementation	None
operation	List[CapabilityStatementRestResourceOperation] | None	Definition of a resource operation	None

CapabilityStatementRestResourceInteraction

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestResourceInteraction

Bases: BackboneElement

Identifies a restful operation supported by the solution.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	read | vread | update | patch | delete | history-instance | history-type | create | search-type	None
code_ext	Element | None	Placeholder element for code extensions	None
documentation	Markdown | None	Anything special about operation behavior	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

CapabilityStatementRestResourceOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestResourceOperation

Bases: BackboneElement

Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name by which the operation/query is invoked	None
name_ext	Element | None	Placeholder element for name extensions	None
definition	Canonical | None	The defined operation/query	None
definition_ext	Element | None	Placeholder element for definition extensions	None
documentation	Markdown | None	Specific details about operation behavior	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

CapabilityStatementRestResourceSearchParam

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestResourceSearchParam

Bases: BackboneElement

Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name of search parameter	None
name_ext	Element | None	Placeholder element for name extensions	None
definition	Canonical | None	Source of definition for parameter	None
definition_ext	Element | None	Placeholder element for definition extensions	None
type	Code | None	number | date | string | token | reference | composite | quantity | uri | special	None
type_ext	Element | None	Placeholder element for type extensions	None
documentation	Markdown | None	Server-specific usage	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

CapabilityStatementRestSearchParam

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestSearchParam

Bases: BackboneElement

Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name of search parameter	None
name_ext	Element | None	Placeholder element for name extensions	None
definition	Canonical | None	Source of definition for parameter	None
definition_ext	Element | None	Placeholder element for definition extensions	None
type	Code | None	number | date | string | token | reference | composite | quantity | uri | special	None
type_ext	Element | None	Placeholder element for type extensions	None
documentation	Markdown | None	Server-specific usage	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

CapabilityStatementRestSecurity

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementRestSecurity

Bases: BackboneElement

Information about security implementation from an interface perspective - what a client needs to know.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
cors	Boolean | None	Adds CORS Headers (http://enable-cors.org/)	None
cors_ext	Element | None	Placeholder element for cors extensions	None
service	List[CodeableConcept] | None	OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates	None
description	Markdown | None	General description of how security works	None
description_ext	Element | None	Placeholder element for description extensions	None

CapabilityStatementSoftware

Path: fhircraft.fhir.resources.datatypes.R4.core.capability_statement.CapabilityStatementSoftware

Bases: BackboneElement

Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	A name the software is known by	None
name_ext	Element | None	Placeholder element for name extensions	None
version	String | None	Version covered by this statement	None
version_ext	Element | None	Placeholder element for version extensions	None
releaseDate	DateTime | None	Date this version was released	None
releaseDate_ext	Element | None	Placeholder element for releaseDate extensions	None

CarePlan

Path: fhircraft.fhir.resources.datatypes.R4.core.care_plan.CarePlan

Bases: DomainResource

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CarePlan'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this plan	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	Fulfills CarePlan	None
replaces	List[Reference] | None	CarePlan replaced by this CarePlan	None
partOf	List[Reference] | None	Part of referenced CarePlan	None
status	Code | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
intent	Code | None	proposal | plan | order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
category	List[CodeableConcept] | None	Type of plan	None
title	String | None	Human-friendly name for the care plan	None
title_ext	Element | None	Placeholder element for title extensions	None
description	String | None	Summary of nature of plan	None
description_ext	Element | None	Placeholder element for description extensions	None
subject	Reference | None	Who the care plan is for	None
encounter	Reference | None	Encounter created as part of	None
period	Period | None	Time period plan covers	None
created	DateTime | None	Date record was first recorded	None
created_ext	Element | None	Placeholder element for created extensions	None
author	Reference | None	Who is the designated responsible party	None
contributor	List[Reference] | None	Who provided the content of the care plan	None
careTeam	List[Reference] | None	Who's involved in plan?	None
addresses	List[Reference] | None	Health issues this plan addresses	None
supportingInfo	List[Reference] | None	Information considered as part of plan	None
goal	List[Reference] | None	Desired outcome of plan	None
activity	List[CarePlanActivity] | None	Action to occur as part of plan	None
note	List[Annotation] | None	Comments about the plan	None
resourceType	Literal['CarePlan']		'CarePlan'

CarePlanActivity

Path: fhircraft.fhir.resources.datatypes.R4.core.care_plan.CarePlanActivity

Bases: BackboneElement

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
outcomeCodeableConcept	List[CodeableConcept] | None	Results of the activity	None
outcomeReference	List[Reference] | None	Appointment, Encounter, Procedure, etc.	None
progress	List[Annotation] | None	Comments about the activity status/progress	None
reference	Reference | None	Activity details defined in specific resource	None
detail	CarePlanActivityDetail | None	In-line definition of activity	None

CarePlanActivityDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.care_plan.CarePlanActivityDetail

Bases: BackboneElement

A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
kind	Code | None	Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription	None
kind_ext	Element | None	Placeholder element for kind extensions	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
code	CodeableConcept | None	Detail type of activity	None
reasonCode	List[CodeableConcept] | None	Why activity should be done or why activity was prohibited	None
reasonReference	List[Reference] | None	Why activity is needed	None
goal	List[Reference] | None	Goals this activity relates to	None
status	Code | None	not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason for current status	None
doNotPerform	Boolean | None	If true, activity is prohibiting action	None
doNotPerform_ext	Element | None	Placeholder element for doNotPerform extensions	None
scheduledTiming	Timing | None	When activity is to occur	None
scheduledPeriod	Period | None	When activity is to occur	None
scheduledString	String | None	When activity is to occur	None
scheduledString_ext	Element | None	Placeholder element for scheduledString extensions	None
location	Reference | None	Where it should happen	None
performer	List[Reference] | None	Who will be responsible?	None
productCodeableConcept	CodeableConcept | None	What is to be administered/supplied	None
productReference	Reference | None	What is to be administered/supplied	None
dailyAmount	Quantity | None	How to consume/day?	None
quantity	Quantity | None	How much to administer/supply/consume	None
description	String | None	Extra info describing activity to perform	None
description_ext	Element | None	Placeholder element for description extensions	None

CareTeam

Path: fhircraft.fhir.resources.datatypes.R4.core.care_team.CareTeam

Bases: DomainResource

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CareTeam'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this team	None
status	Code | None	proposed | active | suspended | inactive | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
category	List[CodeableConcept] | None	Type of team	None
name	String | None	Name of the team, such as crisis assessment team	None
name_ext	Element | None	Placeholder element for name extensions	None
subject	Reference | None	Who care team is for	None
encounter	Reference | None	Encounter created as part of	None
period	Period | None	Time period team covers	None
participant	List[CareTeamParticipant] | None	Members of the team	None
reasonCode	List[CodeableConcept] | None	Why the care team exists	None
reasonReference	List[Reference] | None	Why the care team exists	None
managingOrganization	List[Reference] | None	Organization responsible for the care team	None
telecom	List[ContactPoint] | None	A contact detail for the care team (that applies to all members)	None
note	List[Annotation] | None	Comments made about the CareTeam	None
resourceType	Literal['CareTeam']		'CareTeam'

CareTeamParticipant

Path: fhircraft.fhir.resources.datatypes.R4.core.care_team.CareTeamParticipant

Bases: BackboneElement

Identifies all people and organizations who are expected to be involved in the care team.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
role	List[CodeableConcept] | None	Type of involvement	None
member	Reference | None	Who is involved	None
onBehalfOf	Reference | None	Organization of the practitioner	None
period	Period | None	Time period of participant	None

CatalogEntry

Path: fhircraft.fhir.resources.datatypes.R4.core.catalog_entry.CatalogEntry

Bases: DomainResource

Catalog entries are wrappers that contextualize items included in a catalog.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CatalogEntry'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique identifier of the catalog item	None
type	CodeableConcept | None	The type of item - medication, device, service, protocol or other	None
orderable	Boolean | None	Whether the entry represents an orderable item	None
orderable_ext	Element | None	Placeholder element for orderable extensions	None
referencedItem	Reference | None	The item that is being defined	None
additionalIdentifier	List[Identifier] | None	Any additional identifier(s) for the catalog item, in the same granularity or concept	None
classification	List[CodeableConcept] | None	Classification (category or class) of the item entry	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
validityPeriod	Period | None	The time period in which this catalog entry is expected to be active	None
validTo	DateTime | None	The date until which this catalog entry is expected to be active	None
validTo_ext	Element | None	Placeholder element for validTo extensions	None
lastUpdated	DateTime | None	When was this catalog last updated	None
lastUpdated_ext	Element | None	Placeholder element for lastUpdated extensions	None
additionalCharacteristic	List[CodeableConcept] | None	Additional characteristics of the catalog entry	None
additionalClassification	List[CodeableConcept] | None	Additional classification of the catalog entry	None
relatedEntry	List[CatalogEntryRelatedEntry] | None	An item that this catalog entry is related to	None
resourceType	Literal['CatalogEntry']		'CatalogEntry'

CatalogEntryRelatedEntry

Path: fhircraft.fhir.resources.datatypes.R4.core.catalog_entry.CatalogEntryRelatedEntry

Bases: BackboneElement

Used for example, to point to a substance, or to a device used to administer a medication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
relationtype	Code | None	triggers | is-replaced-by	None
relationtype_ext	Element | None	Placeholder element for relationtype extensions	None
item	Reference | None	The reference to the related item	None

ChargeItem

Path: fhircraft.fhir.resources.datatypes.R4.core.charge_item.ChargeItem

Bases: DomainResource

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ChargeItem'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for item	None
definitionUri	List[Uri] | None	Defining information about the code of this charge item	None
definitionUri_ext	Element | None	Placeholder element for definitionUri extensions	None
definitionCanonical	List[Canonical] | None	Resource defining the code of this ChargeItem	None
definitionCanonical_ext	Element | None	Placeholder element for definitionCanonical extensions	None
status	Code | None	planned | billable | not-billable | aborted | billed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
partOf	List[Reference] | None	Part of referenced ChargeItem	None
code	CodeableConcept | None	A code that identifies the charge, like a billing code	None
subject	Reference | None	Individual service was done for/to	None
context	Reference | None	Encounter / Episode associated with event	None
occurrenceDateTime	DateTime | None	When the charged service was applied	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	When the charged service was applied	None
occurrenceTiming	Timing | None	When the charged service was applied	None
performer	List[ChargeItemPerformer] | None	Who performed charged service	None
performingOrganization	Reference | None	Organization providing the charged service	None
requestingOrganization	Reference | None	Organization requesting the charged service	None
costCenter	Reference | None	Organization that has ownership of the (potential, future) revenue	None
quantity	Quantity | None	Quantity of which the charge item has been serviced	None
bodysite	List[CodeableConcept] | None	Anatomical location, if relevant	None
factorOverride	Decimal | None	Factor overriding the associated rules	None
factorOverride_ext	Element | None	Placeholder element for factorOverride extensions	None
priceOverride	Money | None	Price overriding the associated rules	None
overrideReason	String | None	Reason for overriding the list price/factor	None
overrideReason_ext	Element | None	Placeholder element for overrideReason extensions	None
enterer	Reference | None	Individual who was entering	None
enteredDate	DateTime | None	Date the charge item was entered	None
enteredDate_ext	Element | None	Placeholder element for enteredDate extensions	None
reason	List[CodeableConcept] | None	Why was the charged service rendered?	None
service	List[Reference] | None	Which rendered service is being charged?	None
productReference	Reference | None	Product charged	None
productCodeableConcept	CodeableConcept | None	Product charged	None
account	List[Reference] | None	Account to place this charge	None
note	List[Annotation] | None	Comments made about the ChargeItem	None
supportingInformation	List[Reference] | None	Further information supporting this charge	None
resourceType	Literal['ChargeItem']		'ChargeItem'

ChargeItemPerformer

Path: fhircraft.fhir.resources.datatypes.R4.core.charge_item.ChargeItemPerformer

Bases: BackboneElement

Indicates who or what performed or participated in the charged service.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
function	CodeableConcept | None	What type of performance was done	None
actor	Reference | None	Individual who was performing	None

ChargeItemDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.charge_item_definition.ChargeItemDefinition

Bases: DomainResource

The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this charge item definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the charge item definition	None
version	String | None	Business version of the charge item definition	None
version_ext	Element | None	Placeholder element for version extensions	None
title	String | None	Name for this charge item definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
derivedFromUri	List[Uri] | None	Underlying externally-defined charge item definition	None
derivedFromUri_ext	Element | None	Placeholder element for derivedFromUri extensions	None
partOf	List[Canonical] | None	A larger definition of which this particular definition is a component or step	None
partOf_ext	Element | None	Placeholder element for partOf extensions	None
replaces	List[Canonical] | None	Completed or terminated request(s) whose function is taken by this new request	None
replaces_ext	Element | None	Placeholder element for replaces extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the charge item definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for charge item definition (if applicable)	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the charge item definition was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the charge item definition was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the charge item definition is expected to be used	None
code	CodeableConcept | None	Billing codes or product types this definition applies to	None
instance	List[Reference] | None	Instances this definition applies to	None
applicability	List[ChargeItemDefinitionApplicability] | None	Whether or not the billing code is applicable	None
propertyGroup	List[ChargeItemDefinitionPropertyGroup] | None	Group of properties which are applicable under the same conditions	None
resourceType	Literal['ChargeItemDefinition']		'ChargeItemDefinition'

ChargeItemDefinitionApplicability

Path: fhircraft.fhir.resources.datatypes.R4.core.charge_item_definition.ChargeItemDefinitionApplicability

Bases: BackboneElement

Expressions that describe applicability criteria for the billing code.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Natural language description of the condition	None
description_ext	Element | None	Placeholder element for description extensions	None
language	String | None	Language of the expression	None
language_ext	Element | None	Placeholder element for language extensions	None
expression	String | None	Boolean-valued expression	None
expression_ext	Element | None	Placeholder element for expression extensions	None

ChargeItemDefinitionPropertyGroup

Path: fhircraft.fhir.resources.datatypes.R4.core.charge_item_definition.ChargeItemDefinitionPropertyGroup

Bases: BackboneElement

Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
applicability	List[ChargeItemDefinitionPropertyGroupApplicability] | None	Conditions under which the priceComponent is applicable	None
priceComponent	List[ChargeItemDefinitionPropertyGroupPriceComponent] | None	Components of total line item price	None

ChargeItemDefinitionPropertyGroupApplicability

Path: fhircraft.fhir.resources.datatypes.R4.core.charge_item_definition.ChargeItemDefinitionPropertyGroupApplicability

Bases: BackboneElement

Expressions that describe applicability criteria for the priceComponent.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Natural language description of the condition	None
description_ext	Element | None	Placeholder element for description extensions	None
language	String | None	Language of the expression	None
language_ext	Element | None	Placeholder element for language extensions	None
expression	String | None	Boolean-valued expression	None
expression_ext	Element | None	Placeholder element for expression extensions	None

ChargeItemDefinitionPropertyGroupPriceComponent

Path: fhircraft.fhir.resources.datatypes.R4.core.charge_item_definition.ChargeItemDefinitionPropertyGroupPriceComponent

Bases: BackboneElement

The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	base | surcharge | deduction | discount | tax | informational	None
type_ext	Element | None	Placeholder element for type extensions	None
code	CodeableConcept | None	Code identifying the specific component	None
factor	Decimal | None	Factor used for calculating this component	None
factor_ext	Element | None	Placeholder element for factor extensions	None
amount	Money | None	Monetary amount associated with this component	None

Claim

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.Claim

Bases: DomainResource

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Claim'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for claim	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	Category or discipline	None
subType	CodeableConcept | None	More granular claim type	None
use	Code | None	claim | preauthorization | predetermination	None
use_ext	Element | None	Placeholder element for use extensions	None
patient	Reference | None	The recipient of the products and services	None
billablePeriod	Period | None	Relevant time frame for the claim	None
created	DateTime | None	Resource creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
enterer	Reference | None	Author of the claim	None
insurer	Reference | None	Target	None
provider	Reference | None	Party responsible for the claim	None
priority	CodeableConcept | None	Desired processing ugency	None
fundsReserve	CodeableConcept | None	For whom to reserve funds	None
related	List[ClaimRelated] | None	Prior or corollary claims	None
prescription	Reference | None	Prescription authorizing services and products	None
originalPrescription	Reference | None	Original prescription if superseded by fulfiller	None
payee	ClaimPayee | None	Recipient of benefits payable	None
referral	Reference | None	Treatment referral	None
facility	Reference | None	Servicing facility	None
careTeam	List[ClaimCareTeam] | None	Members of the care team	None
supportingInfo	List[ClaimSupportingInfo] | None	Supporting information	None
diagnosis	List[ClaimDiagnosis] | None	Pertinent diagnosis information	None
procedure	List[ClaimProcedure] | None	Clinical procedures performed	None
insurance	List[ClaimInsurance] | None	Patient insurance information	None
accident	ClaimAccident | None	Details of the event	None
item	List[ClaimItem] | None	Product or service provided	None
total	Money | None	Total claim cost	None
resourceType	Literal['Claim']		'Claim'

ClaimAccident

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimAccident

Bases: BackboneElement

Details of an accident which resulted in injuries which required the products and services listed in the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
date	Date | None	When the incident occurred	None
date_ext	Element | None	Placeholder element for date extensions	None
type	CodeableConcept | None	The nature of the accident	None
locationAddress	Address | None	Where the event occurred	None
locationReference	Reference | None	Where the event occurred	None

ClaimCareTeam

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimCareTeam

Bases: BackboneElement

The members of the team who provided the products and services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Order of care team	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
provider	Reference | None	Practitioner or organization	None
responsible	Boolean | None	Indicator of the lead practitioner	None
responsible_ext	Element | None	Placeholder element for responsible extensions	None
role	CodeableConcept | None	Function within the team	None
qualification	CodeableConcept | None	Practitioner credential or specialization	None

ClaimDiagnosis

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimDiagnosis

Bases: BackboneElement

Information about diagnoses relevant to the claim items.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Diagnosis instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
diagnosisCodeableConcept	CodeableConcept | None	Nature of illness or problem	None
diagnosisReference	Reference | None	Nature of illness or problem	None
type	List[CodeableConcept] | None	Timing or nature of the diagnosis	None
onAdmission	CodeableConcept | None	Present on admission	None
packageCode	CodeableConcept | None	Package billing code	None

ClaimInsurance

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimInsurance

Bases: BackboneElement

Financial instruments for reimbursement for the health care products and services specified on the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Insurance instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
focal	Boolean | None	Coverage to be used for adjudication	None
focal_ext	Element | None	Placeholder element for focal extensions	None
identifier	Identifier | None	Pre-assigned Claim number	None
coverage	Reference | None	Insurance information	None
businessArrangement	String | None	Additional provider contract number	None
businessArrangement_ext	Element | None	Placeholder element for businessArrangement extensions	None
preAuthRef	List[String] | None	Prior authorization reference number	None
preAuthRef_ext	Element | None	Placeholder element for preAuthRef extensions	None
claimResponse	Reference | None	Adjudication results	None

ClaimItem

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimItem

Bases: BackboneElement

A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Item instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
careTeamSequence	List[PositiveInt] | None	Applicable careTeam members	None
careTeamSequence_ext	Element | None	Placeholder element for careTeamSequence extensions	None
diagnosisSequence	List[PositiveInt] | None	Applicable diagnoses	None
diagnosisSequence_ext	Element | None	Placeholder element for diagnosisSequence extensions	None
procedureSequence	List[PositiveInt] | None	Applicable procedures	None
procedureSequence_ext	Element | None	Placeholder element for procedureSequence extensions	None
informationSequence	List[PositiveInt] | None	Applicable exception and supporting information	None
informationSequence_ext	Element | None	Placeholder element for informationSequence extensions	None
revenue	CodeableConcept | None	Revenue or cost center code	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Product or service billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
servicedDate	Date | None	Date or dates of service or product delivery	None
servicedDate_ext	Element | None	Placeholder element for servicedDate extensions	None
servicedPeriod	Period | None	Date or dates of service or product delivery	None
locationCodeableConcept	CodeableConcept | None	Place of service or where product was supplied	None
locationAddress	Address | None	Place of service or where product was supplied	None
locationReference	Reference | None	Place of service or where product was supplied	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
bodySite	CodeableConcept | None	Anatomical location	None
subSite	List[CodeableConcept] | None	Anatomical sub-location	None
encounter	List[Reference] | None	Encounters related to this billed item	None
detail	List[ClaimItemDetail] | None	Product or service provided	None

ClaimItemDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimItemDetail

Bases: BackboneElement

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Item instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
revenue	CodeableConcept | None	Revenue or cost center code	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
subDetail	List[ClaimItemDetailSubDetail] | None	Product or service provided	None

ClaimItemDetailSubDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimItemDetailSubDetail

Bases: BackboneElement

A claim detail line. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Item instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
revenue	CodeableConcept | None	Revenue or cost center code	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None

ClaimPayee

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimPayee

Bases: BackboneElement

The party to be reimbursed for cost of the products and services according to the terms of the policy.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Category of recipient	None
party	Reference | None	Recipient reference	None

ClaimProcedure

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimProcedure

Bases: BackboneElement

Procedures performed on the patient relevant to the billing items with the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Procedure instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
type	List[CodeableConcept] | None	Category of Procedure	None
date	DateTime | None	When the procedure was performed	None
date_ext	Element | None	Placeholder element for date extensions	None
procedureCodeableConcept	CodeableConcept | None	Specific clinical procedure	None
procedureReference	Reference | None	Specific clinical procedure	None
udi	List[Reference] | None	Unique device identifier	None

ClaimRelated

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimRelated

Bases: BackboneElement

Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
claim	Reference | None	Reference to the related claim	None
relationship	CodeableConcept | None	How the reference claim is related	None
reference	Identifier | None	File or case reference	None

ClaimSupportingInfo

Path: fhircraft.fhir.resources.datatypes.R4.core.claim.ClaimSupportingInfo

Bases: BackboneElement

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Information instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
category	CodeableConcept | None	Classification of the supplied information	None
code	CodeableConcept | None	Type of information	None
timingDate	Date | None	When it occurred	None
timingDate_ext	Element | None	Placeholder element for timingDate extensions	None
timingPeriod	Period | None	When it occurred	None
valueBoolean	Boolean | None	Data to be provided	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueString	String | None	Data to be provided	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueQuantity	Quantity | None	Data to be provided	None
valueAttachment	Attachment | None	Data to be provided	None
valueReference	Reference | None	Data to be provided	None
reason	CodeableConcept | None	Explanation for the information	None

ClaimResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponse

Bases: DomainResource

This resource provides the adjudication details from the processing of a Claim resource.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ClaimResponse'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for a claim response	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	More granular claim type	None
subType	CodeableConcept | None	More granular claim type	None
use	Code | None	claim | preauthorization | predetermination	None
use_ext	Element | None	Placeholder element for use extensions	None
patient	Reference | None	The recipient of the products and services	None
created	DateTime | None	Response creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
insurer	Reference | None	Party responsible for reimbursement	None
requestor	Reference | None	Party responsible for the claim	None
request	Reference | None	Id of resource triggering adjudication	None
outcome	Code | None	queued | complete | error | partial	None
outcome_ext	Element | None	Placeholder element for outcome extensions	None
disposition	String | None	Disposition Message	None
disposition_ext	Element | None	Placeholder element for disposition extensions	None
preAuthRef	String | None	Preauthorization reference	None
preAuthRef_ext	Element | None	Placeholder element for preAuthRef extensions	None
preAuthPeriod	Period | None	Preauthorization reference effective period	None
payeeType	CodeableConcept | None	Party to be paid any benefits payable	None
item	List[ClaimResponseItem] | None	Adjudication for claim line items	None
addItem	List[ClaimResponseAddItem] | None	Insurer added line items	None
adjudication	List[ClaimResponseItemAdjudication] | None	Header-level adjudication	None
total	List[ClaimResponseTotal] | None	Adjudication totals	None
payment	ClaimResponsePayment | None	Payment Details	None
fundsReserve	CodeableConcept | None	Funds reserved status	None
formCode	CodeableConcept | None	Printed form identifier	None
form	Attachment | None	Printed reference or actual form	None
processNote	List[ClaimResponseProcessNote] | None	Note concerning adjudication	None
communicationRequest	List[Reference] | None	Request for additional information	None
insurance	List[ClaimResponseInsurance] | None	Patient insurance information	None
error	List[ClaimResponseError] | None	Processing errors	None
resourceType	Literal['ClaimResponse']		'ClaimResponse'

ClaimResponseAddItem

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseAddItem

Bases: BackboneElement

The first-tier service adjudications for payor added product or service lines.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemSequence	List[PositiveInt] | None	Item sequence number	None
itemSequence_ext	Element | None	Placeholder element for itemSequence extensions	None
detailSequence	List[PositiveInt] | None	Detail sequence number	None
detailSequence_ext	Element | None	Placeholder element for detailSequence extensions	None
subdetailSequence	List[PositiveInt] | None	Subdetail sequence number	None
subdetailSequence_ext	Element | None	Placeholder element for subdetailSequence extensions	None
provider	List[Reference] | None	Authorized providers	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
servicedDate	Date | None	Date or dates of service or product delivery	None
servicedDate_ext	Element | None	Placeholder element for servicedDate extensions	None
servicedPeriod	Period | None	Date or dates of service or product delivery	None
locationCodeableConcept	CodeableConcept | None	Place of service or where product was supplied	None
locationAddress	Address | None	Place of service or where product was supplied	None
locationReference	Reference | None	Place of service or where product was supplied	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
bodySite	CodeableConcept | None	Anatomical location	None
subSite	List[CodeableConcept] | None	Anatomical sub-location	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ClaimResponseItemAdjudication] | None	Added items adjudication	None
detail	List[ClaimResponseAddItemDetail] | None	Insurer added line details	None

ClaimResponseAddItemDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseAddItemDetail

Bases: BackboneElement

The second-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ClaimResponseItemAdjudication] | None	Added items detail adjudication	None
subDetail	List[ClaimResponseAddItemDetailSubDetail] | None	Insurer added line items	None

ClaimResponseAddItemDetailSubDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseAddItemDetailSubDetail

Bases: BackboneElement

The third-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ClaimResponseItemAdjudication] | None	Added items detail adjudication	None

ClaimResponseError

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseError

Bases: BackboneElement

Errors encountered during the processing of the adjudication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemSequence	PositiveInt | None	Item sequence number	None
itemSequence_ext	Element | None	Placeholder element for itemSequence extensions	None
detailSequence	PositiveInt | None	Detail sequence number	None
detailSequence_ext	Element | None	Placeholder element for detailSequence extensions	None
subDetailSequence	PositiveInt | None	Subdetail sequence number	None
subDetailSequence_ext	Element | None	Placeholder element for subDetailSequence extensions	None
code	CodeableConcept | None	Error code detailing processing issues	None

ClaimResponseInsurance

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseInsurance

Bases: BackboneElement

Financial instruments for reimbursement for the health care products and services specified on the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Insurance instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
focal	Boolean | None	Coverage to be used for adjudication	None
focal_ext	Element | None	Placeholder element for focal extensions	None
coverage	Reference | None	Insurance information	None
businessArrangement	String | None	Additional provider contract number	None
businessArrangement_ext	Element | None	Placeholder element for businessArrangement extensions	None
claimResponse	Reference | None	Adjudication results	None

ClaimResponseItem

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseItem

Bases: BackboneElement

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemSequence	PositiveInt | None	Claim item instance identifier	None
itemSequence_ext	Element | None	Placeholder element for itemSequence extensions	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ClaimResponseItemAdjudication] | None	Adjudication details	None
detail	List[ClaimResponseItemDetail] | None	Adjudication for claim details	None

ClaimResponseItemAdjudication

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseItemAdjudication

Bases: BackboneElement

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Type of adjudication information	None
reason	CodeableConcept | None	Explanation of adjudication outcome	None
amount	Money | None	Monetary amount	None
value	Decimal | None	Non-monetary value	None
value_ext	Element | None	Placeholder element for value extensions	None

ClaimResponseItemDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseItemDetail

Bases: BackboneElement

A claim detail. Either a simple (a product or service) or a 'group' of sub-details which are simple items.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
detailSequence	PositiveInt | None	Claim detail instance identifier	None
detailSequence_ext	Element | None	Placeholder element for detailSequence extensions	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ClaimResponseItemDetailAdjudication] | None	Detail level adjudication details	None
subDetail	List[ClaimResponseItemDetailSubDetail] | None	Adjudication for claim sub-details	None

ClaimResponseItemDetailAdjudication

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseItemDetailAdjudication

Bases: BackboneElement

The adjudication results.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Type of adjudication information	None
reason	CodeableConcept | None	Explanation of adjudication outcome	None
amount	Money | None	Monetary amount	None
value	Decimal | None	Non-monetary value	None
value_ext	Element | None	Placeholder element for value extensions	None

ClaimResponseItemDetailSubDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseItemDetailSubDetail

Bases: BackboneElement

A sub-detail adjudication of a simple product or service.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
subDetailSequence	PositiveInt | None	Claim sub-detail instance identifier	None
subDetailSequence_ext	Element | None	Placeholder element for subDetailSequence extensions	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ClaimResponseItemAdjudication] | None	Subdetail level adjudication details	None

ClaimResponsePayment

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponsePayment

Bases: BackboneElement

Payment details for the adjudication of the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Partial or complete payment	None
adjustment	Money | None	Payment adjustment for non-claim issues	None
adjustmentReason	CodeableConcept | None	Explanation for the adjustment	None
date	Date | None	Expected date of payment	None
date_ext	Element | None	Placeholder element for date extensions	None
amount	Money | None	Payable amount after adjustment	None
identifier	Identifier | None	Business identifier for the payment	None

ClaimResponseProcessNote

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseProcessNote

Bases: BackboneElement

A note that describes or explains adjudication results in a human readable form.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
number	PositiveInt | None	Note instance identifier	None
number_ext	Element | None	Placeholder element for number extensions	None
type	Code | None	display | print | printoper	None
type_ext	Element | None	Placeholder element for type extensions	None
text	String | None	Note explanatory text	None
text_ext	Element | None	Placeholder element for text extensions	None
language	CodeableConcept | None	Language of the text	None

ClaimResponseTotal

Path: fhircraft.fhir.resources.datatypes.R4.core.claim_response.ClaimResponseTotal

Bases: BackboneElement

Categorized monetary totals for the adjudication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Type of adjudication information	None
amount	Money | None	Financial total for the category	None

ClinicalImpression

Path: fhircraft.fhir.resources.datatypes.R4.core.clinical_impression.ClinicalImpression

Bases: DomainResource

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ClinicalImpression'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
status	Code | None	in-progress | completed | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason for current status	None
code	CodeableConcept | None	Kind of assessment performed	None
description	String | None	Why/how the assessment was performed	None
description_ext	Element | None	Placeholder element for description extensions	None
subject	Reference | None	Patient or group assessed	None
encounter	Reference | None	Encounter created as part of	None
effectiveDateTime	DateTime | None	Time of assessment	None
effectiveDateTime_ext	Element | None	Placeholder element for effectiveDateTime extensions	None
effectivePeriod	Period | None	Time of assessment	None
date	DateTime | None	When the assessment was documented	None
date_ext	Element | None	Placeholder element for date extensions	None
assessor	Reference | None	The clinician performing the assessment	None
previous	Reference | None	Reference to last assessment	None
problem	List[Reference] | None	Relevant impressions of patient state	None
investigation	List[ClinicalImpressionInvestigation] | None	One or more sets of investigations (signs, symptoms, etc.)	None
protocol	List[Uri] | None	Clinical Protocol followed	None
protocol_ext	Element | None	Placeholder element for protocol extensions	None
summary	String | None	Summary of the assessment	None
summary_ext	Element | None	Placeholder element for summary extensions	None
finding	List[ClinicalImpressionFinding] | None	Possible or likely findings and diagnoses	None
prognosisCodeableConcept	List[CodeableConcept] | None	Estimate of likely outcome	None
prognosisReference	List[Reference] | None	RiskAssessment expressing likely outcome	None
supportingInfo	List[Reference] | None	Information supporting the clinical impression	None
note	List[Annotation] | None	Comments made about the ClinicalImpression	None
resourceType	Literal['ClinicalImpression']		'ClinicalImpression'

ClinicalImpressionFinding

Path: fhircraft.fhir.resources.datatypes.R4.core.clinical_impression.ClinicalImpressionFinding

Bases: BackboneElement

Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemCodeableConcept	CodeableConcept | None	What was found	None
itemReference	Reference | None	What was found	None
basis	String | None	Which investigations support finding	None
basis_ext	Element | None	Placeholder element for basis extensions	None

ClinicalImpressionInvestigation

Path: fhircraft.fhir.resources.datatypes.R4.core.clinical_impression.ClinicalImpressionInvestigation

Bases: BackboneElement

One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	A name/code for the set	None
item	List[Reference] | None	Record of a specific investigation	None

CodeSystem

Path: fhircraft.fhir.resources.datatypes.R4.core.code_system.CodeSystem

Bases: DomainResource

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CodeSystem'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the code system (business identifier)	None
version	String | None	Business version of the code system (Coding.version)	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this code system (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this code system (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the code system	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for code system (if applicable)	None
purpose	Markdown | None	Why this code system is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
caseSensitive	Boolean | None	If code comparison is case sensitive	None
caseSensitive_ext	Element | None	Placeholder element for caseSensitive extensions	None
valueSet	Canonical | None	Canonical reference to the value set with entire code system	None
valueSet_ext	Element | None	Placeholder element for valueSet extensions	None
hierarchyMeaning	Code | None	grouped-by | is-a | part-of | classified-with	None
hierarchyMeaning_ext	Element | None	Placeholder element for hierarchyMeaning extensions	None
compositional	Boolean | None	If code system defines a compositional grammar	None
compositional_ext	Element | None	Placeholder element for compositional extensions	None
versionNeeded	Boolean | None	If definitions are not stable	None
versionNeeded_ext	Element | None	Placeholder element for versionNeeded extensions	None
content	Code | None	not-present | example | fragment | complete | supplement	None
content_ext	Element | None	Placeholder element for content extensions	None
supplements	Canonical | None	Canonical URL of Code System this adds designations and properties to	None
supplements_ext	Element | None	Placeholder element for supplements extensions	None
count	UnsignedInt | None	Total concepts in the code system	None
count_ext	Element | None	Placeholder element for count extensions	None
filter	List[CodeSystemFilter] | None	Filter that can be used in a value set	None
property_	List[CodeSystemProperty] | None	Additional information supplied about each concept	None
concept	List[CodeSystemConcept] | None	Concepts in the code system	None
resourceType	Literal['CodeSystem']		'CodeSystem'

CodeSystemConcept

Path: fhircraft.fhir.resources.datatypes.R4.core.code_system.CodeSystemConcept

Bases: BackboneElement

Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Code that identifies concept	None
code_ext	Element | None	Placeholder element for code extensions	None
display	String | None	Text to display to the user	None
display_ext	Element | None	Placeholder element for display extensions	None
definition	String | None	Formal definition	None
definition_ext	Element | None	Placeholder element for definition extensions	None
designation	List[CodeSystemConceptDesignation] | None	Additional representations for the concept	None
property_	List[CodeSystemConceptProperty] | None	Property value for the concept	None
concept	List[CodeSystemConcept] | None	Child Concepts (is-a/contains/categorizes)	None

CodeSystemConceptDesignation

Path: fhircraft.fhir.resources.datatypes.R4.core.code_system.CodeSystemConceptDesignation

Bases: BackboneElement

Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
language	Code | None	Human language of the designation	None
language_ext	Element | None	Placeholder element for language extensions	None
use	Coding | None	Details how this designation would be used	None
value	String | None	The text value for this designation	None
value_ext	Element | None	Placeholder element for value extensions	None

CodeSystemConceptProperty

Path: fhircraft.fhir.resources.datatypes.R4.core.code_system.CodeSystemConceptProperty

Bases: BackboneElement

A property value for this concept.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Reference to CodeSystem.property.code	None
code_ext	Element | None	Placeholder element for code extensions	None
valueCode	Code | None	Value of the property for this concept	None
valueCode_ext	Element | None	Placeholder element for valueCode extensions	None
valueCoding	Coding | None	Value of the property for this concept	None
valueString	String | None	Value of the property for this concept	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueInteger	Integer | None	Value of the property for this concept	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueBoolean	Boolean | None	Value of the property for this concept	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueDateTime	DateTime | None	Value of the property for this concept	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueDecimal	Decimal | None	Value of the property for this concept	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None

CodeSystemFilter

Path: fhircraft.fhir.resources.datatypes.R4.core.code_system.CodeSystemFilter

Bases: BackboneElement

A filter that can be used in a value set compose statement when selecting concepts using a filter.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Code that identifies the filter	None
code_ext	Element | None	Placeholder element for code extensions	None
description	String | None	How or why the filter is used	None
description_ext	Element | None	Placeholder element for description extensions	None
operator	List[Code] | None	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists	None
operator_ext	Element | None	Placeholder element for operator extensions	None
value	String | None	What to use for the value	None
value_ext	Element | None	Placeholder element for value extensions	None

CodeSystemProperty

Path: fhircraft.fhir.resources.datatypes.R4.core.code_system.CodeSystemProperty

Bases: BackboneElement

A property defines an additional slot through which additional information can be provided about a concept.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Identifies the property on the concepts, and when referred to in operations	None
code_ext	Element | None	Placeholder element for code extensions	None
uri	Uri | None	Formal identifier for the property	None
uri_ext	Element | None	Placeholder element for uri extensions	None
description	String | None	Why the property is defined, and/or what it conveys	None
description_ext	Element | None	Placeholder element for description extensions	None
type	Code | None	code | Coding | string | integer | boolean | dateTime | decimal	None
type_ext	Element | None	Placeholder element for type extensions	None

Communication

Path: fhircraft.fhir.resources.datatypes.R4.core.communication.Communication

Bases: DomainResource

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Communication'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique identifier	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	Request fulfilled by this communication	None
partOf	List[Reference] | None	Part of this action	None
inResponseTo	List[Reference] | None	Reply to	None
status	Code | None	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason for current status	None
category	List[CodeableConcept] | None	Message category	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
medium	List[CodeableConcept] | None	A channel of communication	None
subject	Reference | None	Focus of message	None
topic	CodeableConcept | None	Description of the purpose/content	None
about	List[Reference] | None	Resources that pertain to this communication	None
encounter	Reference | None	Encounter created as part of	None
sent	DateTime | None	When sent	None
sent_ext	Element | None	Placeholder element for sent extensions	None
received	DateTime | None	When received	None
received_ext	Element | None	Placeholder element for received extensions	None
recipient	List[Reference] | None	Message recipient	None
sender	Reference | None	Message sender	None
reasonCode	List[CodeableConcept] | None	Indication for message	None
reasonReference	List[Reference] | None	Why was communication done?	None
payload	List[CommunicationPayload] | None	Message payload	None
note	List[Annotation] | None	Comments made about the communication	None
resourceType	Literal['Communication']		'Communication'

CommunicationPayload

Path: fhircraft.fhir.resources.datatypes.R4.core.communication.CommunicationPayload

Bases: BackboneElement

Text, attachment(s), or resource(s) that was communicated to the recipient.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
contentString	String | None	Message part content	None
contentString_ext	Element | None	Placeholder element for contentString extensions	None
contentAttachment	Attachment | None	Message part content	None
contentReference	Reference | None	Message part content	None

CommunicationRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.communication_request.CommunicationRequest

Bases: DomainResource

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CommunicationRequest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique identifier	None
basedOn	List[Reference] | None	Fulfills plan or proposal	None
replaces	List[Reference] | None	Request(s) replaced by this request	None
groupIdentifier	Identifier | None	Composite request this is part of	None
status	Code | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason for current status	None
category	List[CodeableConcept] | None	Message category	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
doNotPerform	Boolean | None	True if request is prohibiting action	None
doNotPerform_ext	Element | None	Placeholder element for doNotPerform extensions	None
medium	List[CodeableConcept] | None	A channel of communication	None
subject	Reference | None	Focus of message	None
about	List[Reference] | None	Resources that pertain to this communication request	None
encounter	Reference | None	Encounter created as part of	None
payload	List[CommunicationRequestPayload] | None	Message payload	None
occurrenceDateTime	DateTime | None	When scheduled	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	When scheduled	None
authoredOn	DateTime | None	When request transitioned to being actionable	None
authoredOn_ext	Element | None	Placeholder element for authoredOn extensions	None
requester	Reference | None	Who/what is requesting service	None
recipient	List[Reference] | None	Message recipient	None
sender	Reference | None	Message sender	None
reasonCode	List[CodeableConcept] | None	Why is communication needed?	None
reasonReference	List[Reference] | None	Why is communication needed?	None
note	List[Annotation] | None	Comments made about communication request	None
resourceType	Literal['CommunicationRequest']		'CommunicationRequest'

CommunicationRequestPayload

Path: fhircraft.fhir.resources.datatypes.R4.core.communication_request.CommunicationRequestPayload

Bases: BackboneElement

Text, attachment(s), or resource(s) to be communicated to the recipient.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
contentString	String | None	Message part content	None
contentString_ext	Element | None	Placeholder element for contentString extensions	None
contentAttachment	Attachment | None	Message part content	None
contentReference	Reference | None	Message part content	None

CompartmentDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.compartment_definition.CompartmentDefinition

Bases: DomainResource

A compartment definition that defines how resources are accessed on a server.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CompartmentDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this compartment definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the compartment definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this compartment definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the compartment definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
purpose	Markdown | None	Why this compartment definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
code	Code | None	Patient | Encounter | RelatedPerson | Practitioner | Device	None
code_ext	Element | None	Placeholder element for code extensions	None
search	Boolean | None	Whether the search syntax is supported	None
search_ext	Element | None	Placeholder element for search extensions	None
resource	List[CompartmentDefinitionResource] | None	How a resource is related to the compartment	None
resourceType	Literal['CompartmentDefinition']		'CompartmentDefinition'

CompartmentDefinitionResource

Path: fhircraft.fhir.resources.datatypes.R4.core.compartment_definition.CompartmentDefinitionResource

Bases: BackboneElement

Information about how a resource is related to the compartment.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Name of resource type	None
code_ext	Element | None	Placeholder element for code extensions	None
param	List[String] | None	Search Parameter Name, or chained parameters	None
param_ext	Element | None	Placeholder element for param extensions	None
documentation	String | None	Additional documentation about the resource and compartment	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

Composition

Path: fhircraft.fhir.resources.datatypes.R4.core.composition.Composition

Bases: DomainResource

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Composition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	Identifier | None	Version-independent identifier for the Composition	None
status	Code | None	preliminary | final | amended | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	Kind of composition (LOINC if possible)	None
category	List[CodeableConcept] | None	Categorization of Composition	None
subject	Reference | None	Who and/or what the composition is about	None
encounter	Reference | None	Context of the Composition	None
date	DateTime | None	Composition editing time	None
date_ext	Element | None	Placeholder element for date extensions	None
author	List[Reference] | None	Who and/or what authored the composition	None
title	String | None	Human Readable name/title	None
title_ext	Element | None	Placeholder element for title extensions	None
confidentiality	Code | None	As defined by affinity domain	None
confidentiality_ext	Element | None	Placeholder element for confidentiality extensions	None
attester	List[CompositionAttester] | None	Attests to accuracy of composition	None
custodian	Reference | None	Organization which maintains the composition	None
relatesTo	List[CompositionRelatesTo] | None	Relationships to other compositions/documents	None
event	List[CompositionEvent] | None	The clinical service(s) being documented	None
section	List[CompositionSection] | None	Composition is broken into sections	None
resourceType	Literal['Composition']		'Composition'

CompositionAttester

Path: fhircraft.fhir.resources.datatypes.R4.core.composition.CompositionAttester

Bases: BackboneElement

A participant who has attested to the accuracy of the composition/document.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
mode	Code | None	personal | professional | legal | official	None
mode_ext	Element | None	Placeholder element for mode extensions	None
time	DateTime | None	When the composition was attested	None
time_ext	Element | None	Placeholder element for time extensions	None
party	Reference | None	Who attested the composition	None

CompositionEvent

Path: fhircraft.fhir.resources.datatypes.R4.core.composition.CompositionEvent

Bases: BackboneElement

The clinical service, such as a colonoscopy or an appendectomy, being documented.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	List[CodeableConcept] | None	Code(s) that apply to the event being documented	None
period	Period | None	The period covered by the documentation	None
detail	List[Reference] | None	The event(s) being documented	None

CompositionRelatesTo

Path: fhircraft.fhir.resources.datatypes.R4.core.composition.CompositionRelatesTo

Bases: BackboneElement

Relationships that this composition has with other compositions or documents that already exist.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	replaces | transforms | signs | appends	None
code_ext	Element | None	Placeholder element for code extensions	None
targetIdentifier	Identifier | None	Target of the relationship	None
targetReference	Reference | None	Target of the relationship	None

CompositionSection

Path: fhircraft.fhir.resources.datatypes.R4.core.composition.CompositionSection

Bases: BackboneElement

The root of the sections that make up the composition.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
title	String | None	Label for section (e.g. for ToC)	None
title_ext	Element | None	Placeholder element for title extensions	None
code	CodeableConcept | None	Classification of section (recommended)	None
author	List[Reference] | None	Who and/or what authored the section	None
focus	Reference | None	Who/what the section is about, when it is not about the subject of composition	None
text	Narrative | None	Text summary of the section, for human interpretation	None
mode	Code | None	working | snapshot | changes	None
mode_ext	Element | None	Placeholder element for mode extensions	None
orderedBy	CodeableConcept | None	Order of section entries	None
entry	List[Reference] | None	A reference to data that supports this section	None
emptyReason	CodeableConcept | None	Why the section is empty	None
section	List[CompositionSection] | None	Nested Section	None

ConceptMap

Path: fhircraft.fhir.resources.datatypes.R4.core.concept_map.ConceptMap

Bases: DomainResource

A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ConceptMap'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this concept map, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	Identifier | None	Additional identifier for the concept map	None
version	String | None	Business version of the concept map	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this concept map (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this concept map (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the concept map	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for concept map (if applicable)	None
purpose	Markdown | None	Why this concept map is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
sourceUri	Uri | None	The source value set that contains the concepts that are being mapped	None
sourceUri_ext	Element | None	Placeholder element for sourceUri extensions	None
sourceCanonical	Canonical | None	The source value set that contains the concepts that are being mapped	None
sourceCanonical_ext	Element | None	Placeholder element for sourceCanonical extensions	None
targetUri	Uri | None	The target value set which provides context for the mappings	None
targetUri_ext	Element | None	Placeholder element for targetUri extensions	None
targetCanonical	Canonical | None	The target value set which provides context for the mappings	None
targetCanonical_ext	Element | None	Placeholder element for targetCanonical extensions	None
group	List[ConceptMapGroup] | None	Same source and target systems	None
resourceType	Literal['ConceptMap']		'ConceptMap'

ConceptMapGroup

Path: fhircraft.fhir.resources.datatypes.R4.core.concept_map.ConceptMapGroup

Bases: BackboneElement

A group of mappings that all have the same source and target system.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
source	Uri | None	Source system where concepts to be mapped are defined	None
source_ext	Element | None	Placeholder element for source extensions	None
sourceVersion	String | None	Specific version of the code system	None
sourceVersion_ext	Element | None	Placeholder element for sourceVersion extensions	None
target	Uri | None	Target system that the concepts are to be mapped to	None
target_ext	Element | None	Placeholder element for target extensions	None
targetVersion	String | None	Specific version of the code system	None
targetVersion_ext	Element | None	Placeholder element for targetVersion extensions	None
element	List[ConceptMapGroupElement] | None	Mappings for a concept from the source set	None
unmapped	ConceptMapGroupUnmapped | None	What to do when there is no mapping for the source concept	None

ConceptMapGroupElement

Path: fhircraft.fhir.resources.datatypes.R4.core.concept_map.ConceptMapGroupElement

Bases: BackboneElement

Mappings for an individual concept in the source to one or more concepts in the target.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Identifies element being mapped	None
code_ext	Element | None	Placeholder element for code extensions	None
display	String | None	Display for the code	None
display_ext	Element | None	Placeholder element for display extensions	None
target	List[ConceptMapGroupElementTarget] | None	Concept in target system for element	None

ConceptMapGroupElementTarget

Path: fhircraft.fhir.resources.datatypes.R4.core.concept_map.ConceptMapGroupElementTarget

Bases: BackboneElement

A concept from the target value set that this concept maps to.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Code that identifies the target element	None
code_ext	Element | None	Placeholder element for code extensions	None
display	String | None	Display for the code	None
display_ext	Element | None	Placeholder element for display extensions	None
equivalence	Code | None	relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint	None
equivalence_ext	Element | None	Placeholder element for equivalence extensions	None
comment	String | None	Description of status/issues in mapping	None
comment_ext	Element | None	Placeholder element for comment extensions	None
dependsOn	List[ConceptMapGroupElementTargetDependsOn] | None	Other elements required for this mapping (from context)	None
product	List[ConceptMapGroupElementTargetProduct] | None	Other concepts that this mapping also produces	None

ConceptMapGroupElementTargetDependsOn

Path: fhircraft.fhir.resources.datatypes.R4.core.concept_map.ConceptMapGroupElementTargetDependsOn

Bases: BackboneElement

A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
property_	Uri | None	Reference to property mapping depends on	None
property_ext	Element | None	Placeholder element for property extensions	None
system	Canonical | None	Code System (if necessary)	None
system_ext	Element | None	Placeholder element for system extensions	None
value	String | None	Value of the referenced element	None
value_ext	Element | None	Placeholder element for value extensions	None
display	String | None	Display for the code (if value is a code)	None
display_ext	Element | None	Placeholder element for display extensions	None

ConceptMapGroupElementTargetProduct

Path: fhircraft.fhir.resources.datatypes.R4.core.concept_map.ConceptMapGroupElementTargetProduct

Bases: BackboneElement

A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
property_	Uri | None	Reference to property mapping depends on	None
property_ext	Element | None	Placeholder element for property extensions	None
system	Canonical | None	Code System (if necessary)	None
system_ext	Element | None	Placeholder element for system extensions	None
value	String | None	Value of the referenced element	None
value_ext	Element | None	Placeholder element for value extensions	None
display	String | None	Display for the code (if value is a code)	None
display_ext	Element | None	Placeholder element for display extensions	None

ConceptMapGroupUnmapped

Path: fhircraft.fhir.resources.datatypes.R4.core.concept_map.ConceptMapGroupUnmapped

Bases: BackboneElement

What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
mode	Code | None	provided | fixed | other-map	None
mode_ext	Element | None	Placeholder element for mode extensions	None
code	Code | None	Fixed code when mode = fixed	None
code_ext	Element | None	Placeholder element for code extensions	None
display	String | None	Display for the code	None
display_ext	Element | None	Placeholder element for display extensions	None
url	Canonical | None	canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped	None
url_ext	Element | None	Placeholder element for url extensions	None

Condition

Path: fhircraft.fhir.resources.datatypes.R4.core.condition.Condition

Bases: DomainResource

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Condition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this condition	None
clinicalStatus	CodeableConcept | None	active | recurrence | relapse | inactive | remission | resolved	None
verificationStatus	CodeableConcept | None	unconfirmed | provisional | differential | confirmed | refuted | entered-in-error	None
category	List[CodeableConcept] | None	problem-list-item | encounter-diagnosis	None
severity	CodeableConcept | None	Subjective severity of condition	None
code	CodeableConcept | None	Identification of the condition, problem or diagnosis	None
bodySite	List[CodeableConcept] | None	Anatomical location, if relevant	None
subject	Reference | None	Who has the condition?	None
encounter	Reference | None	Encounter created as part of	None
onsetDateTime	DateTime | None	Estimated or actual date, date-time, or age	None
onsetDateTime_ext	Element | None	Placeholder element for onsetDateTime extensions	None
onsetAge	Age | None	Estimated or actual date, date-time, or age	None
onsetPeriod	Period | None	Estimated or actual date, date-time, or age	None
onsetRange	Range | None	Estimated or actual date, date-time, or age	None
onsetString	String | None	Estimated or actual date, date-time, or age	None
onsetString_ext	Element | None	Placeholder element for onsetString extensions	None
abatementDateTime	DateTime | None	When in resolution/remission	None
abatementDateTime_ext	Element | None	Placeholder element for abatementDateTime extensions	None
abatementAge	Age | None	When in resolution/remission	None
abatementPeriod	Period | None	When in resolution/remission	None
abatementRange	Range | None	When in resolution/remission	None
abatementString	String | None	When in resolution/remission	None
abatementString_ext	Element | None	Placeholder element for abatementString extensions	None
recordedDate	DateTime | None	Date record was first recorded	None
recordedDate_ext	Element | None	Placeholder element for recordedDate extensions	None
recorder	Reference | None	Who recorded the condition	None
asserter	Reference | None	Person who asserts this condition	None
stage	List[ConditionStage] | None	Stage/grade, usually assessed formally	None
evidence	List[ConditionEvidence] | None	Supporting evidence	None
note	List[Annotation] | None	Additional information about the Condition	None
resourceType	Literal['Condition']		'Condition'

ConditionEvidence

Path: fhircraft.fhir.resources.datatypes.R4.core.condition.ConditionEvidence

Bases: BackboneElement

Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	List[CodeableConcept] | None	Manifestation/symptom	None
detail	List[Reference] | None	Supporting information found elsewhere	None

ConditionStage

Path: fhircraft.fhir.resources.datatypes.R4.core.condition.ConditionStage

Bases: BackboneElement

Clinical stage or grade of a condition. May include formal severity assessments.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
summary	CodeableConcept | None	Simple summary (disease specific)	None
assessment	List[Reference] | None	Formal record of assessment	None
type	CodeableConcept | None	Kind of staging	None

Consent

Path: fhircraft.fhir.resources.datatypes.R4.core.consent.Consent

Bases: DomainResource

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.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Consent'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifier for this record (external references)	None
status	Code | None	draft | proposed | active | rejected | inactive | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
scope	CodeableConcept | None	Which of the four areas this resource covers (extensible)	None
category	List[CodeableConcept] | None	Classification of the consent statement - for indexing/retrieval	None
patient	Reference | None	Who the consent applies to	None
dateTime	DateTime | None	When this Consent was created or indexed	None
dateTime_ext	Element | None	Placeholder element for dateTime extensions	None
performer	List[Reference] | None	Who is agreeing to the policy and rules	None
organization	List[Reference] | None	Custodian of the consent	None
sourceAttachment	Attachment | None	Source from which this consent is taken	None
sourceReference	Reference | None	Source from which this consent is taken	None
policy	List[ConsentPolicy] | None	Policies covered by this consent	None
policyRule	CodeableConcept | None	Regulation that this consents to	None
verification	List[ConsentVerification] | None	Consent Verified by patient or family	None
provision	ConsentProvision | None	Constraints to the base Consent.policyRule	None
resourceType	Literal['Consent']		'Consent'

ConsentPolicy

Path: fhircraft.fhir.resources.datatypes.R4.core.consent.ConsentPolicy

Bases: BackboneElement

The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
authority	Uri | None	Enforcement source for policy	None
authority_ext	Element | None	Placeholder element for authority extensions	None
uri	Uri | None	Specific policy covered by this consent	None
uri_ext	Element | None	Placeholder element for uri extensions	None

ConsentProvision

Path: fhircraft.fhir.resources.datatypes.R4.core.consent.ConsentProvision

Bases: BackboneElement

An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	deny | permit	None
type_ext	Element | None	Placeholder element for type extensions	None
period	Period | None	Timeframe for this rule	None
actor	List[ConsentProvisionActor] | None	Who|what controlled by this rule (or group, by role)	None
action	List[CodeableConcept] | None	Actions controlled by this rule	None
securityLabel	List[Coding] | None	Security Labels that define affected resources	None
purpose	List[Coding] | None	Context of activities covered by this rule	None
class_	List[Coding] | None	e.g. Resource Type, Profile, CDA, etc.	None
code	List[CodeableConcept] | None	e.g. LOINC or SNOMED CT code, etc. in the content	None
dataPeriod	Period | None	Timeframe for data controlled by this rule	None
data	List[ConsentProvisionData] | None	Data controlled by this rule	None
provision	List[ConsentProvision] | None	Nested Exception Rules	None

ConsentProvisionActor

Path: fhircraft.fhir.resources.datatypes.R4.core.consent.ConsentProvisionActor

Bases: BackboneElement

Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
role	CodeableConcept | None	How the actor is involved	None
reference	Reference | None	Resource for the actor (or group, by role)	None

ConsentProvisionData

Path: fhircraft.fhir.resources.datatypes.R4.core.consent.ConsentProvisionData

Bases: BackboneElement

The resources controlled by this rule if specific resources are referenced.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
meaning	Code | None	instance | related | dependents | authoredby	None
meaning_ext	Element | None	Placeholder element for meaning extensions	None
reference	Reference | None	The actual data reference	None

ConsentVerification

Path: fhircraft.fhir.resources.datatypes.R4.core.consent.ConsentVerification

Bases: BackboneElement

Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
verified	Boolean | None	Has been verified	None
verified_ext	Element | None	Placeholder element for verified extensions	None
verifiedWith	Reference | None	Person who verified	None
verificationDate	DateTime | None	When consent verified	None
verificationDate_ext	Element | None	Placeholder element for verificationDate extensions	None

Contract

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.Contract

Bases: DomainResource

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Contract'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Contract number	None
url	Uri | None	Basal definition	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business edition	None
version_ext	Element | None	Placeholder element for version extensions	None
status	Code | None	amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated	None
status_ext	Element | None	Placeholder element for status extensions	None
legalState	CodeableConcept | None	Negotiation status	None
instantiatesCanonical	Reference | None	Source Contract Definition	None
instantiatesUri	Uri | None	External Contract Definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
contentDerivative	CodeableConcept | None	Content derived from the basal information	None
issued	DateTime | None	When this Contract was issued	None
issued_ext	Element | None	Placeholder element for issued extensions	None
applies	Period | None	Effective time	None
expirationType	CodeableConcept | None	Contract cessation cause	None
subject	List[Reference] | None	Contract Target Entity	None
authority	List[Reference] | None	Authority under which this Contract has standing	None
domain	List[Reference] | None	A sphere of control governed by an authoritative jurisdiction, organization, or person	None
site	List[Reference] | None	Specific Location	None
name	String | None	Computer friendly designation	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Human Friendly name	None
title_ext	Element | None	Placeholder element for title extensions	None
subtitle	String | None	Subordinate Friendly name	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
alias	List[String] | None	Acronym or short name	None
alias_ext	Element | None	Placeholder element for alias extensions	None
author	Reference | None	Source of Contract	None
scope	CodeableConcept | None	Range of Legal Concerns	None
topicCodeableConcept	CodeableConcept | None	Focus of contract interest	None
topicReference	Reference | None	Focus of contract interest	None
type	CodeableConcept | None	Legal instrument category	None
subType	List[CodeableConcept] | None	Subtype within the context of type	None
contentDefinition	ContractContentDefinition | None	Contract precursor content	None
term	List[ContractTerm] | None	Contract Term List	None
supportingInfo	List[Reference] | None	Extra Information	None
relevantHistory	List[Reference] | None	Key event in Contract History	None
signer	List[ContractSigner] | None	Contract Signatory	None
friendly	List[ContractFriendly] | None	Contract Friendly Language	None
legal	List[ContractLegal] | None	Contract Legal Language	None
rule	List[ContractRule] | None	Computable Contract Language	None
legallyBindingAttachment	Attachment | None	Binding Contract	None
legallyBindingReference	Reference | None	Binding Contract	None
resourceType	Literal['Contract']		'Contract'

ContractContentDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractContentDefinition

Bases: BackboneElement

Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Content structure and use	None
subType	CodeableConcept | None	Detailed Content Type Definition	None
publisher	Reference | None	Publisher Entity	None
publicationDate	DateTime | None	When published	None
publicationDate_ext	Element | None	Placeholder element for publicationDate extensions	None
publicationStatus	Code | None	amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated	None
publicationStatus_ext	Element | None	Placeholder element for publicationStatus extensions	None
copyright	Markdown | None	Publication Ownership	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None

ContractFriendly

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractFriendly

Bases: BackboneElement

The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
contentAttachment	Attachment | None	Easily comprehended representation of this Contract	None
contentReference	Reference | None	Easily comprehended representation of this Contract	None

ContractLegal

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractLegal

Bases: BackboneElement

List of Legal expressions or representations of this Contract.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
contentAttachment	Attachment | None	Contract Legal Text	None
contentReference	Reference | None	Contract Legal Text	None

ContractRule

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractRule

Bases: BackboneElement

List of Computable Policy Rule Language Representations of this Contract.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
contentAttachment	Attachment | None	Computable Contract Rules	None
contentReference	Reference | None	Computable Contract Rules	None

ContractSigner

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractSigner

Bases: BackboneElement

Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Coding | None	Contract Signatory Role	None
party	Reference | None	Contract Signatory Party	None
signature	List[Signature] | None	Contract Documentation Signature	None

ContractTerm

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTerm

Bases: BackboneElement

One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Identifier | None	Contract Term Number	None
issued	DateTime | None	Contract Term Issue Date Time	None
issued_ext	Element | None	Placeholder element for issued extensions	None
applies	Period | None	Contract Term Effective Time	None
topicCodeableConcept	CodeableConcept | None	Term Concern	None
topicReference	Reference | None	Term Concern	None
type	CodeableConcept | None	Contract Term Type or Form	None
subType	CodeableConcept | None	Contract Term Type specific classification	None
text	String | None	Term Statement	None
text_ext	Element | None	Placeholder element for text extensions	None
securityLabel	List[ContractTermSecurityLabel] | None	Protection for the Term	None
offer	ContractTermOffer | None	Context of the Contract term	None
asset	List[ContractTermAsset] | None	Contract Term Asset List	None
action	List[ContractTermAction] | None	Entity being ascribed responsibility	None
group	List[ContractTerm] | None	Nested Contract Term Group	None

ContractTermAction

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermAction

Bases: BackboneElement

An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
doNotPerform	Boolean | None	True if the term prohibits the action	None
doNotPerform_ext	Element | None	Placeholder element for doNotPerform extensions	None
type	CodeableConcept | None	Type or form of the action	None
subject	List[ContractTermActionSubject] | None	Entity of the action	None
intent	CodeableConcept | None	Purpose for the Contract Term Action	None
linkId	List[String] | None	Pointer to specific item	None
linkId_ext	Element | None	Placeholder element for linkId extensions	None
status	CodeableConcept | None	State of the action	None
context	Reference | None	Episode associated with action	None
contextLinkId	List[String] | None	Pointer to specific item	None
contextLinkId_ext	Element | None	Placeholder element for contextLinkId extensions	None
occurrenceDateTime	DateTime | None	When action happens	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	When action happens	None
occurrenceTiming	Timing | None	When action happens	None
requester	List[Reference] | None	Who asked for action	None
requesterLinkId	List[String] | None	Pointer to specific item	None
requesterLinkId_ext	Element | None	Placeholder element for requesterLinkId extensions	None
performerType	List[CodeableConcept] | None	Kind of service performer	None
performerRole	CodeableConcept | None	Competency of the performer	None
performer	Reference | None	Actor that wil execute (or not) the action	None
performerLinkId	List[String] | None	Pointer to specific item	None
performerLinkId_ext	Element | None	Placeholder element for performerLinkId extensions	None
reasonCode	List[CodeableConcept] | None	Why is action (not) needed?	None
reasonReference	List[Reference] | None	Why is action (not) needed?	None
reason	List[String] | None	Why action is to be performed	None
reason_ext	Element | None	Placeholder element for reason extensions	None
reasonLinkId	List[String] | None	Pointer to specific item	None
reasonLinkId_ext	Element | None	Placeholder element for reasonLinkId extensions	None
note	List[Annotation] | None	Comments about the action	None
securityLabelNumber	List[UnsignedInt] | None	Action restriction numbers	None
securityLabelNumber_ext	Element | None	Placeholder element for securityLabelNumber extensions	None

ContractTermActionSubject

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermActionSubject

Bases: BackboneElement

Entity of the action.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
reference	List[Reference] | None	Entity of the action	None
role	CodeableConcept | None	Role type of the agent	None

ContractTermAsset

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermAsset

Bases: BackboneElement

Contract Term Asset List.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
scope	CodeableConcept | None	Range of asset	None
type	List[CodeableConcept] | None	Asset category	None
typeReference	List[Reference] | None	Associated entities	None
subtype	List[CodeableConcept] | None	Asset sub-category	None
relationship	Coding | None	Kinship of the asset	None
context	List[ContractTermAssetContext] | None	Circumstance of the asset	None
condition	String | None	Quality desctiption of asset	None
condition_ext	Element | None	Placeholder element for condition extensions	None
periodType	List[CodeableConcept] | None	Asset availability types	None
period	List[Period] | None	Time period of the asset	None
usePeriod	List[Period] | None	Time period	None
text	String | None	Asset clause or question text	None
text_ext	Element | None	Placeholder element for text extensions	None
linkId	List[String] | None	Pointer to asset text	None
linkId_ext	Element | None	Placeholder element for linkId extensions	None
answer	List[ContractTermAssetAnswer] | None	Response to assets	None
securityLabelNumber	List[UnsignedInt] | None	Asset restriction numbers	None
securityLabelNumber_ext	Element | None	Placeholder element for securityLabelNumber extensions	None
valuedItem	List[ContractTermAssetValuedItem] | None	Contract Valued Item List	None

ContractTermAssetAnswer

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermAssetAnswer

Bases: BackboneElement

Response to assets.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueBoolean	Boolean | None	The actual answer response	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueDecimal	Decimal | None	The actual answer response	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueInteger	Integer | None	The actual answer response	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueDate	Date | None	The actual answer response	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueDateTime	DateTime | None	The actual answer response	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueTime	Time | None	The actual answer response	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueString	String | None	The actual answer response	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueUri	Uri | None	The actual answer response	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueAttachment	Attachment | None	The actual answer response	None
valueCoding	Coding | None	The actual answer response	None
valueQuantity	Quantity | None	The actual answer response	None
valueReference	Reference | None	The actual answer response	None

ContractTermAssetContext

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermAssetContext

Bases: BackboneElement

Circumstance of the asset.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
reference	Reference | None	Creator,custodian or owner	None
code	List[CodeableConcept] | None	Codeable asset context	None
text	String | None	Context description	None
text_ext	Element | None	Placeholder element for text extensions	None

ContractTermAssetValuedItem

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermAssetValuedItem

Bases: BackboneElement

Contract Valued Item List.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
entityCodeableConcept	CodeableConcept | None	Contract Valued Item Type	None
entityReference	Reference | None	Contract Valued Item Type	None
identifier	Identifier | None	Contract Valued Item Number	None
effectiveTime	DateTime | None	Contract Valued Item Effective Tiem	None
effectiveTime_ext	Element | None	Placeholder element for effectiveTime extensions	None
quantity	Quantity | None	Count of Contract Valued Items	None
unitPrice	Money | None	Contract Valued Item fee, charge, or cost	None
factor	Decimal | None	Contract Valued Item Price Scaling Factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
points	Decimal | None	Contract Valued Item Difficulty Scaling Factor	None
points_ext	Element | None	Placeholder element for points extensions	None
net	Money | None	Total Contract Valued Item Value	None
payment	String | None	Terms of valuation	None
payment_ext	Element | None	Placeholder element for payment extensions	None
paymentDate	DateTime | None	When payment is due	None
paymentDate_ext	Element | None	Placeholder element for paymentDate extensions	None
responsible	Reference | None	Who will make payment	None
recipient	Reference | None	Who will receive payment	None
linkId	List[String] | None	Pointer to specific item	None
linkId_ext	Element | None	Placeholder element for linkId extensions	None
securityLabelNumber	List[UnsignedInt] | None	Security Labels that define affected terms	None
securityLabelNumber_ext	Element | None	Placeholder element for securityLabelNumber extensions	None

ContractTermOffer

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermOffer

Bases: BackboneElement

The matter of concern in the context of this provision of the agrement.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	List[Identifier] | None	Offer business ID	None
party	List[ContractTermOfferParty] | None	Offer Recipient	None
topic	Reference | None	Negotiable offer asset	None
type	CodeableConcept | None	Contract Offer Type or Form	None
decision	CodeableConcept | None	Accepting party choice	None
decisionMode	List[CodeableConcept] | None	How decision is conveyed	None
answer	List[ContractTermOfferAnswer] | None	Response to offer text	None
text	String | None	Human readable offer text	None
text_ext	Element | None	Placeholder element for text extensions	None
linkId	List[String] | None	Pointer to text	None
linkId_ext	Element | None	Placeholder element for linkId extensions	None
securityLabelNumber	List[UnsignedInt] | None	Offer restriction numbers	None
securityLabelNumber_ext	Element | None	Placeholder element for securityLabelNumber extensions	None

ContractTermOfferAnswer

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermOfferAnswer

Bases: BackboneElement

Response to offer text.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueBoolean	Boolean | None	The actual answer response	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueDecimal	Decimal | None	The actual answer response	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueInteger	Integer | None	The actual answer response	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueDate	Date | None	The actual answer response	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueDateTime	DateTime | None	The actual answer response	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueTime	Time | None	The actual answer response	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueString	String | None	The actual answer response	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueUri	Uri | None	The actual answer response	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueAttachment	Attachment | None	The actual answer response	None
valueCoding	Coding | None	The actual answer response	None
valueQuantity	Quantity | None	The actual answer response	None
valueReference	Reference | None	The actual answer response	None

ContractTermOfferParty

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermOfferParty

Bases: BackboneElement

Offer Recipient.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
reference	List[Reference] | None	Referenced entity	None
role	CodeableConcept | None	Participant engagement type	None

ContractTermSecurityLabel

Path: fhircraft.fhir.resources.datatypes.R4.core.contract.ContractTermSecurityLabel

Bases: BackboneElement

Security labels that protect the handling of information about the term and its elements, which may be specifically identified..

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
number	List[UnsignedInt] | None	Link to Security Labels	None
number_ext	Element | None	Placeholder element for number extensions	None
classification	Coding | None	Confidentiality Protection	None
category	List[Coding] | None	Applicable Policy	None
control	List[Coding] | None	Handling Instructions	None

Coverage

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage.Coverage

Bases: DomainResource

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Coverage'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for the coverage	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	Coverage category such as medical or accident	None
policyHolder	Reference | None	Owner of the policy	None
subscriber	Reference | None	Subscriber to the policy	None
subscriberId	String | None	ID assigned to the subscriber	None
subscriberId_ext	Element | None	Placeholder element for subscriberId extensions	None
beneficiary	Reference | None	Plan beneficiary	None
dependent	String | None	Dependent number	None
dependent_ext	Element | None	Placeholder element for dependent extensions	None
relationship	CodeableConcept | None	Beneficiary relationship to the subscriber	None
period	Period | None	Coverage start and end dates	None
payor	List[Reference] | None	Issuer of the policy	None
class_	List[CoverageClass] | None	Additional coverage classifications	None
order	PositiveInt | None	Relative order of the coverage	None
order_ext	Element | None	Placeholder element for order extensions	None
network	String | None	Insurer network	None
network_ext	Element | None	Placeholder element for network extensions	None
costToBeneficiary	List[CoverageCostToBeneficiary] | None	Patient payments for services/products	None
subrogation	Boolean | None	Reimbursement to insurer	None
subrogation_ext	Element | None	Placeholder element for subrogation extensions	None
contract	List[Reference] | None	Contract details	None
resourceType	Literal['Coverage']		'Coverage'

CoverageClass

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage.CoverageClass

Bases: BackboneElement

A suite of underwriter specific classifiers.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of class such as 'group' or 'plan'	None
value	String | None	Value associated with the type	None
value_ext	Element | None	Placeholder element for value extensions	None
name	String | None	Human readable description of the type and value	None
name_ext	Element | None	Placeholder element for name extensions	None

CoverageCostToBeneficiary

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage.CoverageCostToBeneficiary

Bases: BackboneElement

A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Cost category	None
valueQuantity	Quantity | None	The amount or percentage due from the beneficiary	None
valueMoney	Money | None	The amount or percentage due from the beneficiary	None
exception	List[CoverageCostToBeneficiaryException] | None	Exceptions for patient payments	None

CoverageCostToBeneficiaryException

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage.CoverageCostToBeneficiaryException

Bases: BackboneElement

A suite of codes indicating exceptions or reductions to patient costs and their effective periods.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Exception category	None
period	Period | None	The effective period of the exception	None

CoverageEligibilityRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_request.CoverageEligibilityRequest

Bases: DomainResource

The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for coverage eligiblity request	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
priority	CodeableConcept | None	Desired processing priority	None
purpose	List[Code] | None	auth-requirements | benefits | discovery | validation	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
patient	Reference | None	Intended recipient of products and services	None
servicedDate	Date | None	Estimated date or dates of service	None
servicedDate_ext	Element | None	Placeholder element for servicedDate extensions	None
servicedPeriod	Period | None	Estimated date or dates of service	None
created	DateTime | None	Creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
enterer	Reference | None	Author	None
provider	Reference | None	Party responsible for the request	None
insurer	Reference | None	Coverage issuer	None
facility	Reference | None	Servicing facility	None
supportingInfo	List[CoverageEligibilityRequestSupportingInfo] | None	Supporting information	None
insurance	List[CoverageEligibilityRequestInsurance] | None	Patient insurance information	None
item	List[CoverageEligibilityRequestItem] | None	Item to be evaluated for eligibiity	None
resourceType	Literal['CoverageEligibilityRequest']		'CoverageEligibilityRequest'

CoverageEligibilityRequestInsurance

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_request.CoverageEligibilityRequestInsurance

Bases: BackboneElement

Financial instruments for reimbursement for the health care products and services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
focal	Boolean | None	Applicable coverage	None
focal_ext	Element | None	Placeholder element for focal extensions	None
coverage	Reference | None	Insurance information	None
businessArrangement	String | None	Additional provider contract number	None
businessArrangement_ext	Element | None	Placeholder element for businessArrangement extensions	None

CoverageEligibilityRequestItem

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_request.CoverageEligibilityRequestItem

Bases: BackboneElement

Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
supportingInfoSequence	List[PositiveInt] | None	Applicable exception or supporting information	None
supportingInfoSequence_ext	Element | None	Placeholder element for supportingInfoSequence extensions	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Product or service billing modifiers	None
provider	Reference | None	Perfoming practitioner	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
facility	Reference | None	Servicing facility	None
diagnosis	List[CoverageEligibilityRequestItemDiagnosis] | None	Applicable diagnosis	None
detail	List[Reference] | None	Product or service details	None

CoverageEligibilityRequestItemDiagnosis

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_request.CoverageEligibilityRequestItemDiagnosis

Bases: BackboneElement

Patient diagnosis for which care is sought.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
diagnosisCodeableConcept	CodeableConcept | None	Nature of illness or problem	None
diagnosisReference	Reference | None	Nature of illness or problem	None

CoverageEligibilityRequestSupportingInfo

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_request.CoverageEligibilityRequestSupportingInfo

Bases: BackboneElement

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Information instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
information	Reference | None	Data to be provided	None
appliesToAll	Boolean | None	Applies to all items	None
appliesToAll_ext	Element | None	Placeholder element for appliesToAll extensions	None

CoverageEligibilityResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_response.CoverageEligibilityResponse

Bases: DomainResource

This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for coverage eligiblity request	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
purpose	List[Code] | None	auth-requirements | benefits | discovery | validation	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
patient	Reference | None	Intended recipient of products and services	None
servicedDate	Date | None	Estimated date or dates of service	None
servicedDate_ext	Element | None	Placeholder element for servicedDate extensions	None
servicedPeriod	Period | None	Estimated date or dates of service	None
created	DateTime | None	Response creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
requestor	Reference | None	Party responsible for the request	None
request	Reference | None	Eligibility request reference	None
outcome	Code | None	queued | complete | error | partial	None
outcome_ext	Element | None	Placeholder element for outcome extensions	None
disposition	String | None	Disposition Message	None
disposition_ext	Element | None	Placeholder element for disposition extensions	None
insurer	Reference | None	Coverage issuer	None
insurance	List[CoverageEligibilityResponseInsurance] | None	Patient insurance information	None
preAuthRef	String | None	Preauthorization reference	None
preAuthRef_ext	Element | None	Placeholder element for preAuthRef extensions	None
form	CodeableConcept | None	Printed form identifier	None
error	List[CoverageEligibilityResponseError] | None	Processing errors	None
resourceType	Literal['CoverageEligibilityResponse']		'CoverageEligibilityResponse'

CoverageEligibilityResponseError

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_response.CoverageEligibilityResponseError

Bases: BackboneElement

Errors encountered during the processing of the request.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Error code detailing processing issues	None

CoverageEligibilityResponseInsurance

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_response.CoverageEligibilityResponseInsurance

Bases: BackboneElement

Financial instruments for reimbursement for the health care products and services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
coverage	Reference | None	Insurance information	None
inforce	Boolean | None	Coverage inforce indicator	None
inforce_ext	Element | None	Placeholder element for inforce extensions	None
benefitPeriod	Period | None	When the benefits are applicable	None
item	List[CoverageEligibilityResponseInsuranceItem] | None	Benefits and authorization details	None

CoverageEligibilityResponseInsuranceItem

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_response.CoverageEligibilityResponseInsuranceItem

Bases: BackboneElement

Benefits and optionally current balances, and authorization details by category or service.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Product or service billing modifiers	None
provider	Reference | None	Performing practitioner	None
excluded	Boolean | None	Excluded from the plan	None
excluded_ext	Element | None	Placeholder element for excluded extensions	None
name	String | None	Short name for the benefit	None
name_ext	Element | None	Placeholder element for name extensions	None
description	String | None	Description of the benefit or services covered	None
description_ext	Element | None	Placeholder element for description extensions	None
network	CodeableConcept | None	In or out of network	None
unit	CodeableConcept | None	Individual or family	None
term	CodeableConcept | None	Annual or lifetime	None
benefit	List[CoverageEligibilityResponseInsuranceItemBenefit] | None	Benefit Summary	None
authorizationRequired	Boolean | None	Authorization required flag	None
authorizationRequired_ext	Element | None	Placeholder element for authorizationRequired extensions	None
authorizationSupporting	List[CodeableConcept] | None	Type of required supporting materials	None
authorizationUrl	Uri | None	Preauthorization requirements endpoint	None
authorizationUrl_ext	Element | None	Placeholder element for authorizationUrl extensions	None

CoverageEligibilityResponseInsuranceItemBenefit

Path: fhircraft.fhir.resources.datatypes.R4.core.coverage_eligibility_response.CoverageEligibilityResponseInsuranceItemBenefit

Bases: BackboneElement

Benefits used to date.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Benefit classification	None
allowedUnsignedInt	UnsignedInt | None	Benefits allowed	None
allowedUnsignedInt_ext	Element | None	Placeholder element for allowedUnsignedInt extensions	None
allowedString	String | None	Benefits allowed	None
allowedString_ext	Element | None	Placeholder element for allowedString extensions	None
allowedMoney	Money | None	Benefits allowed	None
usedUnsignedInt	UnsignedInt | None	Benefits used	None
usedUnsignedInt_ext	Element | None	Placeholder element for usedUnsignedInt extensions	None
usedString	String | None	Benefits used	None
usedString_ext	Element | None	Placeholder element for usedString extensions	None
usedMoney	Money | None	Benefits used	None

DetectedIssue

Path: fhircraft.fhir.resources.datatypes.R4.core.detected_issue.DetectedIssue

Bases: DomainResource

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DetectedIssue'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique id for the detected issue	None
status	Code | None	registered | preliminary | final | amended +	None
status_ext	Element | None	Placeholder element for status extensions	None
code	CodeableConcept | None	Issue Category, e.g. drug-drug, duplicate therapy, etc.	None
severity	Code | None	high | moderate | low	None
severity_ext	Element | None	Placeholder element for severity extensions	None
patient	Reference | None	Associated patient	None
identifiedDateTime	DateTime | None	When identified	None
identifiedDateTime_ext	Element | None	Placeholder element for identifiedDateTime extensions	None
identifiedPeriod	Period | None	When identified	None
author	Reference | None	The provider or device that identified the issue	None
implicated	List[Reference] | None	Problem resource	None
evidence	List[DetectedIssueEvidence] | None	Supporting evidence	None
detail	String | None	Description and context	None
detail_ext	Element | None	Placeholder element for detail extensions	None
reference	Uri | None	Authority for issue	None
reference_ext	Element | None	Placeholder element for reference extensions	None
mitigation	List[DetectedIssueMitigation] | None	Step taken to address	None
resourceType	Literal['DetectedIssue']		'DetectedIssue'

DetectedIssueEvidence

Path: fhircraft.fhir.resources.datatypes.R4.core.detected_issue.DetectedIssueEvidence

Bases: BackboneElement

Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	List[CodeableConcept] | None	Manifestation	None
detail	List[Reference] | None	Supporting information	None

DetectedIssueMitigation

Path: fhircraft.fhir.resources.datatypes.R4.core.detected_issue.DetectedIssueMitigation

Bases: BackboneElement

Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
action	CodeableConcept | None	What mitigation?	None
date	DateTime | None	Date committed	None
date_ext	Element | None	Placeholder element for date extensions	None
author	Reference | None	Who is committing?	None

Device

Path: fhircraft.fhir.resources.datatypes.R4.core.device.Device

Bases: DomainResource

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Device'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Instance identifier	None
definition	Reference | None	The reference to the definition for the device	None
udiCarrier	List[DeviceUdiCarrier] | None	Unique Device Identifier (UDI) Barcode string	None
status	Code | None	active | inactive | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	List[CodeableConcept] | None	online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off	None
distinctIdentifier	String | None	The distinct identification string	None
distinctIdentifier_ext	Element | None	Placeholder element for distinctIdentifier extensions	None
manufacturer	String | None	Name of device manufacturer	None
manufacturer_ext	Element | None	Placeholder element for manufacturer extensions	None
manufactureDate	DateTime | None	Date when the device was made	None
manufactureDate_ext	Element | None	Placeholder element for manufactureDate extensions	None
expirationDate	DateTime | None	Date and time of expiry of this device (if applicable)	None
expirationDate_ext	Element | None	Placeholder element for expirationDate extensions	None
lotNumber	String | None	Lot number of manufacture	None
lotNumber_ext	Element | None	Placeholder element for lotNumber extensions	None
serialNumber	String | None	Serial number assigned by the manufacturer	None
serialNumber_ext	Element | None	Placeholder element for serialNumber extensions	None
deviceName	List[DeviceDeviceName] | None	The name of the device as given by the manufacturer	None
modelNumber	String | None	The model number for the device	None
modelNumber_ext	Element | None	Placeholder element for modelNumber extensions	None
partNumber	String | None	The part number of the device	None
partNumber_ext	Element | None	Placeholder element for partNumber extensions	None
type	CodeableConcept | None	The kind or type of device	None
specialization	List[DeviceSpecialization] | None	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication	None
version	List[DeviceVersion] | None	The actual design of the device or software version running on the device	None
property_	List[DeviceProperty] | None	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties	None
patient	Reference | None	Patient to whom Device is affixed	None
owner	Reference | None	Organization responsible for device	None
contact	List[ContactPoint] | None	Details for human/organization for support	None
location	Reference | None	Where the device is found	None
url	Uri | None	Network address to contact device	None
url_ext	Element | None	Placeholder element for url extensions	None
note	List[Annotation] | None	Device notes and comments	None
safety	List[CodeableConcept] | None	Safety Characteristics of Device	None
parent	Reference | None	The parent device	None
resourceType	Literal['Device']		'Device'

DeviceDeviceName

Path: fhircraft.fhir.resources.datatypes.R4.core.device.DeviceDeviceName

Bases: BackboneElement

This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	The name of the device	None
name_ext	Element | None	Placeholder element for name extensions	None
type	Code | None	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other	None
type_ext	Element | None	Placeholder element for type extensions	None

DeviceProperty

Path: fhircraft.fhir.resources.datatypes.R4.core.device.DeviceProperty

Bases: BackboneElement

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Code that specifies the property DeviceDefinitionPropetyCode (Extensible)	None
valueQuantity	List[Quantity] | None	Property value as a quantity	None
valueCode	List[CodeableConcept] | None	Property value as a code, e.g., NTP4 (synced to NTP)	None

DeviceSpecialization

Path: fhircraft.fhir.resources.datatypes.R4.core.device.DeviceSpecialization

Bases: BackboneElement

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
systemType	CodeableConcept | None	The standard that is used to operate and communicate	None
version	String | None	The version of the standard that is used to operate and communicate	None
version_ext	Element | None	Placeholder element for version extensions	None

DeviceUdiCarrier

Path: fhircraft.fhir.resources.datatypes.R4.core.device.DeviceUdiCarrier

Bases: BackboneElement

Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
deviceIdentifier	String | None	Mandatory fixed portion of UDI	None
deviceIdentifier_ext	Element | None	Placeholder element for deviceIdentifier extensions	None
issuer	Uri | None	UDI Issuing Organization	None
issuer_ext	Element | None	Placeholder element for issuer extensions	None
jurisdiction	Uri | None	Regional UDI authority	None
jurisdiction_ext	Element | None	Placeholder element for jurisdiction extensions	None
carrierAIDC	Base64Binary | None	UDI Machine Readable Barcode String	None
carrierAIDC_ext	Element | None	Placeholder element for carrierAIDC extensions	None
carrierHRF	String | None	UDI Human Readable Barcode String	None
carrierHRF_ext	Element | None	Placeholder element for carrierHRF extensions	None
entryType	Code | None	barcode | rfid | manual +	None
entryType_ext	Element | None	Placeholder element for entryType extensions	None

DeviceVersion

Path: fhircraft.fhir.resources.datatypes.R4.core.device.DeviceVersion

Bases: BackboneElement

The actual design of the device or software version running on the device.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	The type of the device version	None
component	Identifier | None	A single component of the device version	None
value	String | None	The version text	None
value_ext	Element | None	Placeholder element for value extensions	None

DeviceDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.device_definition.DeviceDefinition

Bases: DomainResource

The characteristics, operational status and capabilities of a medical-related component of a medical device.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DeviceDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Instance identifier	None
udiDeviceIdentifier	List[DeviceDefinitionUdiDeviceIdentifier] | None	Unique Device Identifier (UDI) Barcode string	None
manufacturerString	String | None	Name of device manufacturer	None
manufacturerString_ext	Element | None	Placeholder element for manufacturerString extensions	None
manufacturerReference	Reference | None	Name of device manufacturer	None
deviceName	List[DeviceDefinitionDeviceName] | None	A name given to the device to identify it	None
modelNumber	String | None	The model number for the device	None
modelNumber_ext	Element | None	Placeholder element for modelNumber extensions	None
type	CodeableConcept | None	What kind of device or device system this is	None
specialization	List[DeviceDefinitionSpecialization] | None	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication	None
version	List[String] | None	Available versions	None
version_ext	Element | None	Placeholder element for version extensions	None
safety	List[CodeableConcept] | None	Safety characteristics of the device	None
shelfLifeStorage	List[ProductShelfLife] | None	Shelf Life and storage information	None
physicalCharacteristics	ProdCharacteristic | None	Dimensions, color etc.	None
languageCode	List[CodeableConcept] | None	Language code for the human-readable text strings produced by the device (all supported)	None
capability	List[DeviceDefinitionCapability] | None	Device capabilities	None
property_	List[DeviceDefinitionProperty] | None	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties	None
owner	Reference | None	Organization responsible for device	None
contact	List[ContactPoint] | None	Details for human/organization for support	None
url	Uri | None	Network address to contact device	None
url_ext	Element | None	Placeholder element for url extensions	None
onlineInformation	Uri | None	Access to on-line information	None
onlineInformation_ext	Element | None	Placeholder element for onlineInformation extensions	None
note	List[Annotation] | None	Device notes and comments	None
quantity	Quantity | None	The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)	None
parentDevice	Reference | None	The parent device it can be part of	None
material	List[DeviceDefinitionMaterial] | None	A substance used to create the material(s) of which the device is made	None
resourceType	Literal['DeviceDefinition']		'DeviceDefinition'

DeviceDefinitionCapability

Path: fhircraft.fhir.resources.datatypes.R4.core.device_definition.DeviceDefinitionCapability

Bases: BackboneElement

Device capabilities.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of capability	None
description	List[CodeableConcept] | None	Description of capability	None

DeviceDefinitionDeviceName

Path: fhircraft.fhir.resources.datatypes.R4.core.device_definition.DeviceDefinitionDeviceName

Bases: BackboneElement

A name given to the device to identify it.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	The name of the device	None
name_ext	Element | None	Placeholder element for name extensions	None
type	Code | None	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other	None
type_ext	Element | None	Placeholder element for type extensions	None

DeviceDefinitionMaterial

Path: fhircraft.fhir.resources.datatypes.R4.core.device_definition.DeviceDefinitionMaterial

Bases: BackboneElement

A substance used to create the material(s) of which the device is made.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
substance	CodeableConcept | None	The substance	None
alternate	Boolean | None	Indicates an alternative material of the device	None
alternate_ext	Element | None	Placeholder element for alternate extensions	None
allergenicIndicator	Boolean | None	Whether the substance is a known or suspected allergen	None
allergenicIndicator_ext	Element | None	Placeholder element for allergenicIndicator extensions	None

DeviceDefinitionProperty

Path: fhircraft.fhir.resources.datatypes.R4.core.device_definition.DeviceDefinitionProperty

Bases: BackboneElement

The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Code that specifies the property DeviceDefinitionPropetyCode (Extensible)	None
valueQuantity	List[Quantity] | None	Property value as a quantity	None
valueCode	List[CodeableConcept] | None	Property value as a code, e.g., NTP4 (synced to NTP)	None

DeviceDefinitionSpecialization

Path: fhircraft.fhir.resources.datatypes.R4.core.device_definition.DeviceDefinitionSpecialization

Bases: BackboneElement

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
systemType	String | None	The standard that is used to operate and communicate	None
systemType_ext	Element | None	Placeholder element for systemType extensions	None
version	String | None	The version of the standard that is used to operate and communicate	None
version_ext	Element | None	Placeholder element for version extensions	None

DeviceDefinitionUdiDeviceIdentifier

Path: fhircraft.fhir.resources.datatypes.R4.core.device_definition.DeviceDefinitionUdiDeviceIdentifier

Bases: BackboneElement

Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
deviceIdentifier	String | None	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier	None
deviceIdentifier_ext	Element | None	Placeholder element for deviceIdentifier extensions	None
issuer	Uri | None	The organization that assigns the identifier algorithm	None
issuer_ext	Element | None	Placeholder element for issuer extensions	None
jurisdiction	Uri | None	The jurisdiction to which the deviceIdentifier applies	None
jurisdiction_ext	Element | None	Placeholder element for jurisdiction extensions	None

DeviceMetric

Path: fhircraft.fhir.resources.datatypes.R4.core.device_metric.DeviceMetric

Bases: DomainResource

Describes a measurement, calculation or setting capability of a medical device.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DeviceMetric'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Instance identifier	None
type	CodeableConcept | None	Identity of metric, for example Heart Rate or PEEP Setting	None
unit	CodeableConcept | None	Unit of Measure for the Metric	None
source	Reference | None	Describes the link to the source Device	None
parent	Reference | None	Describes the link to the parent Device	None
operationalStatus	Code | None	on | off | standby | entered-in-error	None
operationalStatus_ext	Element | None	Placeholder element for operationalStatus extensions	None
color	Code | None	black | red | green | yellow | blue | magenta | cyan | white	None
color_ext	Element | None	Placeholder element for color extensions	None
category	Code | None	measurement | setting | calculation | unspecified	None
category_ext	Element | None	Placeholder element for category extensions	None
measurementPeriod	Timing | None	Describes the measurement repetition time	None
calibration	List[DeviceMetricCalibration] | None	Describes the calibrations that have been performed or that are required to be performed	None
resourceType	Literal['DeviceMetric']		'DeviceMetric'

DeviceMetricCalibration

Path: fhircraft.fhir.resources.datatypes.R4.core.device_metric.DeviceMetricCalibration

Bases: BackboneElement

Describes the calibrations that have been performed or that are required to be performed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	unspecified | offset | gain | two-point	None
type_ext	Element | None	Placeholder element for type extensions	None
state	Code | None	not-calibrated | calibration-required | calibrated | unspecified	None
state_ext	Element | None	Placeholder element for state extensions	None
time	Instant | None	Describes the time last calibration has been performed	None
time_ext	Element | None	Placeholder element for time extensions	None

DeviceRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.device_request.DeviceRequest

Bases: DomainResource

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DeviceRequest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Request identifier	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	What request fulfills	None
priorRequest	List[Reference] | None	What request replaces	None
groupIdentifier	Identifier | None	Identifier of composite request	None
status	Code | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
intent	Code | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
codeReference	Reference | None	Device requested	None
codeCodeableConcept	CodeableConcept | None	Device requested	None
parameter	List[DeviceRequestParameter] | None	Device details	None
subject	Reference | None	Focus of request	None
encounter	Reference | None	Encounter motivating request	None
occurrenceDateTime	DateTime | None	Desired time or schedule for use	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	Desired time or schedule for use	None
occurrenceTiming	Timing | None	Desired time or schedule for use	None
authoredOn	DateTime | None	When recorded	None
authoredOn_ext	Element | None	Placeholder element for authoredOn extensions	None
requester	Reference | None	Who/what is requesting diagnostics	None
performerType	CodeableConcept | None	Filler role	None
performer	Reference | None	Requested Filler	None
reasonCode	List[CodeableConcept] | None	Coded Reason for request	None
reasonReference	List[Reference] | None	Linked Reason for request	None
insurance	List[Reference] | None	Associated insurance coverage	None
supportingInfo	List[Reference] | None	Additional clinical information	None
note	List[Annotation] | None	Notes or comments	None
relevantHistory	List[Reference] | None	Request provenance	None
resourceType	Literal['DeviceRequest']		'DeviceRequest'

DeviceRequestParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.device_request.DeviceRequestParameter

Bases: BackboneElement

Specific parameters for the ordered item. For example, the prism value for lenses.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Device detail	None
valueCodeableConcept	CodeableConcept | None	Value of detail	None
valueQuantity	Quantity | None	Value of detail	None
valueRange	Range | None	Value of detail	None
valueBoolean	Boolean | None	Value of detail	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None

DeviceUseStatement

Path: fhircraft.fhir.resources.datatypes.R4.core.device_use_statement.DeviceUseStatement

Bases: DomainResource

A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DeviceUseStatement'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External identifier for this record	None
basedOn	List[Reference] | None	Fulfills plan, proposal or order	None
status	Code | None	active | completed | entered-in-error +	None
status_ext	Element | None	Placeholder element for status extensions	None
subject	Reference | None	Patient using device	None
derivedFrom	List[Reference] | None	Supporting information	None
timingTiming	Timing | None	How often the device was used	None
timingPeriod	Period | None	How often the device was used	None
timingDateTime	DateTime | None	How often the device was used	None
timingDateTime_ext	Element | None	Placeholder element for timingDateTime extensions	None
recordedOn	DateTime | None	When statement was recorded	None
recordedOn_ext	Element | None	Placeholder element for recordedOn extensions	None
source	Reference | None	Who made the statement	None
device	Reference | None	Reference to device used	None
reasonCode	List[CodeableConcept] | None	Why device was used	None
reasonReference	List[Reference] | None	Why was DeviceUseStatement performed?	None
bodySite	CodeableConcept | None	Target body site	None
note	List[Annotation] | None	Addition details (comments, instructions)	None
resourceType	Literal['DeviceUseStatement']		'DeviceUseStatement'

DiagnosticReport

Path: fhircraft.fhir.resources.datatypes.R4.core.diagnostic_report.DiagnosticReport

Bases: DomainResource

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DiagnosticReport'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier for report	None
basedOn	List[Reference] | None	What was requested	None
status	Code | None	registered | partial | preliminary | final +	None
status_ext	Element | None	Placeholder element for status extensions	None
category	List[CodeableConcept] | None	Service category	None
code	CodeableConcept | None	Name/Code for this diagnostic report	None
subject	Reference | None	The subject of the report - usually, but not always, the patient	None
encounter	Reference | None	Health care event when test ordered	None
effectiveDateTime	DateTime | None	Clinically relevant time/time-period for report	None
effectiveDateTime_ext	Element | None	Placeholder element for effectiveDateTime extensions	None
effectivePeriod	Period | None	Clinically relevant time/time-period for report	None
issued	Instant | None	DateTime this version was made	None
issued_ext	Element | None	Placeholder element for issued extensions	None
performer	List[Reference] | None	Responsible Diagnostic Service	None
resultsInterpreter	List[Reference] | None	Primary result interpreter	None
specimen	List[Reference] | None	Specimens this report is based on	None
result	List[Reference] | None	Observations	None
imagingStudy	List[Reference] | None	Reference to full details of imaging associated with the diagnostic report	None
media	List[DiagnosticReportMedia] | None	Key images associated with this report	None
conclusion	String | None	Clinical conclusion (interpretation) of test results	None
conclusion_ext	Element | None	Placeholder element for conclusion extensions	None
conclusionCode	List[CodeableConcept] | None	Codes for the clinical conclusion of test results	None
presentedForm	List[Attachment] | None	Entire report as issued	None
resourceType	Literal['DiagnosticReport']		'DiagnosticReport'

DiagnosticReportMedia

Path: fhircraft.fhir.resources.datatypes.R4.core.diagnostic_report.DiagnosticReportMedia

Bases: BackboneElement

A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
comment	String | None	Comment about the image (e.g. explanation)	None
comment_ext	Element | None	Placeholder element for comment extensions	None
link	Reference | None	Reference to the image source	None

DocumentManifest

Path: fhircraft.fhir.resources.datatypes.R4.core.document_manifest.DocumentManifest

Bases: DomainResource

A collection of documents compiled for a purpose together with metadata that applies to the collection.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DocumentManifest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
masterIdentifier	Identifier | None	Unique Identifier for the set of documents	None
identifier	List[Identifier] | None	Other identifiers for the manifest	None
status	Code | None	current | superseded | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	Kind of document set	None
subject	Reference | None	The subject of the set of documents	None
created	DateTime | None	When this document manifest created	None
created_ext	Element | None	Placeholder element for created extensions	None
author	List[Reference] | None	Who and/or what authored the DocumentManifest	None
recipient	List[Reference] | None	Intended to get notified about this set of documents	None
source	Uri | None	The source system/application/software	None
source_ext	Element | None	Placeholder element for source extensions	None
description	String | None	Human-readable description (title)	None
description_ext	Element | None	Placeholder element for description extensions	None
content	List[Reference] | None	Items in manifest	None
related	List[DocumentManifestRelated] | None	Related things	None
resourceType	Literal['DocumentManifest']		'DocumentManifest'

DocumentManifestRelated

Path: fhircraft.fhir.resources.datatypes.R4.core.document_manifest.DocumentManifestRelated

Bases: BackboneElement

Related identifiers or resources associated with the DocumentManifest.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Identifier | None	Identifiers of things that are related	None
ref	Reference | None	Related Resource	None

DocumentReference

Path: fhircraft.fhir.resources.datatypes.R4.core.document_reference.DocumentReference

Bases: DomainResource

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DocumentReference'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
masterIdentifier	Identifier | None	Master Version Specific Identifier	None
identifier	List[Identifier] | None	Other identifiers for the document	None
status	Code | None	current | superseded | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
docStatus	Code | None	preliminary | final | amended | entered-in-error	None
docStatus_ext	Element | None	Placeholder element for docStatus extensions	None
type	CodeableConcept | None	Kind of document (LOINC if possible)	None
category	List[CodeableConcept] | None	Categorization of document	None
subject	Reference | None	Who/what is the subject of the document	None
date	Instant | None	When this document reference was created	None
date_ext	Element | None	Placeholder element for date extensions	None
author	List[Reference] | None	Who and/or what authored the document	None
authenticator	Reference | None	Who/what authenticated the document	None
custodian	Reference | None	Organization which maintains the document	None
relatesTo	List[DocumentReferenceRelatesTo] | None	Relationships to other documents	None
description	String | None	Human-readable description	None
description_ext	Element | None	Placeholder element for description extensions	None
securityLabel	List[CodeableConcept] | None	Document security-tags	None
content	List[DocumentReferenceContent] | None	Document referenced	None
context	DocumentReferenceContext | None	Clinical context of document	None
resourceType	Literal['DocumentReference']		'DocumentReference'

DocumentReferenceContent

Path: fhircraft.fhir.resources.datatypes.R4.core.document_reference.DocumentReferenceContent

Bases: BackboneElement

The document and format referenced. There may be multiple content element repetitions, each with a different format.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
attachment	Attachment | None	Where to access the document	None
format	Coding | None	Format/content rules for the document	None

DocumentReferenceContext

Path: fhircraft.fhir.resources.datatypes.R4.core.document_reference.DocumentReferenceContext

Bases: BackboneElement

The clinical context in which the document was prepared.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
encounter	List[Reference] | None	Context of the document content	None
event	List[CodeableConcept] | None	Main clinical acts documented	None
period	Period | None	Time of service that is being documented	None
facilityType	CodeableConcept | None	Kind of facility where patient was seen	None
practiceSetting	CodeableConcept | None	Additional details about where the content was created (e.g. clinical specialty)	None
sourcePatientInfo	Reference | None	Patient demographics from source	None
related	List[Reference] | None	Related identifiers or resources	None

DocumentReferenceRelatesTo

Path: fhircraft.fhir.resources.datatypes.R4.core.document_reference.DocumentReferenceRelatesTo

Bases: BackboneElement

Relationships that this document has with other document references that already exist.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	replaces | transforms | signs | appends	None
code_ext	Element | None	Placeholder element for code extensions	None
target	Reference | None	Target of the relationship	None

DomainResource

Path: fhircraft.fhir.resources.datatypes.R4.core.domain_resource.DomainResource

Bases: Resource

A resource that includes narrative, extensions, and contained resources.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/DomainResource'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
resourceType	Literal['DomainResource']		'DomainResource'

EffectEvidenceSynthesis

Path: fhircraft.fhir.resources.datatypes.R4.core.effect_evidence_synthesis.EffectEvidenceSynthesis

Bases: DomainResource

The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/EffectEvidenceSynthesis'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the effect evidence synthesis	None
version	String | None	Business version of the effect evidence synthesis	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this effect evidence synthesis (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this effect evidence synthesis (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the effect evidence synthesis	None
description_ext	Element | None	Placeholder element for description extensions	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for effect evidence synthesis (if applicable)	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the effect evidence synthesis was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the effect evidence synthesis was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the effect evidence synthesis is expected to be used	None
topic	List[CodeableConcept] | None	The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
synthesisType	CodeableConcept | None	Type of synthesis	None
studyType	CodeableConcept | None	Type of study	None
population	Reference | None	What population?	None
exposure	Reference | None	What exposure?	None
exposureAlternative	Reference | None	What comparison exposure?	None
outcome	Reference | None	What outcome?	None
sampleSize	EffectEvidenceSynthesisSampleSize | None	What sample size was involved?	None
resultsByExposure	List[EffectEvidenceSynthesisResultsByExposure] | None	What was the result per exposure?	None
effectEstimate	List[EffectEvidenceSynthesisEffectEstimate] | None	What was the estimated effect	None
certainty	List[EffectEvidenceSynthesisCertainty] | None	How certain is the effect	None
resourceType	Literal['EffectEvidenceSynthesis']		'EffectEvidenceSynthesis'

EffectEvidenceSynthesisCertainty

Path: fhircraft.fhir.resources.datatypes.R4.core.effect_evidence_synthesis.EffectEvidenceSynthesisCertainty

Bases: BackboneElement

A description of the certainty of the effect estimate.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
rating	List[CodeableConcept] | None	Certainty rating	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
certaintySubcomponent	List[EffectEvidenceSynthesisCertaintyCertaintySubcomponent] | None	A component that contributes to the overall certainty	None

EffectEvidenceSynthesisCertaintyCertaintySubcomponent

Path: fhircraft.fhir.resources.datatypes.R4.core.effect_evidence_synthesis.EffectEvidenceSynthesisCertaintyCertaintySubcomponent

Bases: BackboneElement

A description of a component of the overall certainty.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of subcomponent of certainty rating	None
rating	List[CodeableConcept] | None	Subcomponent certainty rating	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None

EffectEvidenceSynthesisEffectEstimate

Path: fhircraft.fhir.resources.datatypes.R4.core.effect_evidence_synthesis.EffectEvidenceSynthesisEffectEstimate

Bases: BackboneElement

The estimated effect of the exposure variant.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of effect estimate	None
description_ext	Element | None	Placeholder element for description extensions	None
type	CodeableConcept | None	Type of efffect estimate	None
variantState	CodeableConcept | None	Variant exposure states	None
value	Decimal | None	Point estimate	None
value_ext	Element | None	Placeholder element for value extensions	None
unitOfMeasure	CodeableConcept | None	What unit is the outcome described in?	None
precisionEstimate	List[EffectEvidenceSynthesisEffectEstimatePrecisionEstimate] | None	How precise the estimate is	None

EffectEvidenceSynthesisEffectEstimatePrecisionEstimate

Path: fhircraft.fhir.resources.datatypes.R4.core.effect_evidence_synthesis.EffectEvidenceSynthesisEffectEstimatePrecisionEstimate

Bases: BackboneElement

A description of the precision of the estimate for the effect.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of precision estimate	None
level	Decimal | None	Level of confidence interval	None
level_ext	Element | None	Placeholder element for level extensions	None
from_	Decimal | None	Lower bound	None
from_ext	Element | None	Placeholder element for from extensions	None
to	Decimal | None	Upper bound	None
to_ext	Element | None	Placeholder element for to extensions	None

EffectEvidenceSynthesisResultsByExposure

Path: fhircraft.fhir.resources.datatypes.R4.core.effect_evidence_synthesis.EffectEvidenceSynthesisResultsByExposure

Bases: BackboneElement

A description of the results for each exposure considered in the effect estimate.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of results by exposure	None
description_ext	Element | None	Placeholder element for description extensions	None
exposureState	Code | None	exposure | exposure-alternative	None
exposureState_ext	Element | None	Placeholder element for exposureState extensions	None
variantState	CodeableConcept | None	Variant exposure states	None
riskEvidenceSynthesis	Reference | None	Risk evidence synthesis	None

EffectEvidenceSynthesisSampleSize

Path: fhircraft.fhir.resources.datatypes.R4.core.effect_evidence_synthesis.EffectEvidenceSynthesisSampleSize

Bases: BackboneElement

A description of the size of the sample involved in the synthesis.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of sample size	None
description_ext	Element | None	Placeholder element for description extensions	None
numberOfStudies	Integer | None	How many studies?	None
numberOfStudies_ext	Element | None	Placeholder element for numberOfStudies extensions	None
numberOfParticipants	Integer | None	How many participants?	None
numberOfParticipants_ext	Element | None	Placeholder element for numberOfParticipants extensions	None

Encounter

Path: fhircraft.fhir.resources.datatypes.R4.core.encounter.Encounter

Bases: DomainResource

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Encounter'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifier(s) by which this encounter is known	None
status	Code | None	planned | arrived | triaged | in-progress | onleave | finished | cancelled +	None
status_ext	Element | None	Placeholder element for status extensions	None
statusHistory	List[EncounterStatusHistory] | None	List of past encounter statuses	None
class_	Coding | None	Classification of patient encounter	None
classHistory	List[EncounterClassHistory] | None	List of past encounter classes	None
type	List[CodeableConcept] | None	Specific type of encounter	None
serviceType	CodeableConcept | None	Specific type of service	None
priority	CodeableConcept | None	Indicates the urgency of the encounter	None
subject	Reference | None	The patient or group present at the encounter	None
episodeOfCare	List[Reference] | None	Episode(s) of care that this encounter should be recorded against	None
basedOn	List[Reference] | None	The ServiceRequest that initiated this encounter	None
participant	List[EncounterParticipant] | None	List of participants involved in the encounter	None
appointment	List[Reference] | None	The appointment that scheduled this encounter	None
period	Period | None	The start and end time of the encounter	None
length	Duration | None	Quantity of time the encounter lasted (less time absent)	None
reasonCode	List[CodeableConcept] | None	Coded reason the encounter takes place	None
reasonReference	List[Reference] | None	Reason the encounter takes place (reference)	None
diagnosis	List[EncounterDiagnosis] | None	The list of diagnosis relevant to this encounter	None
account	List[Reference] | None	The set of accounts that may be used for billing for this Encounter	None
hospitalization	EncounterHospitalization | None	Details about the admission to a healthcare service	None
location	List[EncounterLocation] | None	List of locations where the patient has been	None
serviceProvider	Reference | None	The organization (facility) responsible for this encounter	None
partOf	Reference | None	Another Encounter this encounter is part of	None
resourceType	Literal['Encounter']		'Encounter'

EncounterClassHistory

Path: fhircraft.fhir.resources.datatypes.R4.core.encounter.EncounterClassHistory

Bases: BackboneElement

The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
class_	Coding | None	inpatient | outpatient | ambulatory | emergency +	None
period	Period | None	The time that the episode was in the specified class	None

EncounterDiagnosis

Path: fhircraft.fhir.resources.datatypes.R4.core.encounter.EncounterDiagnosis

Bases: BackboneElement

The list of diagnosis relevant to this encounter.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
condition	Reference | None	The diagnosis or procedure relevant to the encounter	None
use	CodeableConcept | None	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)	None
rank	PositiveInt | None	Ranking of the diagnosis (for each role type)	None
rank_ext	Element | None	Placeholder element for rank extensions	None

EncounterHospitalization

Path: fhircraft.fhir.resources.datatypes.R4.core.encounter.EncounterHospitalization

Bases: BackboneElement

Details about the admission to a healthcare service.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
preAdmissionIdentifier	Identifier | None	Pre-admission identifier	None
origin	Reference | None	The location/organization from which the patient came before admission	None
admitSource	CodeableConcept | None	From where patient was admitted (physician referral, transfer)	None
reAdmission	CodeableConcept | None	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission	None
dietPreference	List[CodeableConcept] | None	Diet preferences reported by the patient	None
specialCourtesy	List[CodeableConcept] | None	Special courtesies (VIP, board member)	None
specialArrangement	List[CodeableConcept] | None	Wheelchair, translator, stretcher, etc.	None
destination	Reference | None	Location/organization to which the patient is discharged	None
dischargeDisposition	CodeableConcept | None	Category or kind of location after discharge	None

EncounterLocation

Path: fhircraft.fhir.resources.datatypes.R4.core.encounter.EncounterLocation

Bases: BackboneElement

List of locations where the patient has been during this encounter.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
location	Reference | None	Location the encounter takes place	None
status	Code | None	planned | active | reserved | completed	None
status_ext	Element | None	Placeholder element for status extensions	None
physicalType	CodeableConcept | None	The physical type of the location (usually the level in the location hierachy - bed room ward etc.)	None
period	Period | None	Time period during which the patient was present at the location	None

EncounterParticipant

Path: fhircraft.fhir.resources.datatypes.R4.core.encounter.EncounterParticipant

Bases: BackboneElement

The list of people responsible for providing the service.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	List[CodeableConcept] | None	Role of participant in encounter	None
period	Period | None	Period of time during the encounter that the participant participated	None
individual	Reference | None	Persons involved in the encounter other than the patient	None

EncounterStatusHistory

Path: fhircraft.fhir.resources.datatypes.R4.core.encounter.EncounterStatusHistory

Bases: BackboneElement

The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
status	Code | None	planned | arrived | triaged | in-progress | onleave | finished | cancelled +	None
status_ext	Element | None	Placeholder element for status extensions	None
period	Period | None	The time that the episode was in the specified status	None

Endpoint

Path: fhircraft.fhir.resources.datatypes.R4.core.endpoint.Endpoint

Bases: DomainResource

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Endpoint'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifies this endpoint across multiple systems	None
status	Code | None	active | suspended | error | off | entered-in-error | test	None
status_ext	Element | None	Placeholder element for status extensions	None
connectionType	Coding | None	Protocol/Profile/Standard to be used with this endpoint connection	None
name	String | None	A name that this endpoint can be identified by	None
name_ext	Element | None	Placeholder element for name extensions	None
managingOrganization	Reference | None	Organization that manages this endpoint (might not be the organization that exposes the endpoint)	None
contact	List[ContactPoint] | None	Contact details for source (e.g. troubleshooting)	None
period	Period | None	Interval the endpoint is expected to be operational	None
payloadType	List[CodeableConcept] | None	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)	None
payloadMimeType	List[Code] | None	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)	None
payloadMimeType_ext	Element | None	Placeholder element for payloadMimeType extensions	None
address	Url | None	The technical base address for connecting to this endpoint	None
address_ext	Element | None	Placeholder element for address extensions	None
header	List[String] | None	Usage depends on the channel type	None
header_ext	Element | None	Placeholder element for header extensions	None
resourceType	Literal['Endpoint']		'Endpoint'

EnrollmentRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.enrollment_request.EnrollmentRequest

Bases: DomainResource

This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/EnrollmentRequest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
created	DateTime | None	Creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
insurer	Reference | None	Target	None
provider	Reference | None	Responsible practitioner	None
candidate	Reference | None	The subject to be enrolled	None
coverage	Reference | None	Insurance information	None
resourceType	Literal['EnrollmentRequest']		'EnrollmentRequest'

EnrollmentResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.enrollment_response.EnrollmentResponse

Bases: DomainResource

This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/EnrollmentResponse'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
request	Reference | None	Claim reference	None
outcome	Code | None	queued | complete | error | partial	None
outcome_ext	Element | None	Placeholder element for outcome extensions	None
disposition	String | None	Disposition Message	None
disposition_ext	Element | None	Placeholder element for disposition extensions	None
created	DateTime | None	Creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
organization	Reference | None	Insurer	None
requestProvider	Reference | None	Responsible practitioner	None
resourceType	Literal['EnrollmentResponse']		'EnrollmentResponse'

EpisodeOfCare

Path: fhircraft.fhir.resources.datatypes.R4.core.episode_of_care.EpisodeOfCare

Bases: DomainResource

An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/EpisodeOfCare'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier(s) relevant for this EpisodeOfCare	None
status	Code | None	planned | waitlist | active | onhold | finished | cancelled | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
statusHistory	List[EpisodeOfCareStatusHistory] | None	Past list of status codes (the current status may be included to cover the start date of the status)	None
type	List[CodeableConcept] | None	Type/class - e.g. specialist referral, disease management	None
diagnosis	List[EpisodeOfCareDiagnosis] | None	The list of diagnosis relevant to this episode of care	None
patient	Reference | None	The patient who is the focus of this episode of care	None
managingOrganization	Reference | None	Organization that assumes care	None
period	Period | None	Interval during responsibility is assumed	None
referralRequest	List[Reference] | None	Originating Referral Request(s)	None
careManager	Reference | None	Care manager/care coordinator for the patient	None
team	List[Reference] | None	Other practitioners facilitating this episode of care	None
account	List[Reference] | None	The set of accounts that may be used for billing for this EpisodeOfCare	None
resourceType	Literal['EpisodeOfCare']		'EpisodeOfCare'

EpisodeOfCareDiagnosis

Path: fhircraft.fhir.resources.datatypes.R4.core.episode_of_care.EpisodeOfCareDiagnosis

Bases: BackboneElement

The list of diagnosis relevant to this episode of care.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
condition	Reference | None	Conditions/problems/diagnoses this episode of care is for	None
role	CodeableConcept | None	Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)	None
rank	PositiveInt | None	Ranking of the diagnosis (for each role type)	None
rank_ext	Element | None	Placeholder element for rank extensions	None

EpisodeOfCareStatusHistory

Path: fhircraft.fhir.resources.datatypes.R4.core.episode_of_care.EpisodeOfCareStatusHistory

Bases: BackboneElement

The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
status	Code | None	planned | waitlist | active | onhold | finished | cancelled | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
period	Period | None	Duration the EpisodeOfCare was in the specified status	None

EventDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.event_definition.EventDefinition

Bases: DomainResource

The EventDefinition resource provides a reusable description of when a particular event can occur.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/EventDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this event definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the event definition	None
version	String | None	Business version of the event definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this event definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this event definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
subtitle	String | None	Subordinate title of the event definition	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
subjectCodeableConcept	CodeableConcept | None	Type of individual the event definition is focused on	None
subjectReference	Reference | None	Type of individual the event definition is focused on	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the event definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for event definition (if applicable)	None
purpose	Markdown | None	Why this event definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
usage	String | None	Describes the clinical usage of the event definition	None
usage_ext	Element | None	Placeholder element for usage extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the event definition was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the event definition was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the event definition is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
trigger	List[TriggerDefinition] | None	"when" the event occurs (multiple = 'or')	None
resourceType	Literal['EventDefinition']		'EventDefinition'

Evidence

Path: fhircraft.fhir.resources.datatypes.R4.core.evidence.Evidence

Bases: DomainResource

The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Evidence'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this evidence, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the evidence	None
version	String | None	Business version of the evidence	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this evidence (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this evidence (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
shortTitle	String | None	Title for use in informal contexts	None
shortTitle_ext	Element | None	Placeholder element for shortTitle extensions	None
subtitle	String | None	Subordinate title of the Evidence	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the evidence	None
description_ext	Element | None	Placeholder element for description extensions	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for evidence (if applicable)	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the evidence was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the evidence was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the evidence is expected to be used	None
topic	List[CodeableConcept] | None	The category of the Evidence, such as Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
exposureBackground	Reference | None	What population?	None
exposureVariant	List[Reference] | None	What exposure?	None
outcome	List[Reference] | None	What outcome?	None
resourceType	Literal['Evidence']		'Evidence'

EvidenceVariable

Path: fhircraft.fhir.resources.datatypes.R4.core.evidence_variable.EvidenceVariable

Bases: DomainResource

The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/EvidenceVariable'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this evidence variable, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the evidence variable	None
version	String | None	Business version of the evidence variable	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this evidence variable (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this evidence variable (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
shortTitle	String | None	Title for use in informal contexts	None
shortTitle_ext	Element | None	Placeholder element for shortTitle extensions	None
subtitle	String | None	Subordinate title of the EvidenceVariable	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the evidence variable	None
description_ext	Element | None	Placeholder element for description extensions	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for evidence variable (if applicable)	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the evidence variable was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the evidence variable was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the evidence variable is expected to be used	None
topic	List[CodeableConcept] | None	The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
type	Code | None	dichotomous | continuous | descriptive	None
type_ext	Element | None	Placeholder element for type extensions	None
characteristic	List[EvidenceVariableCharacteristic] | None	What defines the members of the evidence element	None
resourceType	Literal['EvidenceVariable']		'EvidenceVariable'

EvidenceVariableCharacteristic

Path: fhircraft.fhir.resources.datatypes.R4.core.evidence_variable.EvidenceVariableCharacteristic

Bases: BackboneElement

A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Natural language description of the characteristic	None
description_ext	Element | None	Placeholder element for description extensions	None
definitionReference	Reference | None	What code or expression defines members?	None
definitionCanonical	Canonical | None	What code or expression defines members?	None
definitionCanonical_ext	Element | None	Placeholder element for definitionCanonical extensions	None
definitionCodeableConcept	CodeableConcept | None	What code or expression defines members?	None
definitionExpression	Expression | None	What code or expression defines members?	None
definitionDataRequirement	DataRequirement | None	What code or expression defines members?	None
definitionTriggerDefinition	TriggerDefinition | None	What code or expression defines members?	None
usageContext	List[UsageContext] | None	What code/value pairs define members?	None
exclude	Boolean | None	Whether the characteristic includes or excludes members	None
exclude_ext	Element | None	Placeholder element for exclude extensions	None
participantEffectiveDateTime	DateTime | None	What time period do participants cover	None
participantEffectiveDateTime_ext	Element | None	Placeholder element for participantEffectiveDateTime extensions	None
participantEffectivePeriod	Period | None	What time period do participants cover	None
participantEffectiveDuration	Duration | None	What time period do participants cover	None
participantEffectiveTiming	Timing | None	What time period do participants cover	None
timeFromStart	Duration | None	Observation time from study start	None
groupMeasure	Code | None	mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median	None
groupMeasure_ext	Element | None	Placeholder element for groupMeasure extensions	None

ExampleScenario

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenario

Bases: DomainResource

Example of workflow instance.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ExampleScenario'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this example scenario, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the example scenario	None
version	String | None	Business version of the example scenario	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this example scenario (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for example scenario (if applicable)	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
purpose	Markdown | None	The purpose of the example, e.g. to illustrate a scenario	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
actor	List[ExampleScenarioActor] | None	Actor participating in the resource	None
instance	List[ExampleScenarioInstance] | None	Each resource and each version that is present in the workflow	None
process	List[ExampleScenarioProcess] | None	Each major process - a group of operations	None
workflow	List[Canonical] | None	Another nested workflow	None
workflow_ext	Element | None	Placeholder element for workflow extensions	None
resourceType	Literal['ExampleScenario']		'ExampleScenario'

ExampleScenarioActor

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioActor

Bases: BackboneElement

Actor participating in the resource.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
actorId	String | None	ID or acronym of the actor	None
actorId_ext	Element | None	Placeholder element for actorId extensions	None
type	Code | None	person | entity	None
type_ext	Element | None	Placeholder element for type extensions	None
name	String | None	The name of the actor as shown in the page	None
name_ext	Element | None	Placeholder element for name extensions	None
description	Markdown | None	The description of the actor	None
description_ext	Element | None	Placeholder element for description extensions	None

ExampleScenarioInstance

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioInstance

Bases: BackboneElement

Each resource and each version that is present in the workflow.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
resourceId	String | None	The id of the resource for referencing	None
resourceId_ext	Element | None	Placeholder element for resourceId extensions	None
resourceType	Code | None	The type of the resource	None
resourceType_ext	Element | None	Placeholder element for resourceType extensions	None
name	String | None	A short name for the resource instance	None
name_ext	Element | None	Placeholder element for name extensions	None
description	Markdown | None	Human-friendly description of the resource instance	None
description_ext	Element | None	Placeholder element for description extensions	None
version	List[ExampleScenarioInstanceVersion] | None	A specific version of the resource	None
containedInstance	List[ExampleScenarioInstanceContainedInstance] | None	Resources contained in the instance	None

ExampleScenarioInstanceContainedInstance

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioInstanceContainedInstance

Bases: BackboneElement

Resources contained in the instance (e.g. the observations contained in a bundle).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
resourceId	String | None	Each resource contained in the instance	None
resourceId_ext	Element | None	Placeholder element for resourceId extensions	None
versionId	String | None	A specific version of a resource contained in the instance	None
versionId_ext	Element | None	Placeholder element for versionId extensions	None

ExampleScenarioInstanceVersion

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioInstanceVersion

Bases: BackboneElement

A specific version of the resource.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
versionId	String | None	The identifier of a specific version of a resource	None
versionId_ext	Element | None	Placeholder element for versionId extensions	None
description	Markdown | None	The description of the resource version	None
description_ext	Element | None	Placeholder element for description extensions	None

ExampleScenarioProcess

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioProcess

Bases: BackboneElement

Each major process - a group of operations.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
title	String | None	The diagram title of the group of operations	None
title_ext	Element | None	Placeholder element for title extensions	None
description	Markdown | None	A longer description of the group of operations	None
description_ext	Element | None	Placeholder element for description extensions	None
preConditions	Markdown | None	Description of initial status before the process starts	None
preConditions_ext	Element | None	Placeholder element for preConditions extensions	None
postConditions	Markdown | None	Description of final status after the process ends	None
postConditions_ext	Element | None	Placeholder element for postConditions extensions	None
step	List[ExampleScenarioProcessStep] | None	Each step of the process	None

ExampleScenarioProcessStep

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioProcessStep

Bases: BackboneElement

Each step of the process.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
process	List[ExampleScenarioProcess] | None	Nested process	None
pause	Boolean | None	If there is a pause in the flow	None
pause_ext	Element | None	Placeholder element for pause extensions	None
operation	ExampleScenarioProcessStepOperation | None	Each interaction or action	None
alternative	List[ExampleScenarioProcessStepAlternative] | None	Alternate non-typical step action	None

ExampleScenarioProcessStepAlternative

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioProcessStepAlternative

Bases: BackboneElement

Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
title	String | None	Label for alternative	None
title_ext	Element | None	Placeholder element for title extensions	None
description	Markdown | None	A human-readable description of each option	None
description_ext	Element | None	Placeholder element for description extensions	None
step	List[ExampleScenarioProcessStep] | None	What happens in each alternative option	None

ExampleScenarioProcessStepOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioProcessStepOperation

Bases: BackboneElement

Each interaction or action.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
number	String | None	The sequential number of the interaction	None
number_ext	Element | None	Placeholder element for number extensions	None
type	String | None	The type of operation - CRUD	None
type_ext	Element | None	Placeholder element for type extensions	None
name	String | None	The human-friendly name of the interaction	None
name_ext	Element | None	Placeholder element for name extensions	None
initiator	String | None	Who starts the transaction	None
initiator_ext	Element | None	Placeholder element for initiator extensions	None
receiver	String | None	Who receives the transaction	None
receiver_ext	Element | None	Placeholder element for receiver extensions	None
description	Markdown | None	A comment to be inserted in the diagram	None
description_ext	Element | None	Placeholder element for description extensions	None
initiatorActive	Boolean | None	Whether the initiator is deactivated right after the transaction	None
initiatorActive_ext	Element | None	Placeholder element for initiatorActive extensions	None
receiverActive	Boolean | None	Whether the receiver is deactivated right after the transaction	None
receiverActive_ext	Element | None	Placeholder element for receiverActive extensions	None
request	ExampleScenarioProcessStepOperationRequest | None	Each resource instance used by the initiator	None
response	ExampleScenarioInstanceContainedInstance | None	Each resource instance used by the responder	None

ExampleScenarioProcessStepOperationRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.example_scenario.ExampleScenarioProcessStepOperationRequest

Bases: BackboneElement

Each resource instance used by the initiator.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
resourceId	String | None	Each resource contained in the instance	None
resourceId_ext	Element | None	Placeholder element for resourceId extensions	None
versionId	String | None	A specific version of a resource contained in the instance	None
versionId_ext	Element | None	Placeholder element for versionId extensions	None

ExplanationOfBenefit

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefit

Bases: DomainResource

This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for the resource	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	Category or discipline	None
subType	CodeableConcept | None	More granular claim type	None
use	Code | None	claim | preauthorization | predetermination	None
use_ext	Element | None	Placeholder element for use extensions	None
patient	Reference | None	The recipient of the products and services	None
billablePeriod	Period | None	Relevant time frame for the claim	None
created	DateTime | None	Response creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
enterer	Reference | None	Author of the claim	None
insurer	Reference | None	Party responsible for reimbursement	None
provider	Reference | None	Party responsible for the claim	None
priority	CodeableConcept | None	Desired processing urgency	None
fundsReserveRequested	CodeableConcept | None	For whom to reserve funds	None
fundsReserve	CodeableConcept | None	Funds reserved status	None
related	List[ExplanationOfBenefitRelated] | None	Prior or corollary claims	None
prescription	Reference | None	Prescription authorizing services or products	None
originalPrescription	Reference | None	Original prescription if superceded by fulfiller	None
payee	ExplanationOfBenefitPayee | None	Recipient of benefits payable	None
referral	Reference | None	Treatment Referral	None
facility	Reference | None	Servicing Facility	None
claim	Reference | None	Claim reference	None
claimResponse	Reference | None	Claim response reference	None
outcome	Code | None	queued | complete | error | partial	None
outcome_ext	Element | None	Placeholder element for outcome extensions	None
disposition	String | None	Disposition Message	None
disposition_ext	Element | None	Placeholder element for disposition extensions	None
preAuthRef	List[String] | None	Preauthorization reference	None
preAuthRef_ext	Element | None	Placeholder element for preAuthRef extensions	None
preAuthRefPeriod	List[Period] | None	Preauthorization in-effect period	None
careTeam	List[ExplanationOfBenefitCareTeam] | None	Care Team members	None
supportingInfo	List[ExplanationOfBenefitSupportingInfo] | None	Supporting information	None
diagnosis	List[ExplanationOfBenefitDiagnosis] | None	Pertinent diagnosis information	None
procedure	List[ExplanationOfBenefitProcedure] | None	Clinical procedures performed	None
precedence	PositiveInt | None	Precedence (primary, secondary, etc.)	None
precedence_ext	Element | None	Placeholder element for precedence extensions	None
insurance	List[ExplanationOfBenefitInsurance] | None	Patient insurance information	None
accident	ExplanationOfBenefitAccident | None	Details of the event	None
item	List[ExplanationOfBenefitItem] | None	Product or service provided	None
addItem	List[ExplanationOfBenefitAddItem] | None	Insurer added line items	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Header-level adjudication	None
total	List[ExplanationOfBenefitTotal] | None	Adjudication totals	None
payment	ExplanationOfBenefitPayment | None	Payment Details	None
formCode	CodeableConcept | None	Printed form identifier	None
form	Attachment | None	Printed reference or actual form	None
processNote	List[ExplanationOfBenefitProcessNote] | None	Note concerning adjudication	None
benefitPeriod	Period | None	When the benefits are applicable	None
benefitBalance	List[ExplanationOfBenefitBenefitBalance] | None	Balance by Benefit Category	None
resourceType	Literal['ExplanationOfBenefit']		'ExplanationOfBenefit'

ExplanationOfBenefitAccident

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitAccident

Bases: BackboneElement

Details of a accident which resulted in injuries which required the products and services listed in the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
date	Date | None	When the incident occurred	None
date_ext	Element | None	Placeholder element for date extensions	None
type	CodeableConcept | None	The nature of the accident	None
locationAddress	Address | None	Where the event occurred	None
locationReference	Reference | None	Where the event occurred	None

ExplanationOfBenefitAddItem

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitAddItem

Bases: BackboneElement

The first-tier service adjudications for payor added product or service lines.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemSequence	List[PositiveInt] | None	Item sequence number	None
itemSequence_ext	Element | None	Placeholder element for itemSequence extensions	None
detailSequence	List[PositiveInt] | None	Detail sequence number	None
detailSequence_ext	Element | None	Placeholder element for detailSequence extensions	None
subDetailSequence	List[PositiveInt] | None	Subdetail sequence number	None
subDetailSequence_ext	Element | None	Placeholder element for subDetailSequence extensions	None
provider	List[Reference] | None	Authorized providers	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
servicedDate	Date | None	Date or dates of service or product delivery	None
servicedDate_ext	Element | None	Placeholder element for servicedDate extensions	None
servicedPeriod	Period | None	Date or dates of service or product delivery	None
locationCodeableConcept	CodeableConcept | None	Place of service or where product was supplied	None
locationAddress	Address | None	Place of service or where product was supplied	None
locationReference	Reference | None	Place of service or where product was supplied	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
bodySite	CodeableConcept | None	Anatomical location	None
subSite	List[CodeableConcept] | None	Anatomical sub-location	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Added items adjudication	None
detail	List[ExplanationOfBenefitAddItemDetail] | None	Insurer added line items	None

ExplanationOfBenefitAddItemDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitAddItemDetail

Bases: BackboneElement

The second-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Added items adjudication	None
subDetail	List[ExplanationOfBenefitAddItemDetailSubDetail] | None	Insurer added line items	None

ExplanationOfBenefitAddItemDetailSubDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitAddItemDetailSubDetail

Bases: BackboneElement

The third-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Added items adjudication	None

ExplanationOfBenefitBenefitBalance

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitBenefitBalance

Bases: BackboneElement

Balance by Benefit Category.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Benefit classification	None
excluded	Boolean | None	Excluded from the plan	None
excluded_ext	Element | None	Placeholder element for excluded extensions	None
name	String | None	Short name for the benefit	None
name_ext	Element | None	Placeholder element for name extensions	None
description	String | None	Description of the benefit or services covered	None
description_ext	Element | None	Placeholder element for description extensions	None
network	CodeableConcept | None	In or out of network	None
unit	CodeableConcept | None	Individual or family	None
term	CodeableConcept | None	Annual or lifetime	None
financial	List[ExplanationOfBenefitBenefitBalanceFinancial] | None	Benefit Summary	None

ExplanationOfBenefitBenefitBalanceFinancial

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitBenefitBalanceFinancial

Bases: BackboneElement

Benefits Used to date.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Benefit classification	None
allowedUnsignedInt	UnsignedInt | None	Benefits allowed	None
allowedUnsignedInt_ext	Element | None	Placeholder element for allowedUnsignedInt extensions	None
allowedString	String | None	Benefits allowed	None
allowedString_ext	Element | None	Placeholder element for allowedString extensions	None
allowedMoney	Money | None	Benefits allowed	None
usedUnsignedInt	UnsignedInt | None	Benefits used	None
usedUnsignedInt_ext	Element | None	Placeholder element for usedUnsignedInt extensions	None
usedMoney	Money | None	Benefits used	None

ExplanationOfBenefitCareTeam

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitCareTeam

Bases: BackboneElement

The members of the team who provided the products and services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Order of care team	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
provider	Reference | None	Practitioner or organization	None
responsible	Boolean | None	Indicator of the lead practitioner	None
responsible_ext	Element | None	Placeholder element for responsible extensions	None
role	CodeableConcept | None	Function within the team	None
qualification	CodeableConcept | None	Practitioner credential or specialization	None

ExplanationOfBenefitDiagnosis

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitDiagnosis

Bases: BackboneElement

Information about diagnoses relevant to the claim items.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Diagnosis instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
diagnosisCodeableConcept	CodeableConcept | None	Nature of illness or problem	None
diagnosisReference	Reference | None	Nature of illness or problem	None
type	List[CodeableConcept] | None	Timing or nature of the diagnosis	None
onAdmission	CodeableConcept | None	Present on admission	None
packageCode	CodeableConcept | None	Package billing code	None

ExplanationOfBenefitInsurance

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitInsurance

Bases: BackboneElement

Financial instruments for reimbursement for the health care products and services specified on the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
focal	Boolean | None	Coverage to be used for adjudication	None
focal_ext	Element | None	Placeholder element for focal extensions	None
coverage	Reference | None	Insurance information	None
preAuthRef	List[String] | None	Prior authorization reference number	None
preAuthRef_ext	Element | None	Placeholder element for preAuthRef extensions	None

ExplanationOfBenefitItem

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitItem

Bases: BackboneElement

A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Item instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
careTeamSequence	List[PositiveInt] | None	Applicable care team members	None
careTeamSequence_ext	Element | None	Placeholder element for careTeamSequence extensions	None
diagnosisSequence	List[PositiveInt] | None	Applicable diagnoses	None
diagnosisSequence_ext	Element | None	Placeholder element for diagnosisSequence extensions	None
procedureSequence	List[PositiveInt] | None	Applicable procedures	None
procedureSequence_ext	Element | None	Placeholder element for procedureSequence extensions	None
informationSequence	List[PositiveInt] | None	Applicable exception and supporting information	None
informationSequence_ext	Element | None	Placeholder element for informationSequence extensions	None
revenue	CodeableConcept | None	Revenue or cost center code	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Product or service billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
servicedDate	Date | None	Date or dates of service or product delivery	None
servicedDate_ext	Element | None	Placeholder element for servicedDate extensions	None
servicedPeriod	Period | None	Date or dates of service or product delivery	None
locationCodeableConcept	CodeableConcept | None	Place of service or where product was supplied	None
locationAddress	Address | None	Place of service or where product was supplied	None
locationReference	Reference | None	Place of service or where product was supplied	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
bodySite	CodeableConcept | None	Anatomical location	None
subSite	List[CodeableConcept] | None	Anatomical sub-location	None
encounter	List[Reference] | None	Encounters related to this billed item	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Adjudication details	None
detail	List[ExplanationOfBenefitItemDetail] | None	Additional items	None

ExplanationOfBenefitItemAdjudication

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitItemAdjudication

Bases: BackboneElement

If this item is a group then the values here are a summary of the adjudication of the detail items. If this item is a simple product or service then this is the result of the adjudication of this item.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Type of adjudication information	None
reason	CodeableConcept | None	Explanation of adjudication outcome	None
amount	Money | None	Monetary amount	None
value	Decimal | None	Non-monitary value	None
value_ext	Element | None	Placeholder element for value extensions	None

ExplanationOfBenefitItemDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitItemDetail

Bases: BackboneElement

Second-tier of goods and services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Product or service provided	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
revenue	CodeableConcept | None	Revenue or cost center code	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ExplanationOfBenefitItemDetailAdjudication] | None	Detail level adjudication details	None
subDetail	List[ExplanationOfBenefitItemDetailSubDetail] | None	Additional items	None

ExplanationOfBenefitItemDetailAdjudication

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitItemDetailAdjudication

Bases: BackboneElement

The adjudication results.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Type of adjudication information	None
reason	CodeableConcept | None	Explanation of adjudication outcome	None
amount	Money | None	Monetary amount	None
value	Decimal | None	Non-monitary value	None
value_ext	Element | None	Placeholder element for value extensions	None

ExplanationOfBenefitItemDetailSubDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitItemDetailSubDetail

Bases: BackboneElement

Third-tier of goods and services.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Product or service provided	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
revenue	CodeableConcept | None	Revenue or cost center code	None
category	CodeableConcept | None	Benefit classification	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Decimal | None	Price scaling factor	None
factor_ext	Element | None	Placeholder element for factor extensions	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
noteNumber	List[PositiveInt] | None	Applicable note numbers	None
noteNumber_ext	Element | None	Placeholder element for noteNumber extensions	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Subdetail level adjudication details	None

ExplanationOfBenefitPayee

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitPayee

Bases: BackboneElement

The party to be reimbursed for cost of the products and services according to the terms of the policy.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Category of recipient	None
party	Reference | None	Recipient reference	None

ExplanationOfBenefitPayment

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitPayment

Bases: BackboneElement

Payment details for the adjudication of the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Partial or complete payment	None
adjustment	Money | None	Payment adjustment for non-claim issues	None
adjustmentReason	CodeableConcept | None	Explanation for the variance	None
date	Date | None	Expected date of payment	None
date_ext	Element | None	Placeholder element for date extensions	None
amount	Money | None	Payable amount after adjustment	None
identifier	Identifier | None	Business identifier for the payment	None

ExplanationOfBenefitProcedure

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitProcedure

Bases: BackboneElement

Procedures performed on the patient relevant to the billing items with the claim.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Procedure instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
type	List[CodeableConcept] | None	Category of Procedure	None
date	DateTime | None	When the procedure was performed	None
date_ext	Element | None	Placeholder element for date extensions	None
procedureCodeableConcept	CodeableConcept | None	Specific clinical procedure	None
procedureReference	Reference | None	Specific clinical procedure	None
udi	List[Reference] | None	Unique device identifier	None

ExplanationOfBenefitProcessNote

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitProcessNote

Bases: BackboneElement

A note that describes or explains adjudication results in a human readable form.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
number	PositiveInt | None	Note instance identifier	None
number_ext	Element | None	Placeholder element for number extensions	None
type	Code | None	display | print | printoper	None
type_ext	Element | None	Placeholder element for type extensions	None
text	String | None	Note explanatory text	None
text_ext	Element | None	Placeholder element for text extensions	None
language	CodeableConcept | None	Language of the text	None

ExplanationOfBenefitRelated

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitRelated

Bases: BackboneElement

Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
claim	Reference | None	Reference to the related claim	None
relationship	CodeableConcept | None	How the reference claim is related	None
reference	Identifier | None	File or case reference	None

ExplanationOfBenefitSupportingInfo

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitSupportingInfo

Bases: BackboneElement

Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Information instance identifier	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
category	CodeableConcept | None	Classification of the supplied information	None
code	CodeableConcept | None	Type of information	None
timingDate	Date | None	When it occurred	None
timingDate_ext	Element | None	Placeholder element for timingDate extensions	None
timingPeriod	Period | None	When it occurred	None
valueBoolean	Boolean | None	Data to be provided	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueString	String | None	Data to be provided	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueQuantity	Quantity | None	Data to be provided	None
valueAttachment	Attachment | None	Data to be provided	None
valueReference	Reference | None	Data to be provided	None
reason	Coding | None	Explanation for the information	None

ExplanationOfBenefitTotal

Path: fhircraft.fhir.resources.datatypes.R4.core.explanation_of_benefit.ExplanationOfBenefitTotal

Bases: BackboneElement

Categorized monetary totals for the adjudication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	Type of adjudication information	None
amount	Money | None	Financial total for the category	None

FamilyMemberHistory

Path: fhircraft.fhir.resources.datatypes.R4.core.family_member_history.FamilyMemberHistory

Bases: DomainResource

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Id(s) for this record	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
status	Code | None	partial | completed | entered-in-error | health-unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
dataAbsentReason	CodeableConcept | None	subject-unknown | withheld | unable-to-obtain | deferred	None
patient	Reference | None	Patient history is about	None
date	DateTime | None	When history was recorded or last updated	None
date_ext	Element | None	Placeholder element for date extensions	None
name	String | None	The family member described	None
name_ext	Element | None	Placeholder element for name extensions	None
relationship	CodeableConcept | None	Relationship to the subject	None
sex	CodeableConcept | None	male | female | other | unknown	None
bornPeriod	Period | None	(approximate) date of birth	None
bornDate	Date | None	(approximate) date of birth	None
bornDate_ext	Element | None	Placeholder element for bornDate extensions	None
bornString	String | None	(approximate) date of birth	None
bornString_ext	Element | None	Placeholder element for bornString extensions	None
ageAge	Age | None	(approximate) age	None
ageRange	Range | None	(approximate) age	None
ageString	String | None	(approximate) age	None
ageString_ext	Element | None	Placeholder element for ageString extensions	None
estimatedAge	Boolean | None	Age is estimated?	None
estimatedAge_ext	Element | None	Placeholder element for estimatedAge extensions	None
deceasedBoolean	Boolean | None	Dead? How old/when?	None
deceasedBoolean_ext	Element | None	Placeholder element for deceasedBoolean extensions	None
deceasedAge	Age | None	Dead? How old/when?	None
deceasedRange	Range | None	Dead? How old/when?	None
deceasedDate	Date | None	Dead? How old/when?	None
deceasedDate_ext	Element | None	Placeholder element for deceasedDate extensions	None
deceasedString	String | None	Dead? How old/when?	None
deceasedString_ext	Element | None	Placeholder element for deceasedString extensions	None
reasonCode	List[CodeableConcept] | None	Why was family member history performed?	None
reasonReference	List[Reference] | None	Why was family member history performed?	None
note	List[Annotation] | None	General note about related person	None
condition	List[FamilyMemberHistoryCondition] | None	Condition that the related person had	None
resourceType	Literal['FamilyMemberHistory']		'FamilyMemberHistory'

FamilyMemberHistoryCondition

Path: fhircraft.fhir.resources.datatypes.R4.core.family_member_history.FamilyMemberHistoryCondition

Bases: BackboneElement

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Condition suffered by relation	None
outcome	CodeableConcept | None	deceased | permanent disability | etc.	None
contributedToDeath	Boolean | None	Whether the condition contributed to the cause of death	None
contributedToDeath_ext	Element | None	Placeholder element for contributedToDeath extensions	None
onsetAge	Age | None	When condition first manifested	None
onsetRange	Range | None	When condition first manifested	None
onsetPeriod	Period | None	When condition first manifested	None
onsetString	String | None	When condition first manifested	None
onsetString_ext	Element | None	Placeholder element for onsetString extensions	None
note	List[Annotation] | None	Extra information about condition	None

Flag

Path: fhircraft.fhir.resources.datatypes.R4.core.flag.Flag

Bases: DomainResource

Prospective warnings of potential issues when providing care to the patient.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Flag'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
status	Code | None	active | inactive | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
category	List[CodeableConcept] | None	Clinical, administrative, etc.	None
code	CodeableConcept | None	Coded or textual message to display to user	None
subject	Reference | None	Who/What is flag about?	None
period	Period | None	Time period when flag is active	None
encounter	Reference | None	Alert relevant during encounter	None
author	Reference | None	Flag creator	None
resourceType	Literal['Flag']		'Flag'

Goal

Path: fhircraft.fhir.resources.datatypes.R4.core.goal.Goal

Bases: DomainResource

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Goal'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this goal	None
lifecycleStatus	Code | None	proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected	None
lifecycleStatus_ext	Element | None	Placeholder element for lifecycleStatus extensions	None
achievementStatus	CodeableConcept | None	in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable	None
category	List[CodeableConcept] | None	E.g. Treatment, dietary, behavioral, etc.	None
priority	CodeableConcept | None	high-priority | medium-priority | low-priority	None
description	CodeableConcept | None	Code or text describing goal	None
subject	Reference | None	Who this goal is intended for	None
startDate	Date | None	When goal pursuit begins	None
startDate_ext	Element | None	Placeholder element for startDate extensions	None
startCodeableConcept	CodeableConcept | None	When goal pursuit begins	None
target	List[GoalTarget] | None	Target outcome for the goal	None
statusDate	Date | None	When goal status took effect	None
statusDate_ext	Element | None	Placeholder element for statusDate extensions	None
statusReason	String | None	Reason for current status	None
statusReason_ext	Element | None	Placeholder element for statusReason extensions	None
expressedBy	Reference | None	Who's responsible for creating Goal?	None
addresses	List[Reference] | None	Issues addressed by this goal	None
note	List[Annotation] | None	Comments about the goal	None
outcomeCode	List[CodeableConcept] | None	What result was achieved regarding the goal?	None
outcomeReference	List[Reference] | None	Observation that resulted from goal	None
resourceType	Literal['Goal']		'Goal'

GoalTarget

Path: fhircraft.fhir.resources.datatypes.R4.core.goal.GoalTarget

Bases: BackboneElement

Indicates what should be done by when.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
measure	CodeableConcept | None	The parameter whose value is being tracked	None
detailQuantity	Quantity | None	The target value to be achieved	None
detailRange	Range | None	The target value to be achieved	None
detailCodeableConcept	CodeableConcept | None	The target value to be achieved	None
detailString	String | None	The target value to be achieved	None
detailString_ext	Element | None	Placeholder element for detailString extensions	None
detailBoolean	Boolean | None	The target value to be achieved	None
detailBoolean_ext	Element | None	Placeholder element for detailBoolean extensions	None
detailInteger	Integer | None	The target value to be achieved	None
detailInteger_ext	Element | None	Placeholder element for detailInteger extensions	None
detailRatio	Ratio | None	The target value to be achieved	None
dueDate	Date | None	Reach goal on or before	None
dueDate_ext	Element | None	Placeholder element for dueDate extensions	None
dueDuration	Duration | None	Reach goal on or before	None

GraphDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.graph_definition.GraphDefinition

Bases: DomainResource

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/GraphDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this graph definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the graph definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this graph definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the graph definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for graph definition (if applicable)	None
purpose	Markdown | None	Why this graph definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
start	Code | None	Type of resource at which the graph starts	None
start_ext	Element | None	Placeholder element for start extensions	None
profile	Canonical | None	Profile on base resource	None
profile_ext	Element | None	Placeholder element for profile extensions	None
link	List[GraphDefinitionLink] | None	Links this graph makes rules about	None
resourceType	Literal['GraphDefinition']		'GraphDefinition'

GraphDefinitionLink

Path: fhircraft.fhir.resources.datatypes.R4.core.graph_definition.GraphDefinitionLink

Bases: BackboneElement

Links this graph makes rules about.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
path	String | None	Path in the resource that contains the link	None
path_ext	Element | None	Placeholder element for path extensions	None
sliceName	String | None	Which slice (if profiled)	None
sliceName_ext	Element | None	Placeholder element for sliceName extensions	None
min	Integer | None	Minimum occurrences for this link	None
min_ext	Element | None	Placeholder element for min extensions	None
max	String | None	Maximum occurrences for this link	None
max_ext	Element | None	Placeholder element for max extensions	None
description	String | None	Why this link is specified	None
description_ext	Element | None	Placeholder element for description extensions	None
target	List[GraphDefinitionLinkTarget] | None	Potential target for the link	None

GraphDefinitionLinkTarget

Path: fhircraft.fhir.resources.datatypes.R4.core.graph_definition.GraphDefinitionLinkTarget

Bases: BackboneElement

Potential target for the link.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	Type of resource this link refers to	None
type_ext	Element | None	Placeholder element for type extensions	None
params	String | None	Criteria for reverse lookup	None
params_ext	Element | None	Placeholder element for params extensions	None
profile	Canonical | None	Profile for the target resource	None
profile_ext	Element | None	Placeholder element for profile extensions	None
compartment	List[GraphDefinitionLinkTargetCompartment] | None	Compartment Consistency Rules	None
link	List[GraphDefinitionLink] | None	Additional links from target resource	None

GraphDefinitionLinkTargetCompartment

Path: fhircraft.fhir.resources.datatypes.R4.core.graph_definition.GraphDefinitionLinkTargetCompartment

Bases: BackboneElement

Compartment Consistency Rules.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
use	Code | None	condition | requirement	None
use_ext	Element | None	Placeholder element for use extensions	None
code	Code | None	Patient | Encounter | RelatedPerson | Practitioner | Device	None
code_ext	Element | None	Placeholder element for code extensions	None
rule	Code | None	identical | matching | different | custom	None
rule_ext	Element | None	Placeholder element for rule extensions	None
expression	String | None	Custom rule, as a FHIRPath expression	None
expression_ext	Element | None	Placeholder element for expression extensions	None
description	String | None	Documentation for FHIRPath expression	None
description_ext	Element | None	Placeholder element for description extensions	None

Group

Path: fhircraft.fhir.resources.datatypes.R4.core.group.Group

Bases: DomainResource

Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Group'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique id	None
active	Boolean | None	Whether this group's record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
type	Code | None	person | animal | practitioner | device | medication | substance	None
type_ext	Element | None	Placeholder element for type extensions	None
actual	Boolean | None	Descriptive or actual	None
actual_ext	Element | None	Placeholder element for actual extensions	None
code	CodeableConcept | None	Kind of Group members	None
name	String | None	Label for Group	None
name_ext	Element | None	Placeholder element for name extensions	None
quantity	UnsignedInt | None	Number of members	None
quantity_ext	Element | None	Placeholder element for quantity extensions	None
managingEntity	Reference | None	Entity that is the custodian of the Group's definition	None
characteristic	List[GroupCharacteristic] | None	Include / Exclude group members by Trait	None
member	List[GroupMember] | None	Who or what is in group	None
resourceType	Literal['Group']		'Group'

GroupCharacteristic

Path: fhircraft.fhir.resources.datatypes.R4.core.group.GroupCharacteristic

Bases: BackboneElement

Identifies traits whose presence r absence is shared by members of the group.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Kind of characteristic	None
valueCodeableConcept	CodeableConcept | None	Value held by characteristic	None
valueBoolean	Boolean | None	Value held by characteristic	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueQuantity	Quantity | None	Value held by characteristic	None
valueRange	Range | None	Value held by characteristic	None
valueReference	Reference | None	Value held by characteristic	None
exclude	Boolean | None	Group includes or excludes	None
exclude_ext	Element | None	Placeholder element for exclude extensions	None
period	Period | None	Period over which characteristic is tested	None

GroupMember

Path: fhircraft.fhir.resources.datatypes.R4.core.group.GroupMember

Bases: BackboneElement

Identifies the resource instances that are members of the group.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
entity	Reference | None	Reference to the group member	None
period	Period | None	Period member belonged to the group	None
inactive	Boolean | None	If member is no longer in group	None
inactive_ext	Element | None	Placeholder element for inactive extensions	None

GuidanceResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.guidance_response.GuidanceResponse

Bases: DomainResource

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/GuidanceResponse'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
requestIdentifier	Identifier | None	The identifier of the request associated with this response, if any	None
identifier	List[Identifier] | None	Business identifier	None
moduleUri	Uri | None	What guidance was requested	None
moduleUri_ext	Element | None	Placeholder element for moduleUri extensions	None
moduleCanonical	Canonical | None	What guidance was requested	None
moduleCanonical_ext	Element | None	Placeholder element for moduleCanonical extensions	None
moduleCodeableConcept	CodeableConcept | None	What guidance was requested	None
status	Code | None	success | data-requested | data-required | in-progress | failure | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
subject	Reference | None	Patient the request was performed for	None
encounter	Reference | None	Encounter during which the response was returned	None
occurrenceDateTime	DateTime | None	When the guidance response was processed	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
performer	Reference | None	Device returning the guidance	None
reasonCode	List[CodeableConcept] | None	Why guidance is needed	None
reasonReference	List[Reference] | None	Why guidance is needed	None
note	List[Annotation] | None	Additional notes about the response	None
evaluationMessage	List[Reference] | None	Messages resulting from the evaluation of the artifact or artifacts	None
outputParameters	Reference | None	The output parameters of the evaluation, if any	None
result	Reference | None	Proposed actions, if any	None
dataRequirement	List[DataRequirement] | None	Additional required data	None
resourceType	Literal['GuidanceResponse']		'GuidanceResponse'

HealthcareService

Path: fhircraft.fhir.resources.datatypes.R4.core.healthcare_service.HealthcareService

Bases: DomainResource

The details of a healthcare service available at a location.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/HealthcareService'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External identifiers for this item	None
active	Boolean | None	Whether this HealthcareService record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
providedBy	Reference | None	Organization that provides this service	None
category	List[CodeableConcept] | None	Broad category of service being performed or delivered	None
type	List[CodeableConcept] | None	Type of service that may be delivered or performed	None
specialty	List[CodeableConcept] | None	Specialties handled by the HealthcareService	None
location	List[Reference] | None	Location(s) where service may be provided	None
name	String | None	Description of service as presented to a consumer while searching	None
name_ext	Element | None	Placeholder element for name extensions	None
comment	String | None	Additional description and/or any specific issues not covered elsewhere	None
comment_ext	Element | None	Placeholder element for comment extensions	None
extraDetails	Markdown | None	Extra details about the service that can't be placed in the other fields	None
extraDetails_ext	Element | None	Placeholder element for extraDetails extensions	None
photo	Attachment | None	Facilitates quick identification of the service	None
telecom	List[ContactPoint] | None	Contacts related to the healthcare service	None
coverageArea	List[Reference] | None	Location(s) service is intended for/available to	None
serviceProvisionCode	List[CodeableConcept] | None	Conditions under which service is available/offered	None
eligibility	List[HealthcareServiceEligibility] | None	Specific eligibility requirements required to use the service	None
program	List[CodeableConcept] | None	Programs that this service is applicable to	None
characteristic	List[CodeableConcept] | None	Collection of characteristics (attributes)	None
communication	List[CodeableConcept] | None	The language that this service is offered in	None
referralMethod	List[CodeableConcept] | None	Ways that the service accepts referrals	None
appointmentRequired	Boolean | None	If an appointment is required for access to this service	None
appointmentRequired_ext	Element | None	Placeholder element for appointmentRequired extensions	None
availableTime	List[HealthcareServiceAvailableTime] | None	Times the Service Site is available	None
notAvailable	List[HealthcareServiceNotAvailable] | None	Not available during this time due to provided reason	None
availabilityExceptions	String | None	Description of availability exceptions	None
availabilityExceptions_ext	Element | None	Placeholder element for availabilityExceptions extensions	None
endpoint	List[Reference] | None	Technical endpoints providing access to electronic services operated for the healthcare service	None
resourceType	Literal['HealthcareService']		'HealthcareService'

HealthcareServiceAvailableTime

Path: fhircraft.fhir.resources.datatypes.R4.core.healthcare_service.HealthcareServiceAvailableTime

Bases: BackboneElement

A collection of times that the Service Site is available.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
daysOfWeek	List[Code] | None	mon | tue | wed | thu | fri | sat | sun	None
daysOfWeek_ext	Element | None	Placeholder element for daysOfWeek extensions	None
allDay	Boolean | None	Always available? e.g. 24 hour service	None
allDay_ext	Element | None	Placeholder element for allDay extensions	None
availableStartTime	Time | None	Opening time of day (ignored if allDay = true)	None
availableStartTime_ext	Element | None	Placeholder element for availableStartTime extensions	None
availableEndTime	Time | None	Closing time of day (ignored if allDay = true)	None
availableEndTime_ext	Element | None	Placeholder element for availableEndTime extensions	None

HealthcareServiceEligibility

Path: fhircraft.fhir.resources.datatypes.R4.core.healthcare_service.HealthcareServiceEligibility

Bases: BackboneElement

Does this service have specific eligibility requirements that need to be met in order to use the service?

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Coded value for the eligibility	None
comment	Markdown | None	Describes the eligibility conditions for the service	None
comment_ext	Element | None	Placeholder element for comment extensions	None

HealthcareServiceNotAvailable

Path: fhircraft.fhir.resources.datatypes.R4.core.healthcare_service.HealthcareServiceNotAvailable

Bases: BackboneElement

The HealthcareService is not available during this period of time due to the provided reason.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Reason presented to the user explaining why time not available	None
description_ext	Element | None	Placeholder element for description extensions	None
during	Period | None	Service not available from this date	None

ImagingStudy

Path: fhircraft.fhir.resources.datatypes.R4.core.imaging_study.ImagingStudy

Bases: DomainResource

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ImagingStudy'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifiers for the whole study	None
status	Code | None	registered | available | cancelled | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
modality	List[Coding] | None	All series modality if actual acquisition modalities	None
subject	Reference | None	Who or what is the subject of the study	None
encounter	Reference | None	Encounter with which this imaging study is associated	None
started	DateTime | None	When the study was started	None
started_ext	Element | None	Placeholder element for started extensions	None
basedOn	List[Reference] | None	Request fulfilled	None
referrer	Reference | None	Referring physician	None
interpreter	List[Reference] | None	Who interpreted images	None
endpoint	List[Reference] | None	Study access endpoint	None
numberOfSeries	UnsignedInt | None	Number of Study Related Series	None
numberOfSeries_ext	Element | None	Placeholder element for numberOfSeries extensions	None
numberOfInstances	UnsignedInt | None	Number of Study Related Instances	None
numberOfInstances_ext	Element | None	Placeholder element for numberOfInstances extensions	None
procedureReference	Reference | None	The performed Procedure reference	None
procedureCode	List[CodeableConcept] | None	The performed procedure code	None
location	Reference | None	Where ImagingStudy occurred	None
reasonCode	List[CodeableConcept] | None	Why the study was requested	None
reasonReference	List[Reference] | None	Why was study performed	None
note	List[Annotation] | None	User-defined comments	None
description	String | None	Institution-generated description	None
description_ext	Element | None	Placeholder element for description extensions	None
series	List[ImagingStudySeries] | None	Each study has one or more series of instances	None
resourceType	Literal['ImagingStudy']		'ImagingStudy'

ImagingStudySeries

Path: fhircraft.fhir.resources.datatypes.R4.core.imaging_study.ImagingStudySeries

Bases: BackboneElement

Each study has one or more series of images or other content.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
uid	Id | None	DICOM Series Instance UID for the series	None
uid_ext	Element | None	Placeholder element for uid extensions	None
number	UnsignedInt | None	Numeric identifier of this series	None
number_ext	Element | None	Placeholder element for number extensions	None
modality	Coding | None	The modality of the instances in the series	None
description	String | None	A short human readable summary of the series	None
description_ext	Element | None	Placeholder element for description extensions	None
numberOfInstances	UnsignedInt | None	Number of Series Related Instances	None
numberOfInstances_ext	Element | None	Placeholder element for numberOfInstances extensions	None
endpoint	List[Reference] | None	Series access endpoint	None
bodySite	Coding | None	Body part examined	None
laterality	Coding | None	Body part laterality	None
specimen	List[Reference] | None	Specimen imaged	None
started	DateTime | None	When the series started	None
started_ext	Element | None	Placeholder element for started extensions	None
performer	List[ImagingStudySeriesPerformer] | None	Who performed the series	None
instance	List[ImagingStudySeriesInstance] | None	A single SOP instance from the series	None

ImagingStudySeriesInstance

Path: fhircraft.fhir.resources.datatypes.R4.core.imaging_study.ImagingStudySeriesInstance

Bases: BackboneElement

A single SOP instance within the series, e.g. an image, or presentation state.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
uid	Id | None	DICOM SOP Instance UID	None
uid_ext	Element | None	Placeholder element for uid extensions	None
sopClass	Coding | None	DICOM class type	None
number	UnsignedInt | None	The number of this instance in the series	None
number_ext	Element | None	Placeholder element for number extensions	None
title	String | None	Description of instance	None
title_ext	Element | None	Placeholder element for title extensions	None

ImagingStudySeriesPerformer

Path: fhircraft.fhir.resources.datatypes.R4.core.imaging_study.ImagingStudySeriesPerformer

Bases: BackboneElement

Indicates who or what performed the series and how they were involved.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
function	CodeableConcept | None	Type of performance	None
actor	Reference | None	Who performed the series	None

Immunization

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization.Immunization

Bases: DomainResource

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Immunization'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
status	Code | None	completed | entered-in-error | not-done	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason not done	None
vaccineCode	CodeableConcept | None	Vaccine product administered	None
patient	Reference | None	Who was immunized	None
encounter	Reference | None	Encounter immunization was part of	None
occurrenceDateTime	DateTime | None	Vaccine administration date	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrenceString	String | None	Vaccine administration date	None
occurrenceString_ext	Element | None	Placeholder element for occurrenceString extensions	None
recorded	DateTime | None	When the immunization was first captured in the subject's record	None
recorded_ext	Element | None	Placeholder element for recorded extensions	None
primarySource	Boolean | None	Indicates context the data was recorded in	None
primarySource_ext	Element | None	Placeholder element for primarySource extensions	None
reportOrigin	CodeableConcept | None	Indicates the source of a secondarily reported record	None
location	Reference | None	Where immunization occurred	None
manufacturer	Reference | None	Vaccine manufacturer	None
lotNumber	String | None	Vaccine lot number	None
lotNumber_ext	Element | None	Placeholder element for lotNumber extensions	None
expirationDate	Date | None	Vaccine expiration date	None
expirationDate_ext	Element | None	Placeholder element for expirationDate extensions	None
site	CodeableConcept | None	Body site vaccine was administered	None
route	CodeableConcept | None	How vaccine entered body	None
doseQuantity	Quantity | None	Amount of vaccine administered	None
performer	List[ImmunizationPerformer] | None	Who performed event	None
note	List[Annotation] | None	Additional immunization notes	None
reasonCode	List[CodeableConcept] | None	Why immunization occurred	None
reasonReference	List[Reference] | None	Why immunization occurred	None
isSubpotent	Boolean | None	Dose potency	None
isSubpotent_ext	Element | None	Placeholder element for isSubpotent extensions	None
subpotentReason	List[CodeableConcept] | None	Reason for being subpotent	None
education	List[ImmunizationEducation] | None	Educational material presented to patient	None
programEligibility	List[CodeableConcept] | None	Patient eligibility for a vaccination program	None
fundingSource	CodeableConcept | None	Funding source for the vaccine	None
reaction	List[ImmunizationReaction] | None	Details of a reaction that follows immunization	None
protocolApplied	List[ImmunizationProtocolApplied] | None	Protocol followed by the provider	None
resourceType	Literal['Immunization']		'Immunization'

ImmunizationEducation

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization.ImmunizationEducation

Bases: BackboneElement

Educational material presented to the patient (or guardian) at the time of vaccine administration.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
documentType	String | None	Educational material document identifier	None
documentType_ext	Element | None	Placeholder element for documentType extensions	None
reference	Uri | None	Educational material reference pointer	None
reference_ext	Element | None	Placeholder element for reference extensions	None
publicationDate	DateTime | None	Educational material publication date	None
publicationDate_ext	Element | None	Placeholder element for publicationDate extensions	None
presentationDate	DateTime | None	Educational material presentation date	None
presentationDate_ext	Element | None	Placeholder element for presentationDate extensions	None

ImmunizationPerformer

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization.ImmunizationPerformer

Bases: BackboneElement

Indicates who performed the immunization event.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
function	CodeableConcept | None	What type of performance was done	None
actor	Reference | None	Individual or organization who was performing	None

ImmunizationProtocolApplied

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization.ImmunizationProtocolApplied

Bases: BackboneElement

The protocol (set of recommendations) being followed by the provider who administered the dose.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
series	String | None	Name of vaccine series	None
series_ext	Element | None	Placeholder element for series extensions	None
authority	Reference | None	Who is responsible for publishing the recommendations	None
targetDisease	List[CodeableConcept] | None	Vaccine preventatable disease being targetted	None
doseNumberPositiveInt	PositiveInt | None	Dose number within series	None
doseNumberPositiveInt_ext	Element | None	Placeholder element for doseNumberPositiveInt extensions	None
doseNumberString	String | None	Dose number within series	None
doseNumberString_ext	Element | None	Placeholder element for doseNumberString extensions	None
seriesDosesPositiveInt	PositiveInt | None	Recommended number of doses for immunity	None
seriesDosesPositiveInt_ext	Element | None	Placeholder element for seriesDosesPositiveInt extensions	None
seriesDosesString	String | None	Recommended number of doses for immunity	None
seriesDosesString_ext	Element | None	Placeholder element for seriesDosesString extensions	None

ImmunizationReaction

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization.ImmunizationReaction

Bases: BackboneElement

Categorical data indicating that an adverse event is associated in time to an immunization.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
date	DateTime | None	When reaction started	None
date_ext	Element | None	Placeholder element for date extensions	None
detail	Reference | None	Additional information on reaction	None
reported	Boolean | None	Indicates self-reported reaction	None
reported_ext	Element | None	Placeholder element for reported extensions	None

ImmunizationEvaluation

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization_evaluation.ImmunizationEvaluation

Bases: DomainResource

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
status	Code | None	completed | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
patient	Reference | None	Who this evaluation is for	None
date	DateTime | None	Date evaluation was performed	None
date_ext	Element | None	Placeholder element for date extensions	None
authority	Reference | None	Who is responsible for publishing the recommendations	None
targetDisease	CodeableConcept | None	Evaluation target disease	None
immunizationEvent	Reference | None	Immunization being evaluated	None
doseStatus	CodeableConcept | None	Status of the dose relative to published recommendations	None
doseStatusReason	List[CodeableConcept] | None	Reason for the dose status	None
description	String | None	Evaluation notes	None
description_ext	Element | None	Placeholder element for description extensions	None
series	String | None	Name of vaccine series	None
series_ext	Element | None	Placeholder element for series extensions	None
doseNumberPositiveInt	PositiveInt | None	Dose number within series	None
doseNumberPositiveInt_ext	Element | None	Placeholder element for doseNumberPositiveInt extensions	None
doseNumberString	String | None	Dose number within series	None
doseNumberString_ext	Element | None	Placeholder element for doseNumberString extensions	None
seriesDosesPositiveInt	PositiveInt | None	Recommended number of doses for immunity	None
seriesDosesPositiveInt_ext	Element | None	Placeholder element for seriesDosesPositiveInt extensions	None
seriesDosesString	String | None	Recommended number of doses for immunity	None
seriesDosesString_ext	Element | None	Placeholder element for seriesDosesString extensions	None
resourceType	Literal['ImmunizationEvaluation']		'ImmunizationEvaluation'

ImmunizationRecommendation

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization_recommendation.ImmunizationRecommendation

Bases: DomainResource

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
patient	Reference | None	Who this profile is for	None
date	DateTime | None	Date recommendation(s) created	None
date_ext	Element | None	Placeholder element for date extensions	None
authority	Reference | None	Who is responsible for protocol	None
recommendation	List[ImmunizationRecommendationRecommendation] | None	Vaccine administration recommendations	None
resourceType	Literal['ImmunizationRecommendation']		'ImmunizationRecommendation'

ImmunizationRecommendationRecommendation

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization_recommendation.ImmunizationRecommendationRecommendation

Bases: BackboneElement

Vaccine administration recommendations.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
vaccineCode	List[CodeableConcept] | None	Vaccine or vaccine group recommendation applies to	None
targetDisease	CodeableConcept | None	Disease to be immunized against	None
contraindicatedVaccineCode	List[CodeableConcept] | None	Vaccine which is contraindicated to fulfill the recommendation	None
forecastStatus	CodeableConcept | None	Vaccine recommendation status	None
forecastReason	List[CodeableConcept] | None	Vaccine administration status reason	None
dateCriterion	List[ImmunizationRecommendationRecommendationDateCriterion] | None	Dates governing proposed immunization	None
description	String | None	Protocol details	None
description_ext	Element | None	Placeholder element for description extensions	None
series	String | None	Name of vaccination series	None
series_ext	Element | None	Placeholder element for series extensions	None
doseNumberPositiveInt	PositiveInt | None	Recommended dose number within series	None
doseNumberPositiveInt_ext	Element | None	Placeholder element for doseNumberPositiveInt extensions	None
doseNumberString	String | None	Recommended dose number within series	None
doseNumberString_ext	Element | None	Placeholder element for doseNumberString extensions	None
seriesDosesPositiveInt	PositiveInt | None	Recommended number of doses for immunity	None
seriesDosesPositiveInt_ext	Element | None	Placeholder element for seriesDosesPositiveInt extensions	None
seriesDosesString	String | None	Recommended number of doses for immunity	None
seriesDosesString_ext	Element | None	Placeholder element for seriesDosesString extensions	None
supportingImmunization	List[Reference] | None	Past immunizations supporting recommendation	None
supportingPatientInformation	List[Reference] | None	Patient observations supporting recommendation	None

ImmunizationRecommendationRecommendationDateCriterion

Path: fhircraft.fhir.resources.datatypes.R4.core.immunization_recommendation.ImmunizationRecommendationRecommendationDateCriterion

Bases: BackboneElement

Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Type of date	None
value	DateTime | None	Recommended date	None
value_ext	Element | None	Placeholder element for value extensions	None

ImplementationGuide

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuide

Bases: DomainResource

A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ImplementationGuide'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this implementation guide, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the implementation guide	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this implementation guide (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this implementation guide (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the implementation guide	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for implementation guide (if applicable)	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
packageId	Id | None	NPM Package name for IG	None
packageId_ext	Element | None	Placeholder element for packageId extensions	None
license	Code | None	SPDX license code for this IG (or not-open-source)	None
license_ext	Element | None	Placeholder element for license extensions	None
fhirVersion	List[Code] | None	FHIR Version(s) this Implementation Guide targets	None
fhirVersion_ext	Element | None	Placeholder element for fhirVersion extensions	None
dependsOn	List[ImplementationGuideDependsOn] | None	Another Implementation guide this depends on	None
global_	List[ImplementationGuideGlobal] | None	Profiles that apply globally	None
definition	ImplementationGuideDefinition | None	Information needed to build the IG	None
manifest	ImplementationGuideManifest | None	Information about an assembled IG	None
resourceType	Literal['ImplementationGuide']		'ImplementationGuide'

ImplementationGuideDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideDefinition

Bases: BackboneElement

The information needed by an IG publisher tool to publish the whole implementation guide.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
grouping	List[ImplementationGuideDefinitionGrouping] | None	Grouping used to present related resources in the IG	None
resource	List[ImplementationGuideDefinitionResource] | None	Resource in the implementation guide	None
page	ImplementationGuideDefinitionPage | None	Page/Section in the Guide	None
parameter	List[ImplementationGuideDefinitionParameter] | None	Defines how IG is built by tools	None
template	List[ImplementationGuideDefinitionTemplate] | None	A template for building resources	None

ImplementationGuideDefinitionGrouping

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideDefinitionGrouping

Bases: BackboneElement

A logical group of resources. Logical groups can be used when building pages.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Descriptive name for the package	None
name_ext	Element | None	Placeholder element for name extensions	None
description	String | None	Human readable text describing the package	None
description_ext	Element | None	Placeholder element for description extensions	None

ImplementationGuideDefinitionPage

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideDefinitionPage

Bases: BackboneElement

A page / section in the implementation guide. The root page is the implementation guide home page.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
nameUrl	Url | None	Where to find that page	None
nameUrl_ext	Element | None	Placeholder element for nameUrl extensions	None
nameReference	Reference | None	Where to find that page	None
title	String | None	Short title shown for navigational assistance	None
title_ext	Element | None	Placeholder element for title extensions	None
generation	Code | None	html | markdown | xml | generated	None
generation_ext	Element | None	Placeholder element for generation extensions	None
page	List[ImplementationGuideDefinitionPage] | None	Nested Pages / Sections	None

ImplementationGuideDefinitionParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideDefinitionParameter

Bases: BackboneElement

Defines how IG is built by tools.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template	None
code_ext	Element | None	Placeholder element for code extensions	None
value	String | None	Value for named type	None
value_ext	Element | None	Placeholder element for value extensions	None

ImplementationGuideDefinitionResource

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideDefinitionResource

Bases: BackboneElement

A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
reference	Reference | None	Location of the resource	None
fhirVersion	List[Code] | None	Versions this applies to (if different to IG)	None
fhirVersion_ext	Element | None	Placeholder element for fhirVersion extensions	None
name	String | None	Human Name for the resource	None
name_ext	Element | None	Placeholder element for name extensions	None
description	String | None	Reason why included in guide	None
description_ext	Element | None	Placeholder element for description extensions	None
exampleBoolean	Boolean | None	Is an example/What is this an example of?	None
exampleBoolean_ext	Element | None	Placeholder element for exampleBoolean extensions	None
exampleCanonical	Canonical | None	Is an example/What is this an example of?	None
exampleCanonical_ext	Element | None	Placeholder element for exampleCanonical extensions	None
groupingId	Id | None	Grouping this is part of	None
groupingId_ext	Element | None	Placeholder element for groupingId extensions	None

ImplementationGuideDefinitionTemplate

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideDefinitionTemplate

Bases: BackboneElement

A template for building resources.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Type of template specified	None
code_ext	Element | None	Placeholder element for code extensions	None
source	String | None	The source location for the template	None
source_ext	Element | None	Placeholder element for source extensions	None
scope	String | None	The scope in which the template applies	None
scope_ext	Element | None	Placeholder element for scope extensions	None

ImplementationGuideDependsOn

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideDependsOn

Bases: BackboneElement

Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
uri	Canonical | None	Identity of the IG that this depends on	None
uri_ext	Element | None	Placeholder element for uri extensions	None
packageId	Id | None	NPM Package name for IG this depends on	None
packageId_ext	Element | None	Placeholder element for packageId extensions	None
version	String | None	Version of the IG	None
version_ext	Element | None	Placeholder element for version extensions	None

ImplementationGuideGlobal

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideGlobal

Bases: BackboneElement

A set of profiles that all resources covered by this implementation guide must conform to.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	Type this profile applies to	None
type_ext	Element | None	Placeholder element for type extensions	None
profile	Canonical | None	Profile that all resources must conform to	None
profile_ext	Element | None	Placeholder element for profile extensions	None

ImplementationGuideManifest

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideManifest

Bases: BackboneElement

Information about an assembled implementation guide, created by the publication tooling.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
rendering	Url | None	Location of rendered implementation guide	None
rendering_ext	Element | None	Placeholder element for rendering extensions	None
resource	List[ImplementationGuideManifestResource] | None	Resource in the implementation guide	None
page	List[ImplementationGuideManifestPage] | None	HTML page within the parent IG	None
image	List[String] | None	Image within the IG	None
image_ext	Element | None	Placeholder element for image extensions	None
other	List[String] | None	Additional linkable file in IG	None
other_ext	Element | None	Placeholder element for other extensions	None

ImplementationGuideManifestPage

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideManifestPage

Bases: BackboneElement

Information about a page within the IG.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	HTML page name	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Title of the page, for references	None
title_ext	Element | None	Placeholder element for title extensions	None
anchor	List[String] | None	Anchor available on the page	None
anchor_ext	Element | None	Placeholder element for anchor extensions	None

ImplementationGuideManifestResource

Path: fhircraft.fhir.resources.datatypes.R4.core.implementation_guide.ImplementationGuideManifestResource

Bases: BackboneElement

A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
reference	Reference | None	Location of the resource	None
exampleBoolean	Boolean | None	Is an example/What is this an example of?	None
exampleBoolean_ext	Element | None	Placeholder element for exampleBoolean extensions	None
exampleCanonical	Canonical | None	Is an example/What is this an example of?	None
exampleCanonical_ext	Element | None	Placeholder element for exampleCanonical extensions	None
relativePath	Url | None	Relative path for page in IG	None
relativePath_ext	Element | None	Placeholder element for relativePath extensions	None

InsurancePlan

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlan

Bases: DomainResource

Details of a Health Insurance product/plan provided by an organization.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/InsurancePlan'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for Product	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
type	List[CodeableConcept] | None	Kind of product	None
name	String | None	Official name	None
name_ext	Element | None	Placeholder element for name extensions	None
alias	List[String] | None	Alternate names	None
alias_ext	Element | None	Placeholder element for alias extensions	None
period	Period | None	When the product is available	None
ownedBy	Reference | None	Plan issuer	None
administeredBy	Reference | None	Product administrator	None
coverageArea	List[Reference] | None	Where product applies	None
contact	List[InsurancePlanContact] | None	Contact for the product	None
endpoint	List[Reference] | None	Technical endpoint	None
network	List[Reference] | None	What networks are Included	None
coverage	List[InsurancePlanCoverage] | None	Coverage details	None
plan	List[InsurancePlanPlan] | None	Plan details	None
resourceType	Literal['InsurancePlan']		'InsurancePlan'

InsurancePlanContact

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanContact

Bases: BackboneElement

The contact for the health insurance product for a certain purpose.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
purpose	CodeableConcept | None	The type of contact	None
name	HumanName | None	A name associated with the contact	None
telecom	List[ContactPoint] | None	Contact details (telephone, email, etc.) for a contact	None
address	Address | None	Visiting or postal addresses for the contact	None

InsurancePlanCoverage

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanCoverage

Bases: BackboneElement

Details about the coverage offered by the insurance product.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of coverage	None
network	List[Reference] | None	What networks provide coverage	None
benefit	List[InsurancePlanCoverageBenefit] | None	List of benefits	None

InsurancePlanCoverageBenefit

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanCoverageBenefit

Bases: BackboneElement

Specific benefits under this type of coverage.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of benefit	None
requirement	String | None	Referral requirements	None
requirement_ext	Element | None	Placeholder element for requirement extensions	None
limit	List[InsurancePlanCoverageBenefitLimit] | None	Benefit limits	None

InsurancePlanCoverageBenefitLimit

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanCoverageBenefitLimit

Bases: BackboneElement

The specific limits on the benefit.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
value	Quantity | None	Maximum value allowed	None
code	CodeableConcept | None	Benefit limit details	None

InsurancePlanPlan

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanPlan

Bases: BackboneElement

Details about an insurance plan.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	List[Identifier] | None	Business Identifier for Product	None
type	CodeableConcept | None	Type of plan	None
coverageArea	List[Reference] | None	Where product applies	None
network	List[Reference] | None	What networks provide coverage	None
generalCost	List[InsurancePlanPlanGeneralCost] | None	Overall costs	None
specificCost	List[InsurancePlanPlanSpecificCost] | None	Specific costs	None

InsurancePlanPlanGeneralCost

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanPlanGeneralCost

Bases: BackboneElement

Overall costs associated with the plan.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of cost	None
groupSize	PositiveInt | None	Number of enrollees	None
groupSize_ext	Element | None	Placeholder element for groupSize extensions	None
cost	Money | None	Cost value	None
comment	String | None	Additional cost information	None
comment_ext	Element | None	Placeholder element for comment extensions	None

InsurancePlanPlanSpecificCost

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanPlanSpecificCost

Bases: BackboneElement

Costs associated with the coverage provided by the product.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	General category of benefit	None
benefit	List[InsurancePlanPlanSpecificCostBenefit] | None	Benefits list	None

InsurancePlanPlanSpecificCostBenefit

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanPlanSpecificCostBenefit

Bases: BackboneElement

List of the specific benefits under this category of benefit.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of specific benefit	None
cost	List[InsurancePlanPlanSpecificCostBenefitCost] | None	List of the costs	None

InsurancePlanPlanSpecificCostBenefitCost

Path: fhircraft.fhir.resources.datatypes.R4.core.insurance_plan.InsurancePlanPlanSpecificCostBenefitCost

Bases: BackboneElement

List of the costs associated with a specific benefit.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of cost	None
applicability	CodeableConcept | None	in-network | out-of-network | other	None
qualifiers	List[CodeableConcept] | None	Additional information about the cost	None
value	Quantity | None	The actual cost value	None

Invoice

Path: fhircraft.fhir.resources.datatypes.R4.core.invoice.Invoice

Bases: DomainResource

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Invoice'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for item	None
status	Code | None	draft | issued | balanced | cancelled | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
cancelledReason	String | None	Reason for cancellation of this Invoice	None
cancelledReason_ext	Element | None	Placeholder element for cancelledReason extensions	None
type	CodeableConcept | None	Type of Invoice	None
subject	Reference | None	Recipient(s) of goods and services	None
recipient	Reference | None	Recipient of this invoice	None
date	DateTime | None	Invoice date / posting date	None
date_ext	Element | None	Placeholder element for date extensions	None
participant	List[InvoiceParticipant] | None	Participant in creation of this Invoice	None
issuer	Reference | None	Issuing Organization of Invoice	None
account	Reference | None	Account that is being balanced	None
lineItem	List[InvoiceLineItem] | None	Line items of this Invoice	None
totalPriceComponent	List[InvoiceTotalPriceComponent] | None	Components of Invoice total	None
totalNet	Money | None	Net total of this Invoice	None
totalGross	Money | None	Gross total of this Invoice	None
paymentTerms	Markdown | None	Payment details	None
paymentTerms_ext	Element | None	Placeholder element for paymentTerms extensions	None
note	List[Annotation] | None	Comments made about the invoice	None
resourceType	Literal['Invoice']		'Invoice'

InvoiceLineItem

Path: fhircraft.fhir.resources.datatypes.R4.core.invoice.InvoiceLineItem

Bases: BackboneElement

Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sequence	PositiveInt | None	Sequence number of line item	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
chargeItemReference	Reference | None	Reference to ChargeItem containing details of this line item or an inline billing code	None
chargeItemCodeableConcept	CodeableConcept | None	Reference to ChargeItem containing details of this line item or an inline billing code	None
priceComponent	List[InvoiceLineItemPriceComponent] | None	Components of total line item price	None

InvoiceLineItemPriceComponent

Path: fhircraft.fhir.resources.datatypes.R4.core.invoice.InvoiceLineItemPriceComponent

Bases: BackboneElement

The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	base | surcharge | deduction | discount | tax | informational	None
type_ext	Element | None	Placeholder element for type extensions	None
code	CodeableConcept | None	Code identifying the specific component	None
factor	Decimal | None	Factor used for calculating this component	None
factor_ext	Element | None	Placeholder element for factor extensions	None
amount	Money | None	Monetary amount associated with this component	None

InvoiceParticipant

Path: fhircraft.fhir.resources.datatypes.R4.core.invoice.InvoiceParticipant

Bases: BackboneElement

Indicates who or what performed or participated in the charged service.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
role	CodeableConcept | None	Type of involvement in creation of this Invoice	None
actor	Reference | None	Individual who was involved	None

InvoiceTotalPriceComponent

Path: fhircraft.fhir.resources.datatypes.R4.core.invoice.InvoiceTotalPriceComponent

Bases: BackboneElement

The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	base | surcharge | deduction | discount | tax | informational	None
type_ext	Element | None	Placeholder element for type extensions	None
code	CodeableConcept | None	Code identifying the specific component	None
factor	Decimal | None	Factor used for calculating this component	None
factor_ext	Element | None	Placeholder element for factor extensions	None
amount	Money | None	Monetary amount associated with this component	None

Library

Path: fhircraft.fhir.resources.datatypes.R4.core.library.Library

Bases: DomainResource

The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Library'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this library, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the library	None
version	String | None	Business version of the library	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this library (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this library (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
subtitle	String | None	Subordinate title of the library	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
type	CodeableConcept | None	logic-library | model-definition | asset-collection | module-definition	None
subjectCodeableConcept	CodeableConcept | None	Type of individual the library content is focused on	None
subjectReference	Reference | None	Type of individual the library content is focused on	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the library	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for library (if applicable)	None
purpose	Markdown | None	Why this library is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
usage	String | None	Describes the clinical usage of the library	None
usage_ext	Element | None	Placeholder element for usage extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the library was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the library was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the library is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
parameter	List[ParameterDefinition] | None	Parameters defined by the library	None
dataRequirement	List[DataRequirement] | None	What data is referenced by this library	None
content	List[Attachment] | None	Contents of the library, either embedded or referenced	None
resourceType	Literal['Library']		'Library'

Linkage

Path: fhircraft.fhir.resources.datatypes.R4.core.linkage.Linkage

Bases: DomainResource

Identifies two or more records (resource instances) that refer to the same real-world "occurrence".

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Linkage'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
active	Boolean | None	Whether this linkage assertion is active or not	None
active_ext	Element | None	Placeholder element for active extensions	None
author	Reference | None	Who is responsible for linkages	None
item	List[LinkageItem] | None	Item to be linked	None
resourceType	Literal['Linkage']		'Linkage'

LinkageItem

Path: fhircraft.fhir.resources.datatypes.R4.core.linkage.LinkageItem

Bases: BackboneElement

Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	source | alternate | historical	None
type_ext	Element | None	Placeholder element for type extensions	None
resource	Reference | None	Resource being linked	None

List

Path: fhircraft.fhir.resources.datatypes.R4.core.list.List

Bases: DomainResource

A list is a curated collection of resources.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/List'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
status	Code | None	current | retired | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
mode	Code | None	working | snapshot | changes	None
mode_ext	Element | None	Placeholder element for mode extensions	None
title	String | None	Descriptive name for the list	None
title_ext	Element | None	Placeholder element for title extensions	None
code	CodeableConcept | None	What the purpose of this list is	None
subject	Reference | None	If all resources have the same subject	None
encounter	Reference | None	Context in which list created	None
date	DateTime | None	When the list was prepared	None
date_ext	Element | None	Placeholder element for date extensions	None
source	Reference | None	Who and/or what defined the list contents (aka Author)	None
orderedBy	CodeableConcept | None	What order the list has	None
note	List[Annotation] | None	Comments about the list	None
entry	List[ListEntry] | None	Entries in the list	None
emptyReason	CodeableConcept | None	Why list is empty	None
resourceType	Literal['List']		'List'

ListEntry

Path: fhircraft.fhir.resources.datatypes.R4.core.list.ListEntry

Bases: BackboneElement

Entries in this list.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
flag	CodeableConcept | None	Status/Workflow information about this item	None
deleted	Boolean | None	If this item is actually marked as deleted	None
deleted_ext	Element | None	Placeholder element for deleted extensions	None
date	DateTime | None	When item added to list	None
date_ext	Element | None	Placeholder element for date extensions	None
item	Reference | None	Actual entry	None

Location

Path: fhircraft.fhir.resources.datatypes.R4.core.location.Location

Bases: DomainResource

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Location'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique code or number identifying the location to its users	None
status	Code | None	active | suspended | inactive	None
status_ext	Element | None	Placeholder element for status extensions	None
operationalStatus	Coding | None	The operational status of the location (typically only for a bed/room)	None
name	String | None	Name of the location as used by humans	None
name_ext	Element | None	Placeholder element for name extensions	None
alias	List[String] | None	A list of alternate names that the location is known as, or was known as, in the past	None
alias_ext	Element | None	Placeholder element for alias extensions	None
description	String | None	Additional details about the location that could be displayed as further information to identify the location beyond its name	None
description_ext	Element | None	Placeholder element for description extensions	None
mode	Code | None	instance | kind	None
mode_ext	Element | None	Placeholder element for mode extensions	None
type	List[CodeableConcept] | None	Type of function performed	None
telecom	List[ContactPoint] | None	Contact details of the location	None
address	Address | None	Physical location	None
physicalType	CodeableConcept | None	Physical form of the location	None
position	LocationPosition | None	The absolute geographic location	None
managingOrganization	Reference | None	Organization responsible for provisioning and upkeep	None
partOf	Reference | None	Another Location this one is physically a part of	None
hoursOfOperation	List[LocationHoursOfOperation] | None	What days/times during a week is this location usually open	None
availabilityExceptions	String | None	Description of availability exceptions	None
availabilityExceptions_ext	Element | None	Placeholder element for availabilityExceptions extensions	None
endpoint	List[Reference] | None	Technical endpoints providing access to services operated for the location	None
resourceType	Literal['Location']		'Location'

LocationHoursOfOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.location.LocationHoursOfOperation

Bases: BackboneElement

What days/times during a week is this location usually open.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
daysOfWeek	List[Code] | None	mon | tue | wed | thu | fri | sat | sun	None
daysOfWeek_ext	Element | None	Placeholder element for daysOfWeek extensions	None
allDay	Boolean | None	The Location is open all day	None
allDay_ext	Element | None	Placeholder element for allDay extensions	None
openingTime	Time | None	Time that the Location opens	None
openingTime_ext	Element | None	Placeholder element for openingTime extensions	None
closingTime	Time | None	Time that the Location closes	None
closingTime_ext	Element | None	Placeholder element for closingTime extensions	None

LocationPosition

Path: fhircraft.fhir.resources.datatypes.R4.core.location.LocationPosition

Bases: BackboneElement

The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
longitude	Decimal | None	Longitude with WGS84 datum	None
longitude_ext	Element | None	Placeholder element for longitude extensions	None
latitude	Decimal | None	Latitude with WGS84 datum	None
latitude_ext	Element | None	Placeholder element for latitude extensions	None
altitude	Decimal | None	Altitude with WGS84 datum	None
altitude_ext	Element | None	Placeholder element for altitude extensions	None

Measure

Path: fhircraft.fhir.resources.datatypes.R4.core.measure.Measure

Bases: DomainResource

The Measure resource provides the definition of a quality measure.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Measure'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this measure, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the measure	None
version	String | None	Business version of the measure	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this measure (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this measure (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
subtitle	String | None	Subordinate title of the measure	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
subjectCodeableConcept	CodeableConcept | None	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device	None
subjectReference	Reference | None	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the measure	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for measure (if applicable)	None
purpose	Markdown | None	Why this measure is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
usage	String | None	Describes the clinical usage of the measure	None
usage_ext	Element | None	Placeholder element for usage extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the measure was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the measure was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the measure is expected to be used	None
topic	List[CodeableConcept] | None	The category of the measure, such as Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
library	List[Canonical] | None	Logic used by the measure	None
library_ext	Element | None	Placeholder element for library extensions	None
disclaimer	Markdown | None	Disclaimer for use of the measure or its referenced content	None
disclaimer_ext	Element | None	Placeholder element for disclaimer extensions	None
scoring	CodeableConcept | None	proportion | ratio | continuous-variable | cohort	None
compositeScoring	CodeableConcept | None	opportunity | all-or-nothing | linear | weighted	None
type	List[CodeableConcept] | None	process | outcome | structure | patient-reported-outcome | composite	None
riskAdjustment	String | None	How risk adjustment is applied for this measure	None
riskAdjustment_ext	Element | None	Placeholder element for riskAdjustment extensions	None
rateAggregation	String | None	How is rate aggregation performed for this measure	None
rateAggregation_ext	Element | None	Placeholder element for rateAggregation extensions	None
rationale	Markdown | None	Detailed description of why the measure exists	None
rationale_ext	Element | None	Placeholder element for rationale extensions	None
clinicalRecommendationStatement	Markdown | None	Summary of clinical guidelines	None
clinicalRecommendationStatement_ext	Element | None	Placeholder element for clinicalRecommendationStatement extensions	None
improvementNotation	CodeableConcept | None	increase | decrease	None
definition	List[Markdown] | None	Defined terms used in the measure documentation	None
definition_ext	Element | None	Placeholder element for definition extensions	None
guidance	Markdown | None	Additional guidance for implementers	None
guidance_ext	Element | None	Placeholder element for guidance extensions	None
group	List[MeasureGroup] | None	Population criteria group	None
supplementalData	List[MeasureSupplementalData] | None	What other data should be reported with the measure	None
resourceType	Literal['Measure']		'Measure'

MeasureGroup

Path: fhircraft.fhir.resources.datatypes.R4.core.measure.MeasureGroup

Bases: BackboneElement

A group of population criteria for the measure.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Meaning of the group	None
description	String | None	Summary description	None
description_ext	Element | None	Placeholder element for description extensions	None
population	List[MeasureGroupPopulation] | None	Population criteria	None
stratifier	List[MeasureGroupStratifier] | None	Stratifier criteria for the measure	None

MeasureGroupPopulation

Path: fhircraft.fhir.resources.datatypes.R4.core.measure.MeasureGroupPopulation

Bases: BackboneElement

A population criteria for the measure.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation	None
description	String | None	The human readable description of this population criteria	None
description_ext	Element | None	Placeholder element for description extensions	None
criteria	Expression | None	The criteria that defines this population	None

MeasureGroupStratifier

Path: fhircraft.fhir.resources.datatypes.R4.core.measure.MeasureGroupStratifier

Bases: BackboneElement

The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Meaning of the stratifier	None
description	String | None	The human readable description of this stratifier	None
description_ext	Element | None	Placeholder element for description extensions	None
criteria	Expression | None	How the measure should be stratified	None
component	List[MeasureGroupStratifierComponent] | None	Stratifier criteria component for the measure	None

MeasureGroupStratifierComponent

Path: fhircraft.fhir.resources.datatypes.R4.core.measure.MeasureGroupStratifierComponent

Bases: BackboneElement

A component of the stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Meaning of the stratifier component	None
description	String | None	The human readable description of this stratifier component	None
description_ext	Element | None	Placeholder element for description extensions	None
criteria	Expression | None	Component of how the measure should be stratified	None

MeasureSupplementalData

Path: fhircraft.fhir.resources.datatypes.R4.core.measure.MeasureSupplementalData

Bases: BackboneElement

The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Meaning of the supplemental data	None
usage	List[CodeableConcept] | None	supplemental-data | risk-adjustment-factor	None
description	String | None	The human readable description of this supplemental data	None
description_ext	Element | None	Placeholder element for description extensions	None
criteria	Expression | None	Expression describing additional data to be reported	None

MeasureReport

Path: fhircraft.fhir.resources.datatypes.R4.core.measure_report.MeasureReport

Bases: DomainResource

The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MeasureReport'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Additional identifier for the MeasureReport	None
status	Code | None	complete | pending | error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	Code | None	individual | subject-list | summary | data-collection	None
type_ext	Element | None	Placeholder element for type extensions	None
measure	Canonical | None	What measure was calculated	None
measure_ext	Element | None	Placeholder element for measure extensions	None
subject	Reference | None	What individual(s) the report is for	None
date	DateTime | None	When the report was generated	None
date_ext	Element | None	Placeholder element for date extensions	None
reporter	Reference | None	Who is reporting the data	None
period	Period | None	What period the report covers	None
improvementNotation	CodeableConcept | None	increase | decrease	None
group	List[MeasureReportGroup] | None	Measure results for each group	None
evaluatedResource	List[Reference] | None	What data was used to calculate the measure score	None
resourceType	Literal['MeasureReport']		'MeasureReport'

MeasureReportGroup

Path: fhircraft.fhir.resources.datatypes.R4.core.measure_report.MeasureReportGroup

Bases: BackboneElement

The results of the calculation, one for each population group in the measure.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Meaning of the group	None
population	List[MeasureReportGroupPopulation] | None	The populations in the group	None
measureScore	Quantity | None	What score this group achieved	None
stratifier	List[MeasureReportGroupStratifier] | None	Stratification results	None

MeasureReportGroupPopulation

Path: fhircraft.fhir.resources.datatypes.R4.core.measure_report.MeasureReportGroupPopulation

Bases: BackboneElement

The populations that make up the population group, one for each type of population appropriate for the measure.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation	None
count	Integer | None	Size of the population	None
count_ext	Element | None	Placeholder element for count extensions	None
subjectResults	Reference | None	For subject-list reports, the subject results in this population	None

MeasureReportGroupStratifier

Path: fhircraft.fhir.resources.datatypes.R4.core.measure_report.MeasureReportGroupStratifier

Bases: BackboneElement

When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	List[CodeableConcept] | None	What stratifier of the group	None
stratum	List[MeasureReportGroupStratifierStratum] | None	Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components	None

MeasureReportGroupStratifierStratum

Path: fhircraft.fhir.resources.datatypes.R4.core.measure_report.MeasureReportGroupStratifierStratum

Bases: BackboneElement

This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
value	CodeableConcept | None	The stratum value, e.g. male	None
component	List[MeasureReportGroupStratifierStratumComponent] | None	Stratifier component values	None
population	List[MeasureReportGroupStratifierStratumPopulation] | None	Population results in this stratum	None
measureScore	Quantity | None	What score this stratum achieved	None

MeasureReportGroupStratifierStratumComponent

Path: fhircraft.fhir.resources.datatypes.R4.core.measure_report.MeasureReportGroupStratifierStratumComponent

Bases: BackboneElement

A stratifier component value.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	What stratifier component of the group	None
value	CodeableConcept | None	The stratum component value, e.g. male	None

MeasureReportGroupStratifierStratumPopulation

Path: fhircraft.fhir.resources.datatypes.R4.core.measure_report.MeasureReportGroupStratifierStratumPopulation

Bases: BackboneElement

The populations that make up the stratum, one for each type of population appropriate to the measure.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation	None
count	Integer | None	Size of the population	None
count_ext	Element | None	Placeholder element for count extensions	None
subjectResults	Reference | None	For subject-list reports, the subject results in this population	None

Media

Path: fhircraft.fhir.resources.datatypes.R4.core.media.Media

Bases: DomainResource

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Media'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifier(s) for the image	None
basedOn	List[Reference] | None	Procedure that caused this media to be created	None
partOf	List[Reference] | None	Part of referenced event	None
status	Code | None	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	Classification of media as image, video, or audio	None
modality	CodeableConcept | None	The type of acquisition equipment/process	None
view	CodeableConcept | None	Imaging view, e.g. Lateral or Antero-posterior	None
subject	Reference | None	Who/What this Media is a record of	None
encounter	Reference | None	Encounter associated with media	None
createdDateTime	DateTime | None	When Media was collected	None
createdDateTime_ext	Element | None	Placeholder element for createdDateTime extensions	None
createdPeriod	Period | None	When Media was collected	None
issued	Instant | None	Date/Time this version was made available	None
issued_ext	Element | None	Placeholder element for issued extensions	None
operator	Reference | None	The person who generated the image	None
reasonCode	List[CodeableConcept] | None	Why was event performed?	None
bodySite	CodeableConcept | None	Observed body part	None
deviceName	String | None	Name of the device/manufacturer	None
deviceName_ext	Element | None	Placeholder element for deviceName extensions	None
device	Reference | None	Observing Device	None
height	PositiveInt | None	Height of the image in pixels (photo/video)	None
height_ext	Element | None	Placeholder element for height extensions	None
width	PositiveInt | None	Width of the image in pixels (photo/video)	None
width_ext	Element | None	Placeholder element for width extensions	None
frames	PositiveInt | None	Number of frames if > 1 (photo)	None
frames_ext	Element | None	Placeholder element for frames extensions	None
duration	Decimal | None	Length in seconds (audio / video)	None
duration_ext	Element | None	Placeholder element for duration extensions	None
content	Attachment | None	Actual Media - reference or data	None
note	List[Annotation] | None	Comments made about the media	None
resourceType	Literal['Media']		'Media'

Medication

Path: fhircraft.fhir.resources.datatypes.R4.core.medication.Medication

Bases: DomainResource

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Medication'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier for this medication	None
code	CodeableConcept | None	Codes that identify this medication	None
status	Code | None	active | inactive | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
manufacturer	Reference | None	Manufacturer of the item	None
form	CodeableConcept | None	powder | tablets | capsule +	None
amount	Ratio | None	Amount of drug in package	None
ingredient	List[MedicationIngredient] | None	Active or inactive ingredient	None
batch	MedicationBatch | None	Details about packaged medications	None
resourceType	Literal['Medication']		'Medication'

MedicationBatch

Path: fhircraft.fhir.resources.datatypes.R4.core.medication.MedicationBatch

Bases: BackboneElement

Information that only applies to packages (not products).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
lotNumber	String | None	Identifier assigned to batch	None
lotNumber_ext	Element | None	Placeholder element for lotNumber extensions	None
expirationDate	DateTime | None	When batch will expire	None
expirationDate_ext	Element | None	Placeholder element for expirationDate extensions	None

MedicationIngredient

Path: fhircraft.fhir.resources.datatypes.R4.core.medication.MedicationIngredient

Bases: BackboneElement

Identifies a particular constituent of interest in the product.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemCodeableConcept	CodeableConcept | None	The actual ingredient or content	None
itemReference	Reference | None	The actual ingredient or content	None
isActive	Boolean | None	Active ingredient indicator	None
isActive_ext	Element | None	Placeholder element for isActive extensions	None
strength	Ratio | None	Quantity of ingredient present	None

MedicationAdministration

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_administration.MedicationAdministration

Bases: DomainResource

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicationAdministration'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External identifier	None
instantiates	List[Uri] | None	Instantiates protocol or definition	None
instantiates_ext	Element | None	Placeholder element for instantiates extensions	None
partOf	List[Reference] | None	Part of referenced event	None
status	Code | None	in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	List[CodeableConcept] | None	Reason administration not performed	None
category	CodeableConcept | None	Type of medication usage	None
medicationCodeableConcept	CodeableConcept | None	What was administered	None
medicationReference	Reference | None	What was administered	None
subject	Reference | None	Who received medication	None
context	Reference | None	Encounter or Episode of Care administered as part of	None
supportingInformation	List[Reference] | None	Additional information to support administration	None
effectiveDateTime	DateTime | None	Start and end time of administration	None
effectiveDateTime_ext	Element | None	Placeholder element for effectiveDateTime extensions	None
effectivePeriod	Period | None	Start and end time of administration	None
performer	List[MedicationAdministrationPerformer] | None	Who performed the medication administration and what they did	None
reasonCode	List[CodeableConcept] | None	Reason administration performed	None
reasonReference	List[Reference] | None	Condition or observation that supports why the medication was administered	None
request	Reference | None	Request administration performed against	None
device	List[Reference] | None	Device used to administer	None
note	List[Annotation] | None	Information about the administration	None
dosage	MedicationAdministrationDosage | None	Details of how medication was taken	None
eventHistory	List[Reference] | None	A list of events of interest in the lifecycle	None
resourceType	Literal['MedicationAdministration']		'MedicationAdministration'

MedicationAdministrationDosage

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_administration.MedicationAdministrationDosage

Bases: BackboneElement

Describes the medication dosage information details e.g. dose, rate, site, route, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
text	String | None	Free text dosage instructions e.g. SIG	None
text_ext	Element | None	Placeholder element for text extensions	None
site	CodeableConcept | None	Body site administered to	None
route	CodeableConcept | None	Path of substance into body	None
method	CodeableConcept | None	How drug was administered	None
dose	Quantity | None	Amount of medication per dose	None
rateRatio	Ratio | None	Dose quantity per unit of time	None
rateQuantity	Quantity | None	Dose quantity per unit of time	None

MedicationAdministrationPerformer

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_administration.MedicationAdministrationPerformer

Bases: BackboneElement

Indicates who or what performed the medication administration and how they were involved.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
function	CodeableConcept | None	Type of performance	None
actor	Reference | None	Who performed the medication administration	None

MedicationDispense

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_dispense.MedicationDispense

Bases: DomainResource

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicationDispense'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External identifier	None
partOf	List[Reference] | None	Event that dispense is part of	None
status	Code | None	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReasonCodeableConcept	CodeableConcept | None	Why a dispense was not performed	None
statusReasonReference	Reference | None	Why a dispense was not performed	None
category	CodeableConcept | None	Type of medication dispense	None
medicationCodeableConcept	CodeableConcept | None	What medication was supplied	None
medicationReference	Reference | None	What medication was supplied	None
subject	Reference | None	Who the dispense is for	None
context	Reference | None	Encounter / Episode associated with event	None
supportingInformation	List[Reference] | None	Information that supports the dispensing of the medication	None
performer	List[MedicationDispensePerformer] | None	Who performed event	None
location	Reference | None	Where the dispense occurred	None
authorizingPrescription	List[Reference] | None	Medication order that authorizes the dispense	None
type	CodeableConcept | None	Trial fill, partial fill, emergency fill, etc.	None
quantity	Quantity | None	Amount dispensed	None
daysSupply	Quantity | None	Amount of medication expressed as a timing amount	None
whenPrepared	DateTime | None	When product was packaged and reviewed	None
whenPrepared_ext	Element | None	Placeholder element for whenPrepared extensions	None
whenHandedOver	DateTime | None	When product was given out	None
whenHandedOver_ext	Element | None	Placeholder element for whenHandedOver extensions	None
destination	Reference | None	Where the medication was sent	None
receiver	List[Reference] | None	Who collected the medication	None
note	List[Annotation] | None	Information about the dispense	None
dosageInstruction	List[Dosage] | None	How the medication is to be used by the patient or administered by the caregiver	None
substitution	MedicationDispenseSubstitution | None	Whether a substitution was performed on the dispense	None
detectedIssue	List[Reference] | None	Clinical issue with action	None
eventHistory	List[Reference] | None	A list of relevant lifecycle events	None
resourceType	Literal['MedicationDispense']		'MedicationDispense'

MedicationDispensePerformer

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_dispense.MedicationDispensePerformer

Bases: BackboneElement

Indicates who or what performed the event.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
function	CodeableConcept | None	Who performed the dispense and what they did	None
actor	Reference | None	Individual who was performing	None

MedicationDispenseSubstitution

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_dispense.MedicationDispenseSubstitution

Bases: BackboneElement

Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
wasSubstituted	Boolean | None	Whether a substitution was or was not performed on the dispense	None
wasSubstituted_ext	Element | None	Placeholder element for wasSubstituted extensions	None
type	CodeableConcept | None	Code signifying whether a different drug was dispensed from what was prescribed	None
reason	List[CodeableConcept] | None	Why was substitution made	None
responsibleParty	List[Reference] | None	Who is responsible for the substitution	None

MedicationKnowledge

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledge

Bases: DomainResource

Information about a medication that is used to support knowledge.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicationKnowledge'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
code	CodeableConcept | None	Code that identifies this medication	None
status	Code | None	active | inactive | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
manufacturer	Reference | None	Manufacturer of the item	None
doseForm	CodeableConcept | None	powder | tablets | capsule +	None
amount	Quantity | None	Amount of drug in package	None
synonym	List[String] | None	Additional names for a medication	None
synonym_ext	Element | None	Placeholder element for synonym extensions	None
relatedMedicationKnowledge	List[MedicationKnowledgeRelatedMedicationKnowledge] | None	Associated or related medication information	None
associatedMedication	List[Reference] | None	A medication resource that is associated with this medication	None
productType	List[CodeableConcept] | None	Category of the medication or product	None
monograph	List[MedicationKnowledgeMonograph] | None	Associated documentation about the medication	None
ingredient	List[MedicationKnowledgeIngredient] | None	Active or inactive ingredient	None
preparationInstruction	Markdown | None	The instructions for preparing the medication	None
preparationInstruction_ext	Element | None	Placeholder element for preparationInstruction extensions	None
intendedRoute	List[CodeableConcept] | None	The intended or approved route of administration	None
cost	List[MedicationKnowledgeCost] | None	The pricing of the medication	None
monitoringProgram	List[MedicationKnowledgeMonitoringProgram] | None	Program under which a medication is reviewed	None
administrationGuidelines	List[MedicationKnowledgeAdministrationGuidelines] | None	Guidelines for administration of the medication	None
medicineClassification	List[MedicationKnowledgeMedicineClassification] | None	Categorization of the medication within a formulary or classification system	None
packaging	MedicationKnowledgePackaging | None	Details about packaged medications	None
drugCharacteristic	List[MedicationKnowledgeDrugCharacteristic] | None	Specifies descriptive properties of the medicine	None
contraindication	List[Reference] | None	Potential clinical issue with or between medication(s)	None
regulatory	List[MedicationKnowledgeRegulatory] | None	Regulatory information about a medication	None
kinetics	List[MedicationKnowledgeKinetics] | None	The time course of drug absorption, distribution, metabolism and excretion of a medication from the body	None
resourceType	Literal['MedicationKnowledge']		'MedicationKnowledge'

MedicationKnowledgeAdministrationGuidelines

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeAdministrationGuidelines

Bases: BackboneElement

Guidelines for the administration of the medication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
dosage	List[MedicationKnowledgeAdministrationGuidelinesDosage] | None	Dosage for the medication for the specific guidelines	None
indicationCodeableConcept	CodeableConcept | None	Indication for use that apply to the specific administration guidelines	None
indicationReference	Reference | None	Indication for use that apply to the specific administration guidelines	None
patientCharacteristics	List[MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics] | None	Characteristics of the patient that are relevant to the administration guidelines	None

MedicationKnowledgeAdministrationGuidelinesDosage

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeAdministrationGuidelinesDosage

Bases: BackboneElement

Dosage for the medication for the specific guidelines.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of dosage	None
dosage	List[Dosage] | None	Dosage for the medication for the specific guidelines	None

MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics

Bases: BackboneElement

Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
characteristicCodeableConcept	CodeableConcept | None	Specific characteristic that is relevant to the administration guideline	None
characteristicQuantity	Quantity | None	Specific characteristic that is relevant to the administration guideline	None
value	List[String] | None	The specific characteristic	None
value_ext	Element | None	Placeholder element for value extensions	None

MedicationKnowledgeCost

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeCost

Bases: BackboneElement

The price of the medication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	The category of the cost information	None
source	String | None	The source or owner for the price information	None
source_ext	Element | None	Placeholder element for source extensions	None
cost	Money | None	The price of the medication	None

MedicationKnowledgeDrugCharacteristic

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeDrugCharacteristic

Bases: BackboneElement

Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Code specifying the type of characteristic of medication	None
valueCodeableConcept	CodeableConcept | None	Description of the characteristic	None
valueString	String | None	Description of the characteristic	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueQuantity	Quantity | None	Description of the characteristic	None
valueBase64Binary	Base64Binary | None	Description of the characteristic	None
valueBase64Binary_ext	Element | None	Placeholder element for valueBase64Binary extensions	None

MedicationKnowledgeIngredient

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeIngredient

Bases: BackboneElement

Identifies a particular constituent of interest in the product.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemCodeableConcept	CodeableConcept | None	Medication(s) or substance(s) contained in the medication	None
itemReference	Reference | None	Medication(s) or substance(s) contained in the medication	None
isActive	Boolean | None	Active ingredient indicator	None
isActive_ext	Element | None	Placeholder element for isActive extensions	None
strength	Ratio | None	Quantity of ingredient present	None

MedicationKnowledgeKinetics

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeKinetics

Bases: BackboneElement

The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
areaUnderCurve	List[Quantity] | None	The drug concentration measured at certain discrete points in time	None
lethalDose50	List[Quantity] | None	The median lethal dose of a drug	None
halfLifePeriod	Duration | None	Time required for concentration in the body to decrease by half	None

MedicationKnowledgeMedicineClassification

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeMedicineClassification

Bases: BackboneElement

Categorization of the medication within a formulary or classification system.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)	None
classification	List[CodeableConcept] | None	Specific category assigned to the medication	None

MedicationKnowledgeMonitoringProgram

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeMonitoringProgram

Bases: BackboneElement

The program under which the medication is reviewed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of program under which the medication is monitored	None
name	String | None	Name of the reviewing program	None
name_ext	Element | None	Placeholder element for name extensions	None

MedicationKnowledgeMonograph

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeMonograph

Bases: BackboneElement

Associated documentation about the medication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	The category of medication document	None
source	Reference | None	Associated documentation about the medication	None

MedicationKnowledgePackaging

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgePackaging

Bases: BackboneElement

Information that only applies to packages (not products).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	A code that defines the specific type of packaging that the medication can be found in	None
quantity	Quantity | None	The number of product units the package would contain if fully loaded	None

MedicationKnowledgeRegulatory

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeRegulatory

Bases: BackboneElement

Regulatory information about a medication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
regulatoryAuthority	Reference | None	Specifies the authority of the regulation	None
substitution	List[MedicationKnowledgeRegulatorySubstitution] | None	Specifies if changes are allowed when dispensing a medication from a regulatory perspective	None
schedule	List[MedicationKnowledgeRegulatorySchedule] | None	Specifies the schedule of a medication in jurisdiction	None
maxDispense	MedicationKnowledgeRegulatoryMaxDispense | None	The maximum number of units of the medication that can be dispensed in a period	None

MedicationKnowledgeRegulatoryMaxDispense

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeRegulatoryMaxDispense

Bases: BackboneElement

The maximum number of units of the medication that can be dispensed in a period.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
quantity	Quantity | None	The maximum number of units of the medication that can be dispensed	None
period	Duration | None	The period that applies to the maximum number of units	None

MedicationKnowledgeRegulatorySchedule

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeRegulatorySchedule

Bases: BackboneElement

Specifies the schedule of a medication in jurisdiction.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
schedule	CodeableConcept | None	Specifies the specific drug schedule	None

MedicationKnowledgeRegulatorySubstitution

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeRegulatorySubstitution

Bases: BackboneElement

Specifies if changes are allowed when dispensing a medication from a regulatory perspective.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Specifies the type of substitution allowed	None
allowed	Boolean | None	Specifies if regulation allows for changes in the medication when dispensing	None
allowed_ext	Element | None	Placeholder element for allowed extensions	None

MedicationKnowledgeRelatedMedicationKnowledge

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_knowledge.MedicationKnowledgeRelatedMedicationKnowledge

Bases: BackboneElement

Associated or related knowledge about a medication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Category of medicationKnowledge	None
reference	List[Reference] | None	Associated documentation about the associated medication knowledge	None

MedicationRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_request.MedicationRequest

Bases: DomainResource

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicationRequest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External ids for this request	None
status	Code | None	active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason for current status	None
intent	Code | None	proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
category	List[CodeableConcept] | None	Type of medication usage	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
doNotPerform	Boolean | None	True if request is prohibiting action	None
doNotPerform_ext	Element | None	Placeholder element for doNotPerform extensions	None
reportedBoolean	Boolean | None	Reported rather than primary record	None
reportedBoolean_ext	Element | None	Placeholder element for reportedBoolean extensions	None
reportedReference	Reference | None	Reported rather than primary record	None
medicationCodeableConcept	CodeableConcept | None	Medication to be taken	None
medicationReference	Reference | None	Medication to be taken	None
subject	Reference | None	Who or group medication request is for	None
encounter	Reference | None	Encounter created as part of encounter/admission/stay	None
supportingInformation	List[Reference] | None	Information to support ordering of the medication	None
authoredOn	DateTime | None	When request was initially authored	None
authoredOn_ext	Element | None	Placeholder element for authoredOn extensions	None
requester	Reference | None	Who/What requested the Request	None
performer	Reference | None	Intended performer of administration	None
performerType	CodeableConcept | None	Desired kind of performer of the medication administration	None
recorder	Reference | None	Person who entered the request	None
reasonCode	List[CodeableConcept] | None	Reason or indication for ordering or not ordering the medication	None
reasonReference	List[Reference] | None	Condition or observation that supports why the prescription is being written	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	What request fulfills	None
groupIdentifier	Identifier | None	Composite request this is part of	None
courseOfTherapyType	CodeableConcept | None	Overall pattern of medication administration	None
insurance	List[Reference] | None	Associated insurance coverage	None
note	List[Annotation] | None	Information about the prescription	None
dosageInstruction	List[Dosage] | None	How the medication should be taken	None
dispenseRequest	MedicationRequestDispenseRequest | None	Medication supply authorization	None
substitution	MedicationRequestSubstitution | None	Any restrictions on medication substitution	None
priorPrescription	Reference | None	An order/prescription that is being replaced	None
detectedIssue	List[Reference] | None	Clinical Issue with action	None
eventHistory	List[Reference] | None	A list of events of interest in the lifecycle	None
resourceType	Literal['MedicationRequest']		'MedicationRequest'

MedicationRequestDispenseRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_request.MedicationRequestDispenseRequest

Bases: BackboneElement

Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
initialFill	MedicationRequestDispenseRequestInitialFill | None	First fill details	None
dispenseInterval	Duration | None	Minimum period of time between dispenses	None
validityPeriod	Period | None	Time period supply is authorized for	None
numberOfRepeatsAllowed	UnsignedInt | None	Number of refills authorized	None
numberOfRepeatsAllowed_ext	Element | None	Placeholder element for numberOfRepeatsAllowed extensions	None
quantity	Quantity | None	Amount of medication to supply per dispense	None
expectedSupplyDuration	Duration | None	Number of days supply per dispense	None
performer	Reference | None	Intended dispenser	None

MedicationRequestDispenseRequestInitialFill

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_request.MedicationRequestDispenseRequestInitialFill

Bases: BackboneElement

Indicates the quantity or duration for the first dispense of the medication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
quantity	Quantity | None	First fill quantity	None
duration	Duration | None	First fill duration	None

MedicationRequestSubstitution

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_request.MedicationRequestSubstitution

Bases: BackboneElement

Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
allowedBoolean	Boolean | None	Whether substitution is allowed or not	None
allowedBoolean_ext	Element | None	Placeholder element for allowedBoolean extensions	None
allowedCodeableConcept	CodeableConcept | None	Whether substitution is allowed or not	None
reason	CodeableConcept | None	Why should (not) substitution be made	None

MedicationStatement

Path: fhircraft.fhir.resources.datatypes.R4.core.medication_statement.MedicationStatement

Bases: DomainResource

A record of a medication that is being consumed by a patient.   A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future.  The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician.  A common scenario where this information is captured is during the history taking process during a patient visit or stay.   The medication information may come from sources such as the patient's memory, from a prescription bottle,  or from a list of medications the patient, clinician or other party maintains.

The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicationStatement'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External identifier	None
basedOn	List[Reference] | None	Fulfils plan, proposal or order	None
partOf	List[Reference] | None	Part of referenced event	None
status	Code | None	active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	List[CodeableConcept] | None	Reason for current status	None
category	CodeableConcept | None	Type of medication usage	None
medicationCodeableConcept	CodeableConcept | None	What medication was taken	None
medicationReference	Reference | None	What medication was taken	None
subject	Reference | None	Who is/was taking the medication	None
context	Reference | None	Encounter / Episode associated with MedicationStatement	None
effectiveDateTime	DateTime | None	The date/time or interval when the medication is/was/will be taken	None
effectiveDateTime_ext	Element | None	Placeholder element for effectiveDateTime extensions	None
effectivePeriod	Period | None	The date/time or interval when the medication is/was/will be taken	None
dateAsserted	DateTime | None	When the statement was asserted?	None
dateAsserted_ext	Element | None	Placeholder element for dateAsserted extensions	None
informationSource	Reference | None	Person or organization that provided the information about the taking of this medication	None
derivedFrom	List[Reference] | None	Additional supporting information	None
reasonCode	List[CodeableConcept] | None	Reason for why the medication is being/was taken	None
reasonReference	List[Reference] | None	Condition or observation that supports why the medication is being/was taken	None
note	List[Annotation] | None	Further information about the statement	None
dosage	List[Dosage] | None	Details of how medication is/was taken or should be taken	None
resourceType	Literal['MedicationStatement']		'MedicationStatement'

MedicinalProduct

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product.MedicinalProduct

Bases: DomainResource

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProduct'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier for this product. Could be an MPID	None
type	CodeableConcept | None	Regulatory type, e.g. Investigational or Authorized	None
domain	Coding | None	If this medicine applies to human or veterinary uses	None
combinedPharmaceuticalDoseForm	CodeableConcept | None	The dose form for a single part product, or combined form of a multiple part product	None
legalStatusOfSupply	CodeableConcept | None	The legal status of supply of the medicinal product as classified by the regulator	None
additionalMonitoringIndicator	CodeableConcept | None	Whether the Medicinal Product is subject to additional monitoring for regulatory reasons	None
specialMeasures	List[String] | None	Whether the Medicinal Product is subject to special measures for regulatory reasons	None
specialMeasures_ext	Element | None	Placeholder element for specialMeasures extensions	None
paediatricUseIndicator	CodeableConcept | None	If authorised for use in children	None
productClassification	List[CodeableConcept] | None	Allows the product to be classified by various systems	None
marketingStatus	List[MarketingStatus] | None	Marketing status of the medicinal product, in contrast to marketing authorizaton	None
pharmaceuticalProduct	List[Reference] | None	Pharmaceutical aspects of product	None
packagedMedicinalProduct	List[Reference] | None	Package representation for the product	None
attachedDocument	List[Reference] | None	Supporting documentation, typically for regulatory submission	None
masterFile	List[Reference] | None	A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)	None
contact	List[Reference] | None	A product specific contact, person (in a role), or an organization	None
clinicalTrial	List[Reference] | None	Clinical trials or studies that this product is involved in	None
name	List[MedicinalProductName] | None	The product's name, including full name and possibly coded parts	None
crossReference	List[Identifier] | None	Reference to another product, e.g. for linking authorised to investigational product	None
manufacturingBusinessOperation	List[MedicinalProductManufacturingBusinessOperation] | None	An operation applied to the product, for manufacturing or adminsitrative purpose	None
specialDesignation	List[MedicinalProductSpecialDesignation] | None	Indicates if the medicinal product has an orphan designation for the treatment of a rare disease	None
resourceType	Literal['MedicinalProduct']		'MedicinalProduct'

MedicinalProductManufacturingBusinessOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product.MedicinalProductManufacturingBusinessOperation

Bases: BackboneElement

An operation applied to the product, for manufacturing or adminsitrative purpose.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
operationType	CodeableConcept | None	The type of manufacturing operation	None
authorisationReferenceNumber	Identifier | None	Regulatory authorization reference number	None
effectiveDate	DateTime | None	Regulatory authorization date	None
effectiveDate_ext	Element | None	Placeholder element for effectiveDate extensions	None
confidentialityIndicator	CodeableConcept | None	To indicate if this proces is commercially confidential	None
manufacturer	List[Reference] | None	The manufacturer or establishment associated with the process	None
regulator	Reference | None	A regulator which oversees the operation	None

MedicinalProductName

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product.MedicinalProductName

Bases: BackboneElement

The product's name, including full name and possibly coded parts.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
productName	String | None	The full product name	None
productName_ext	Element | None	Placeholder element for productName extensions	None
namePart	List[MedicinalProductNameNamePart] | None	Coding words or phrases of the name	None
countryLanguage	List[MedicinalProductNameCountryLanguage] | None	Country where the name applies	None

MedicinalProductNameCountryLanguage

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product.MedicinalProductNameCountryLanguage

Bases: BackboneElement

Country where the name applies.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
country	CodeableConcept | None	Country code for where this name applies	None
jurisdiction	CodeableConcept | None	Jurisdiction code for where this name applies	None
language	CodeableConcept | None	Language code for this name	None

MedicinalProductNameNamePart

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product.MedicinalProductNameNamePart

Bases: BackboneElement

Coding words or phrases of the name.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
part	String | None	A fragment of a product name	None
part_ext	Element | None	Placeholder element for part extensions	None
type	Coding | None	Idenifying type for this part of the name (e.g. strength part)	None

MedicinalProductSpecialDesignation

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product.MedicinalProductSpecialDesignation

Bases: BackboneElement

Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	List[Identifier] | None	Identifier for the designation, or procedure number	None
type	CodeableConcept | None	The type of special designation, e.g. orphan drug, minor use	None
intendedUse	CodeableConcept | None	The intended use of the product, e.g. prevention, treatment	None
indicationCodeableConcept	CodeableConcept | None	Condition for which the medicinal use applies	None
indicationReference	Reference | None	Condition for which the medicinal use applies	None
status	CodeableConcept | None	For example granted, pending, expired or withdrawn	None
date	DateTime | None	Date when the designation was granted	None
date_ext	Element | None	Placeholder element for date extensions	None
species	CodeableConcept | None	Animal species for which this applies	None

MedicinalProductAuthorization

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_authorization.MedicinalProductAuthorization

Bases: DomainResource

The regulatory authorization of a medicinal product.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier for the marketing authorization, as assigned by a regulator	None
subject	Reference | None	The medicinal product that is being authorized	None
country	List[CodeableConcept] | None	The country in which the marketing authorization has been granted	None
jurisdiction	List[CodeableConcept] | None	Jurisdiction within a country	None
status	CodeableConcept | None	The status of the marketing authorization	None
statusDate	DateTime | None	The date at which the given status has become applicable	None
statusDate_ext	Element | None	Placeholder element for statusDate extensions	None
restoreDate	DateTime | None	The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored	None
restoreDate_ext	Element | None	Placeholder element for restoreDate extensions	None
validityPeriod	Period | None	The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format	None
dataExclusivityPeriod	Period | None	A period of time after authorization before generic product applicatiosn can be submitted	None
dateOfFirstAuthorization	DateTime | None	The date when the first authorization was granted by a Medicines Regulatory Agency	None
dateOfFirstAuthorization_ext	Element | None	Placeholder element for dateOfFirstAuthorization extensions	None
internationalBirthDate	DateTime | None	Date of first marketing authorization for a company's new medicinal product in any country in the World	None
internationalBirthDate_ext	Element | None	Placeholder element for internationalBirthDate extensions	None
legalBasis	CodeableConcept | None	The legal framework against which this authorization is granted	None
jurisdictionalAuthorization	List[MedicinalProductAuthorizationJurisdictionalAuthorization] | None	Authorization in areas within a country	None
holder	Reference | None	Marketing Authorization Holder	None
regulator	Reference | None	Medicines Regulatory Agency	None
procedure	MedicinalProductAuthorizationProcedure | None	The regulatory procedure for granting or amending a marketing authorization	None
resourceType	Literal['MedicinalProductAuthorization']		'MedicinalProductAuthorization'

MedicinalProductAuthorizationJurisdictionalAuthorization

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_authorization.MedicinalProductAuthorizationJurisdictionalAuthorization

Bases: BackboneElement

Authorization in areas within a country.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	List[Identifier] | None	The assigned number for the marketing authorization	None
country	CodeableConcept | None	Country of authorization	None
jurisdiction	List[CodeableConcept] | None	Jurisdiction within a country	None
legalStatusOfSupply	CodeableConcept | None	The legal status of supply in a jurisdiction or region	None
validityPeriod	Period | None	The start and expected end date of the authorization	None

MedicinalProductAuthorizationProcedure

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_authorization.MedicinalProductAuthorizationProcedure

Bases: BackboneElement

The regulatory procedure for granting or amending a marketing authorization.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Identifier | None	Identifier for this procedure	None
type	CodeableConcept | None	Type of procedure	None
datePeriod	Period | None	Date of procedure	None
dateDateTime	DateTime | None	Date of procedure	None
dateDateTime_ext	Element | None	Placeholder element for dateDateTime extensions	None
application	List[MedicinalProductAuthorizationProcedure] | None	Applcations submitted to obtain a marketing authorization	None

MedicinalProductContraindication

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_contraindication.MedicinalProductContraindication

Bases: DomainResource

The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
subject	List[Reference] | None	The medication for which this is an indication	None
disease	CodeableConcept | None	The disease, symptom or procedure for the contraindication	None
diseaseStatus	CodeableConcept | None	The status of the disease or symptom for the contraindication	None
comorbidity	List[CodeableConcept] | None	A comorbidity (concurrent condition) or coinfection	None
therapeuticIndication	List[Reference] | None	Information about the use of the medicinal product in relation to other therapies as part of the indication	None
otherTherapy	List[MedicinalProductContraindicationOtherTherapy] | None	Information about the use of the medicinal product in relation to other therapies described as part of the indication	None
population	List[Population] | None	The population group to which this applies	None
resourceType	Literal['MedicinalProductContraindication']		'MedicinalProductContraindication'

MedicinalProductContraindicationOtherTherapy

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_contraindication.MedicinalProductContraindicationOtherTherapy

Bases: BackboneElement

Information about the use of the medicinal product in relation to other therapies described as part of the indication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
therapyRelationshipType	CodeableConcept | None	The type of relationship between the medicinal product indication or contraindication and another therapy	None
medicationCodeableConcept	CodeableConcept | None	Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication	None
medicationReference	Reference | None	Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication	None

MedicinalProductIndication

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_indication.MedicinalProductIndication

Bases: DomainResource

Indication for the Medicinal Product.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
subject	List[Reference] | None	The medication for which this is an indication	None
diseaseSymptomProcedure	CodeableConcept | None	The disease, symptom or procedure that is the indication for treatment	None
diseaseStatus	CodeableConcept | None	The status of the disease or symptom for which the indication applies	None
comorbidity	List[CodeableConcept] | None	Comorbidity (concurrent condition) or co-infection as part of the indication	None
intendedEffect	CodeableConcept | None	The intended effect, aim or strategy to be achieved by the indication	None
duration	Quantity | None	Timing or duration information as part of the indication	None
otherTherapy	List[MedicinalProductIndicationOtherTherapy] | None	Information about the use of the medicinal product in relation to other therapies described as part of the indication	None
undesirableEffect	List[Reference] | None	Describe the undesirable effects of the medicinal product	None
population	List[Population] | None	The population group to which this applies	None
resourceType	Literal['MedicinalProductIndication']		'MedicinalProductIndication'

MedicinalProductIndicationOtherTherapy

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_indication.MedicinalProductIndicationOtherTherapy

Bases: BackboneElement

Information about the use of the medicinal product in relation to other therapies described as part of the indication.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
therapyRelationshipType	CodeableConcept | None	The type of relationship between the medicinal product indication or contraindication and another therapy	None
medicationCodeableConcept	CodeableConcept | None	Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication	None
medicationReference	Reference | None	Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication	None

MedicinalProductIngredient

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_ingredient.MedicinalProductIngredient

Bases: DomainResource

An ingredient of a manufactured item or pharmaceutical product.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	Identifier | None	Identifier for the ingredient	None
role	CodeableConcept | None	Ingredient role e.g. Active ingredient, excipient	None
allergenicIndicator	Boolean | None	If the ingredient is a known or suspected allergen	None
allergenicIndicator_ext	Element | None	Placeholder element for allergenicIndicator extensions	None
manufacturer	List[Reference] | None	Manufacturer of this Ingredient	None
specifiedSubstance	List[MedicinalProductIngredientSpecifiedSubstance] | None	A specified substance that comprises this ingredient	None
substance	MedicinalProductIngredientSubstance | None	The ingredient substance	None
resourceType	Literal['MedicinalProductIngredient']		'MedicinalProductIngredient'

MedicinalProductIngredientSpecifiedSubstance

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_ingredient.MedicinalProductIngredientSpecifiedSubstance

Bases: BackboneElement

A specified substance that comprises this ingredient.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	The specified substance	None
group	CodeableConcept | None	The group of specified substance, e.g. group 1 to 4	None
confidentiality	CodeableConcept | None	Confidentiality level of the specified substance as the ingredient	None
strength	List[MedicinalProductIngredientSpecifiedSubstanceStrength] | None	Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product	None

MedicinalProductIngredientSpecifiedSubstanceStrength

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_ingredient.MedicinalProductIngredientSpecifiedSubstanceStrength

Bases: BackboneElement

Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
presentation	Ratio | None	The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item	None
presentationLowLimit	Ratio | None	A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit	None
concentration	Ratio | None	The strength per unitary volume (or mass)	None
concentrationLowLimit	Ratio | None	A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit	None
measurementPoint	String | None	For when strength is measured at a particular point or distance	None
measurementPoint_ext	Element | None	Placeholder element for measurementPoint extensions	None
country	List[CodeableConcept] | None	The country or countries for which the strength range applies	None
referenceStrength	List[MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength] | None	Strength expressed in terms of a reference substance	None

MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_ingredient.MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength

Bases: BackboneElement

Strength expressed in terms of a reference substance.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
substance	CodeableConcept | None	Relevant reference substance	None
strength	Ratio | None	Strength expressed in terms of a reference substance	None
strengthLowLimit	Ratio | None	Strength expressed in terms of a reference substance	None
measurementPoint	String | None	For when strength is measured at a particular point or distance	None
measurementPoint_ext	Element | None	Placeholder element for measurementPoint extensions	None
country	List[CodeableConcept] | None	The country or countries for which the strength range applies	None

MedicinalProductIngredientSubstance

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_ingredient.MedicinalProductIngredientSubstance

Bases: BackboneElement

The ingredient substance.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	The ingredient substance	None
strength	List[MedicinalProductIngredientSubstanceStrength] | None	Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product	None

MedicinalProductIngredientSubstanceStrength

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_ingredient.MedicinalProductIngredientSubstanceStrength

Bases: BackboneElement

Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
presentation	Ratio | None	The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item	None
presentationLowLimit	Ratio | None	A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit	None
concentration	Ratio | None	The strength per unitary volume (or mass)	None
concentrationLowLimit	Ratio | None	A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit	None
measurementPoint	String | None	For when strength is measured at a particular point or distance	None
measurementPoint_ext	Element | None	Placeholder element for measurementPoint extensions	None
country	List[CodeableConcept] | None	The country or countries for which the strength range applies	None
referenceStrength	List[MedicinalProductIngredientSpecifiedSubstanceStrengthReferenceStrength] | None	Strength expressed in terms of a reference substance	None

MedicinalProductInteraction

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_interaction.MedicinalProductInteraction

Bases: DomainResource

The interactions of the medicinal product with other medicinal products, or other forms of interactions.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
subject	List[Reference] | None	The medication for which this is a described interaction	None
description	String | None	The interaction described	None
description_ext	Element | None	Placeholder element for description extensions	None
interactant	List[MedicinalProductInteractionInteractant] | None	The specific medication, food or laboratory test that interacts	None
type	CodeableConcept | None	The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction	None
effect	CodeableConcept | None	The effect of the interaction, for example "reduced gastric absorption of primary medication"	None
incidence	CodeableConcept | None	The incidence of the interaction, e.g. theoretical, observed	None
management	CodeableConcept | None	Actions for managing the interaction	None
resourceType	Literal['MedicinalProductInteraction']		'MedicinalProductInteraction'

MedicinalProductInteractionInteractant

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_interaction.MedicinalProductInteractionInteractant

Bases: BackboneElement

The specific medication, food or laboratory test that interacts.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
itemReference	Reference | None	The specific medication, food or laboratory test that interacts	None
itemCodeableConcept	CodeableConcept | None	The specific medication, food or laboratory test that interacts	None

MedicinalProductManufactured

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_manufactured.MedicinalProductManufactured

Bases: DomainResource

The manufactured item as contained in the packaged medicinal product.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
manufacturedDoseForm	CodeableConcept | None	Dose form as manufactured and before any transformation into the pharmaceutical product	None
unitOfPresentation	CodeableConcept | None	The “real world” units in which the quantity of the manufactured item is described	None
quantity	Quantity | None	The quantity or "count number" of the manufactured item	None
manufacturer	List[Reference] | None	Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues)	None
ingredient	List[Reference] | None	Ingredient	None
physicalCharacteristics	ProdCharacteristic | None	Dimensions, color etc.	None
otherCharacteristics	List[CodeableConcept] | None	Other codeable characteristics	None
resourceType	Literal['MedicinalProductManufactured']		'MedicinalProductManufactured'

MedicinalProductPackaged

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_packaged.MedicinalProductPackaged

Bases: DomainResource

A medicinal product in a container or package.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique identifier	None
subject	List[Reference] | None	The product with this is a pack for	None
description	String | None	Textual description	None
description_ext	Element | None	Placeholder element for description extensions	None
legalStatusOfSupply	CodeableConcept | None	The legal status of supply of the medicinal product as classified by the regulator	None
marketingStatus	List[MarketingStatus] | None	Marketing information	None
marketingAuthorization	Reference | None	Manufacturer of this Package Item	None
manufacturer	List[Reference] | None	Manufacturer of this Package Item	None
batchIdentifier	List[MedicinalProductPackagedBatchIdentifier] | None	Batch numbering	None
packageItem	List[MedicinalProductPackagedPackageItem] | None	A packaging item, as a contained for medicine, possibly with other packaging items within	None
resourceType	Literal['MedicinalProductPackaged']		'MedicinalProductPackaged'

MedicinalProductPackagedBatchIdentifier

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_packaged.MedicinalProductPackagedBatchIdentifier

Bases: BackboneElement

Batch numbering.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
outerPackaging	Identifier | None	A number appearing on the outer packaging of a specific batch	None
immediatePackaging	Identifier | None	A number appearing on the immediate packaging (and not the outer packaging)	None

MedicinalProductPackagedPackageItem

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_packaged.MedicinalProductPackagedPackageItem

Bases: BackboneElement

A packaging item, as a contained for medicine, possibly with other packaging items within.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	List[Identifier] | None	Including possibly Data Carrier Identifier	None
type	CodeableConcept | None	The physical type of the container of the medicine	None
quantity	Quantity | None	The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1	None
material	List[CodeableConcept] | None	Material type of the package item	None
alternateMaterial	List[CodeableConcept] | None	A possible alternate material for the packaging	None
device	List[Reference] | None	A device accompanying a medicinal product	None
manufacturedItem	List[Reference] | None	The manufactured item as contained in the packaged medicinal product	None
packageItem	List[MedicinalProductPackagedPackageItem] | None	Allows containers within containers	None
physicalCharacteristics	ProdCharacteristic | None	Dimensions, color etc.	None
otherCharacteristics	List[CodeableConcept] | None	Other codeable characteristics	None
shelfLifeStorage	List[ProductShelfLife] | None	Shelf Life and storage information	None
manufacturer	List[Reference] | None	Manufacturer of this Package Item	None

MedicinalProductPharmaceutical

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_pharmaceutical.MedicinalProductPharmaceutical

Bases: DomainResource

A pharmaceutical product described in terms of its composition and dose form.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	An identifier for the pharmaceutical medicinal product	None
administrableDoseForm	CodeableConcept | None	The administrable dose form, after necessary reconstitution	None
unitOfPresentation	CodeableConcept | None	Todo	None
ingredient	List[Reference] | None	Ingredient	None
device	List[Reference] | None	Accompanying device	None
characteristics	List[MedicinalProductPharmaceuticalCharacteristics] | None	Characteristics e.g. a products onset of action	None
routeOfAdministration	List[MedicinalProductPharmaceuticalRouteOfAdministration] | None	The path by which the pharmaceutical product is taken into or makes contact with the body	None
resourceType	Literal['MedicinalProductPharmaceutical']		'MedicinalProductPharmaceutical'

MedicinalProductPharmaceuticalCharacteristics

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_pharmaceutical.MedicinalProductPharmaceuticalCharacteristics

Bases: BackboneElement

Characteristics e.g. a products onset of action.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	A coded characteristic	None
status	CodeableConcept | None	The status of characteristic e.g. assigned or pending	None

MedicinalProductPharmaceuticalRouteOfAdministration

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_pharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministration

Bases: BackboneElement

The path by which the pharmaceutical product is taken into or makes contact with the body.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Coded expression for the route	None
firstDose	Quantity | None	The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement	None
maxSingleDose	Quantity | None	The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement	None
maxDosePerDay	Quantity | None	The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation	None
maxDosePerTreatmentPeriod	Ratio | None	The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation	None
maxTreatmentPeriod	Duration | None	The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation	None
targetSpecies	List[MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies] | None	A species for which this route applies	None

MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_pharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpecies

Bases: BackboneElement

A species for which this route applies.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Coded expression for the species	None
withdrawalPeriod	List[MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod] | None	A species specific time during which consumption of animal product is not appropriate	None

MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_pharmaceutical.MedicinalProductPharmaceuticalRouteOfAdministrationTargetSpeciesWithdrawalPeriod

Bases: BackboneElement

A species specific time during which consumption of animal product is not appropriate.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
tissue	CodeableConcept | None	Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk	None
value	Quantity | None	A value for the time	None
supportingInformation	String | None	Extra information about the withdrawal period	None
supportingInformation_ext	Element | None	Placeholder element for supportingInformation extensions	None

MedicinalProductUndesirableEffect

Path: fhircraft.fhir.resources.datatypes.R4.core.medicinal_product_undesirable_effect.MedicinalProductUndesirableEffect

Bases: DomainResource

Describe the undesirable effects of the medicinal product.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
subject	List[Reference] | None	The medication for which this is an indication	None
symptomConditionEffect	CodeableConcept | None	The symptom, condition or undesirable effect	None
classification	CodeableConcept | None	Classification of the effect	None
frequencyOfOccurrence	CodeableConcept | None	The frequency of occurrence of the effect	None
population	List[Population] | None	The population group to which this applies	None
resourceType	Literal['MedicinalProductUndesirableEffect']		'MedicinalProductUndesirableEffect'

MessageDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.message_definition.MessageDefinition

Bases: DomainResource

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MessageDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Business Identifier for a given MessageDefinition	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Primary key for the message definition on a given server	None
version	String | None	Business version of the message definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this message definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this message definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
replaces	List[Canonical] | None	Takes the place of	None
replaces_ext	Element | None	Placeholder element for replaces extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the message definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for message definition (if applicable)	None
purpose	Markdown | None	Why this message definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
base	Canonical | None	Definition this one is based on	None
base_ext	Element | None	Placeholder element for base extensions	None
parent	List[Canonical] | None	Protocol/workflow this is part of	None
parent_ext	Element | None	Placeholder element for parent extensions	None
eventCoding	Coding | None	Event code or link to the EventDefinition	None
eventUri	Uri | None	Event code or link to the EventDefinition	None
eventUri_ext	Element | None	Placeholder element for eventUri extensions	None
category	Code | None	consequence | currency | notification	None
category_ext	Element | None	Placeholder element for category extensions	None
focus	List[MessageDefinitionFocus] | None	Resource(s) that are the subject of the event	None
responseRequired	Code | None	always | on-error | never | on-success	None
responseRequired_ext	Element | None	Placeholder element for responseRequired extensions	None
allowedResponse	List[MessageDefinitionAllowedResponse] | None	Responses to this message	None
graph	List[Canonical] | None	Canonical reference to a GraphDefinition	None
graph_ext	Element | None	Placeholder element for graph extensions	None
resourceType	Literal['MessageDefinition']		'MessageDefinition'

MessageDefinitionAllowedResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.message_definition.MessageDefinitionAllowedResponse

Bases: BackboneElement

Indicates what types of messages may be sent as an application-level response to this message.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
message	Canonical | None	Reference to allowed message definition response	None
message_ext	Element | None	Placeholder element for message extensions	None
situation	Markdown | None	When should this response be used	None
situation_ext	Element | None	Placeholder element for situation extensions	None

MessageDefinitionFocus

Path: fhircraft.fhir.resources.datatypes.R4.core.message_definition.MessageDefinitionFocus

Bases: BackboneElement

Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Type of resource	None
code_ext	Element | None	Placeholder element for code extensions	None
profile	Canonical | None	Profile that must be adhered to by focus	None
profile_ext	Element | None	Placeholder element for profile extensions	None
min	UnsignedInt | None	Minimum number of focuses of this type	None
min_ext	Element | None	Placeholder element for min extensions	None
max	String | None	Maximum number of focuses of this type	None
max_ext	Element | None	Placeholder element for max extensions	None

MessageHeader

Path: fhircraft.fhir.resources.datatypes.R4.core.message_header.MessageHeader

Bases: DomainResource

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MessageHeader'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
eventCoding	Coding | None	Code for the event this message represents or link to event definition	None
eventUri	Uri | None	Code for the event this message represents or link to event definition	None
eventUri_ext	Element | None	Placeholder element for eventUri extensions	None
destination	List[MessageHeaderDestination] | None	Message destination application(s)	None
sender	Reference | None	Real world sender of the message	None
enterer	Reference | None	The source of the data entry	None
author	Reference | None	The source of the decision	None
source	MessageHeaderSource | None	Message source application	None
responsible	Reference | None	Final responsibility for event	None
reason	CodeableConcept | None	Cause of event	None
response	MessageHeaderResponse | None	If this is a reply to prior message	None
focus	List[Reference] | None	The actual content of the message	None
definition	Canonical | None	Link to the definition for this message	None
definition_ext	Element | None	Placeholder element for definition extensions	None
resourceType	Literal['MessageHeader']		'MessageHeader'

MessageHeaderDestination

Path: fhircraft.fhir.resources.datatypes.R4.core.message_header.MessageHeaderDestination

Bases: BackboneElement

The destination application which the message is intended for.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name of system	None
name_ext	Element | None	Placeholder element for name extensions	None
target	Reference | None	Particular delivery destination within the destination	None
endpoint	Url | None	Actual destination address or id	None
endpoint_ext	Element | None	Placeholder element for endpoint extensions	None
receiver	Reference | None	Intended "real-world" recipient for the data	None

MessageHeaderResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.message_header.MessageHeaderResponse

Bases: BackboneElement

Information about the message that this message is a response to. Only present if this message is a response.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Id | None	Id of original message	None
identifier_ext	Element | None	Placeholder element for identifier extensions	None
code	Code | None	ok | transient-error | fatal-error	None
code_ext	Element | None	Placeholder element for code extensions	None
details	Reference | None	Specific list of hints/warnings/errors	None

MessageHeaderSource

Path: fhircraft.fhir.resources.datatypes.R4.core.message_header.MessageHeaderSource

Bases: BackboneElement

The source application from which this message originated.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name of system	None
name_ext	Element | None	Placeholder element for name extensions	None
software	String | None	Name of software running the system	None
software_ext	Element | None	Placeholder element for software extensions	None
version	String | None	Version of software running	None
version_ext	Element | None	Placeholder element for version extensions	None
contact	ContactPoint | None	Human contact for problems	None
endpoint	Url | None	Actual message source address or id	None
endpoint_ext	Element | None	Placeholder element for endpoint extensions	None

MetadataResource

Path: fhircraft.fhir.resources.datatypes.R4.core.metadata_resource.MetadataResource

Bases: FHIRBaseModel

Common Ancestor declaration for conformance and knowledge artifact resources.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MetadataResource'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this metadata resource, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the metadata resource	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this metadata resource (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this metadata resource (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the metadata resource	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for metadata resource (if applicable)	None
resourceType	Literal['MetadataResource']		'MetadataResource'

MolecularSequence

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequence

Bases: DomainResource

Raw data describing a biological sequence.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/MolecularSequence'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique ID for this particular sequence. This is a FHIR-defined id	None
type	Code | None	aa | dna | rna	None
type_ext	Element | None	Placeholder element for type extensions	None
coordinateSystem	Integer | None	Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)	None
coordinateSystem_ext	Element | None	Placeholder element for coordinateSystem extensions	None
patient	Reference | None	Who and/or what this is about	None
specimen	Reference | None	Specimen used for sequencing	None
device	Reference | None	The method for sequencing	None
performer	Reference | None	Who should be responsible for test result	None
quantity	Quantity | None	The number of copies of the sequence of interest. (RNASeq)	None
referenceSeq	MolecularSequenceReferenceSeq | None	A sequence used as reference	None
variant	List[MolecularSequenceVariant] | None	Variant in sequence	None
observedSeq	String | None	Sequence that was observed	None
observedSeq_ext	Element | None	Placeholder element for observedSeq extensions	None
quality	List[MolecularSequenceQuality] | None	An set of value as quality of sequence	None
readCoverage	Integer | None	Average number of reads representing a given nucleotide in the reconstructed sequence	None
readCoverage_ext	Element | None	Placeholder element for readCoverage extensions	None
repository	List[MolecularSequenceRepository] | None	External repository which contains detailed report related with observedSeq in this resource	None
pointer	List[Reference] | None	Pointer to next atomic sequence	None
structureVariant	List[MolecularSequenceStructureVariant] | None	Structural variant	None
resourceType	Literal['MolecularSequence']		'MolecularSequence'

MolecularSequenceQuality

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceQuality

Bases: BackboneElement

An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score (SO:0001686).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	indel | snp | unknown	None
type_ext	Element | None	Placeholder element for type extensions	None
standardSequence	CodeableConcept | None	Standard sequence for comparison	None
start	Integer | None	Start position of the sequence	None
start_ext	Element | None	Placeholder element for start extensions	None
end	Integer | None	End position of the sequence	None
end_ext	Element | None	Placeholder element for end extensions	None
score	Quantity | None	Quality score for the comparison	None
method	CodeableConcept | None	Method to get quality	None
truthTP	Decimal | None	True positives from the perspective of the truth data	None
truthTP_ext	Element | None	Placeholder element for truthTP extensions	None
queryTP	Decimal | None	True positives from the perspective of the query data	None
queryTP_ext	Element | None	Placeholder element for queryTP extensions	None
truthFN	Decimal | None	False negatives	None
truthFN_ext	Element | None	Placeholder element for truthFN extensions	None
queryFP	Decimal | None	False positives	None
queryFP_ext	Element | None	Placeholder element for queryFP extensions	None
gtFP	Decimal | None	False positives where the non-REF alleles in the Truth and Query Call Sets match	None
gtFP_ext	Element | None	Placeholder element for gtFP extensions	None
precision	Decimal | None	Precision of comparison	None
precision_ext	Element | None	Placeholder element for precision extensions	None
recall	Decimal | None	Recall of comparison	None
recall_ext	Element | None	Placeholder element for recall extensions	None
fScore	Decimal | None	F-score	None
fScore_ext	Element | None	Placeholder element for fScore extensions	None
roc	MolecularSequenceQualityRoc | None	Receiver Operator Characteristic (ROC) Curve	None

MolecularSequenceQualityRoc

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceQualityRoc

Bases: BackboneElement

Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
score	List[Integer] | None	Genotype quality score	None
score_ext	Element | None	Placeholder element for score extensions	None
numTP	List[Integer] | None	Roc score true positive numbers	None
numTP_ext	Element | None	Placeholder element for numTP extensions	None
numFP	List[Integer] | None	Roc score false positive numbers	None
numFP_ext	Element | None	Placeholder element for numFP extensions	None
numFN	List[Integer] | None	Roc score false negative numbers	None
numFN_ext	Element | None	Placeholder element for numFN extensions	None
precision	List[Decimal] | None	Precision of the GQ score	None
precision_ext	Element | None	Placeholder element for precision extensions	None
sensitivity	List[Decimal] | None	Sensitivity of the GQ score	None
sensitivity_ext	Element | None	Placeholder element for sensitivity extensions	None
fMeasure	List[Decimal] | None	FScore of the GQ score	None
fMeasure_ext	Element | None	Placeholder element for fMeasure extensions	None

MolecularSequenceReferenceSeq

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceReferenceSeq

Bases: BackboneElement

A sequence that is used as a reference to describe variants that are present in a sequence analyzed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
chromosome	CodeableConcept | None	Chromosome containing genetic finding	None
genomeBuild	String | None	The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'	None
genomeBuild_ext	Element | None	Placeholder element for genomeBuild extensions	None
orientation	Code | None	sense | antisense	None
orientation_ext	Element | None	Placeholder element for orientation extensions	None
referenceSeqId	CodeableConcept | None	Reference identifier	None
referenceSeqPointer	Reference | None	A pointer to another MolecularSequence entity as reference sequence	None
referenceSeqString	String | None	A string to represent reference sequence	None
referenceSeqString_ext	Element | None	Placeholder element for referenceSeqString extensions	None
strand	Code | None	watson | crick	None
strand_ext	Element | None	Placeholder element for strand extensions	None
windowStart	Integer | None	Start position of the window on the reference sequence	None
windowStart_ext	Element | None	Placeholder element for windowStart extensions	None
windowEnd	Integer | None	End position of the window on the reference sequence	None
windowEnd_ext	Element | None	Placeholder element for windowEnd extensions	None

MolecularSequenceRepository

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceRepository

Bases: BackboneElement

Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	directlink | openapi | login | oauth | other	None
type_ext	Element | None	Placeholder element for type extensions	None
url	Uri | None	URI of the repository	None
url_ext	Element | None	Placeholder element for url extensions	None
name	String | None	Repository's name	None
name_ext	Element | None	Placeholder element for name extensions	None
datasetId	String | None	Id of the dataset that used to call for dataset in repository	None
datasetId_ext	Element | None	Placeholder element for datasetId extensions	None
variantsetId	String | None	Id of the variantset that used to call for variantset in repository	None
variantsetId_ext	Element | None	Placeholder element for variantsetId extensions	None
readsetId	String | None	Id of the read	None
readsetId_ext	Element | None	Placeholder element for readsetId extensions	None

MolecularSequenceStructureVariant

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceStructureVariant

Bases: BackboneElement

Information about chromosome structure variation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
variantType	CodeableConcept | None	Structural variant change type	None
exact	Boolean | None	Does the structural variant have base pair resolution breakpoints?	None
exact_ext	Element | None	Placeholder element for exact extensions	None
length	Integer | None	Structural variant length	None
length_ext	Element | None	Placeholder element for length extensions	None
outer	MolecularSequenceStructureVariantOuter | None	Structural variant outer	None
inner	MolecularSequenceStructureVariantInner | None	Structural variant inner	None

MolecularSequenceStructureVariantInner

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceStructureVariantInner

Bases: BackboneElement

Structural variant inner.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
start	Integer | None	Structural variant inner start	None
start_ext	Element | None	Placeholder element for start extensions	None
end	Integer | None	Structural variant inner end	None
end_ext	Element | None	Placeholder element for end extensions	None

MolecularSequenceStructureVariantOuter

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceStructureVariantOuter

Bases: BackboneElement

Structural variant outer.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
start	Integer | None	Structural variant outer start	None
start_ext	Element | None	Placeholder element for start extensions	None
end	Integer | None	Structural variant outer end	None
end_ext	Element | None	Placeholder element for end extensions	None

MolecularSequenceVariant

Path: fhircraft.fhir.resources.datatypes.R4.core.molecular_sequence.MolecularSequenceVariant

Bases: BackboneElement

The definition of variant here originates from Sequence ontology (variant_of). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
start	Integer | None	Start position of the variant on the reference sequence	None
start_ext	Element | None	Placeholder element for start extensions	None
end	Integer | None	End position of the variant on the reference sequence	None
end_ext	Element | None	Placeholder element for end extensions	None
observedAllele	String | None	Allele that was observed	None
observedAllele_ext	Element | None	Placeholder element for observedAllele extensions	None
referenceAllele	String | None	Allele in the reference sequence	None
referenceAllele_ext	Element | None	Placeholder element for referenceAllele extensions	None
cigar	String | None	Extended CIGAR string for aligning the sequence with reference bases	None
cigar_ext	Element | None	Placeholder element for cigar extensions	None
variantPointer	Reference | None	Pointer to observed variant information	None

NamingSystem

Path: fhircraft.fhir.resources.datatypes.R4.core.naming_system.NamingSystem

Bases: DomainResource

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/NamingSystem'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
name	String | None	Name for this naming system (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
kind	Code | None	codesystem | identifier | root	None
kind_ext	Element | None	Placeholder element for kind extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
responsible	String | None	Who maintains system namespace?	None
responsible_ext	Element | None	Placeholder element for responsible extensions	None
type	CodeableConcept | None	e.g. driver, provider, patient, bank etc.	None
description	Markdown | None	Natural language description of the naming system	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for naming system (if applicable)	None
usage	String | None	How/where is it used	None
usage_ext	Element | None	Placeholder element for usage extensions	None
uniqueId	List[NamingSystemUniqueId] | None	Unique identifiers used for system	None
resourceType	Literal['NamingSystem']		'NamingSystem'

NamingSystemUniqueId

Path: fhircraft.fhir.resources.datatypes.R4.core.naming_system.NamingSystemUniqueId

Bases: BackboneElement

Indicates how the system may be identified when referenced in electronic exchange.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	oid | uuid | uri | other	None
type_ext	Element | None	Placeholder element for type extensions	None
value	String | None	The unique identifier	None
value_ext	Element | None	Placeholder element for value extensions	None
preferred	Boolean | None	Is this the id that should be used for this type	None
preferred_ext	Element | None	Placeholder element for preferred extensions	None
comment	String | None	Notes about identifier usage	None
comment_ext	Element | None	Placeholder element for comment extensions	None
period	Period | None	When is identifier valid?	None

NutritionOrder

Path: fhircraft.fhir.resources.datatypes.R4.core.nutrition_order.NutritionOrder

Bases: DomainResource

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/NutritionOrder'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifiers assigned to this order	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
instantiates	List[Uri] | None	Instantiates protocol or definition	None
instantiates_ext	Element | None	Placeholder element for instantiates extensions	None
status	Code | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
intent	Code | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
patient	Reference | None	The person who requires the diet, formula or nutritional supplement	None
encounter	Reference | None	The encounter associated with this nutrition order	None
dateTime	DateTime | None	Date and time the nutrition order was requested	None
dateTime_ext	Element | None	Placeholder element for dateTime extensions	None
orderer	Reference | None	Who ordered the diet, formula or nutritional supplement	None
allergyIntolerance	List[Reference] | None	List of the patient's food and nutrition-related allergies and intolerances	None
foodPreferenceModifier	List[CodeableConcept] | None	Order-specific modifier about the type of food that should be given	None
excludeFoodModifier	List[CodeableConcept] | None	Order-specific modifier about the type of food that should not be given	None
oralDiet	NutritionOrderOralDiet | None	Oral diet components	None
supplement	List[NutritionOrderSupplement] | None	Supplement components	None
enteralFormula	NutritionOrderEnteralFormula | None	Enteral formula components	None
note	List[Annotation] | None	Comments	None
resourceType	Literal['NutritionOrder']		'NutritionOrder'

NutritionOrderEnteralFormula

Path: fhircraft.fhir.resources.datatypes.R4.core.nutrition_order.NutritionOrderEnteralFormula

Bases: BackboneElement

Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
baseFormulaType	CodeableConcept | None	Type of enteral or infant formula	None
baseFormulaProductName	String | None	Product or brand name of the enteral or infant formula	None
baseFormulaProductName_ext	Element | None	Placeholder element for baseFormulaProductName extensions	None
additiveType	CodeableConcept | None	Type of modular component to add to the feeding	None
additiveProductName	String | None	Product or brand name of the modular additive	None
additiveProductName_ext	Element | None	Placeholder element for additiveProductName extensions	None
caloricDensity	Quantity | None	Amount of energy per specified volume that is required	None
routeofAdministration	CodeableConcept | None	How the formula should enter the patient's gastrointestinal tract	None
administration	List[NutritionOrderEnteralFormulaAdministration] | None	Formula feeding instruction as structured data	None
maxVolumeToDeliver	Quantity | None	Upper limit on formula volume per unit of time	None
administrationInstruction	String | None	Formula feeding instructions expressed as text	None
administrationInstruction_ext	Element | None	Placeholder element for administrationInstruction extensions	None

NutritionOrderEnteralFormulaAdministration

Path: fhircraft.fhir.resources.datatypes.R4.core.nutrition_order.NutritionOrderEnteralFormulaAdministration

Bases: BackboneElement

Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
schedule	Timing | None	Scheduled frequency of enteral feeding	None
quantity	Quantity | None	The volume of formula to provide	None
rateQuantity	Quantity | None	Speed with which the formula is provided per period of time	None
rateRatio	Ratio | None	Speed with which the formula is provided per period of time	None

NutritionOrderOralDiet

Path: fhircraft.fhir.resources.datatypes.R4.core.nutrition_order.NutritionOrderOralDiet

Bases: BackboneElement

Diet given orally in contrast to enteral (tube) feeding.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	List[CodeableConcept] | None	Type of oral diet or diet restrictions that describe what can be consumed orally	None
schedule	List[Timing] | None	Scheduled frequency of diet	None
nutrient	List[NutritionOrderOralDietNutrient] | None	Required nutrient modifications	None
texture	List[NutritionOrderOralDietTexture] | None	Required texture modifications	None
fluidConsistencyType	List[CodeableConcept] | None	The required consistency of fluids and liquids provided to the patient	None
instruction	String | None	Instructions or additional information about the oral diet	None
instruction_ext	Element | None	Placeholder element for instruction extensions	None

NutritionOrderOralDietNutrient

Path: fhircraft.fhir.resources.datatypes.R4.core.nutrition_order.NutritionOrderOralDietNutrient

Bases: BackboneElement

Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
modifier	CodeableConcept | None	Type of nutrient that is being modified	None
amount	Quantity | None	Quantity of the specified nutrient	None

NutritionOrderOralDietTexture

Path: fhircraft.fhir.resources.datatypes.R4.core.nutrition_order.NutritionOrderOralDietTexture

Bases: BackboneElement

Class that describes any texture modifications required for the patient to safely consume various types of solid foods.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
modifier	CodeableConcept | None	Code to indicate how to alter the texture of the foods, e.g. pureed	None
foodType	CodeableConcept | None	Concepts that are used to identify an entity that is ingested for nutritional purposes	None

NutritionOrderSupplement

Path: fhircraft.fhir.resources.datatypes.R4.core.nutrition_order.NutritionOrderSupplement

Bases: BackboneElement

Oral nutritional products given in order to add further nutritional value to the patient's diet.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of supplement product requested	None
productName	String | None	Product or brand name of the nutritional supplement	None
productName_ext	Element | None	Placeholder element for productName extensions	None
schedule	List[Timing] | None	Scheduled frequency of supplement	None
quantity	Quantity | None	Amount of the nutritional supplement	None
instruction	String | None	Instructions or additional information about the oral supplement	None
instruction_ext	Element | None	Placeholder element for instruction extensions	None

Observation

Path: fhircraft.fhir.resources.datatypes.R4.core.observation.Observation

Bases: DomainResource

Measurements and simple assertions made about a patient, device or other subject.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Observation'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for observation	None
basedOn	List[Reference] | None	Fulfills plan, proposal or order	None
partOf	List[Reference] | None	Part of referenced event	None
status	Code | None	registered | preliminary | final | amended +	None
status_ext	Element | None	Placeholder element for status extensions	None
category	List[CodeableConcept] | None	Classification of type of observation	None
code	CodeableConcept | None	Type of observation (code / type)	None
subject	Reference | None	Who and/or what the observation is about	None
focus	List[Reference] | None	What the observation is about, when it is not about the subject of record	None
encounter	Reference | None	Healthcare event during which this observation is made	None
effectiveDateTime	DateTime | None	Clinically relevant time/time-period for observation	None
effectiveDateTime_ext	Element | None	Placeholder element for effectiveDateTime extensions	None
effectivePeriod	Period | None	Clinically relevant time/time-period for observation	None
effectiveTiming	Timing | None	Clinically relevant time/time-period for observation	None
effectiveInstant	Instant | None	Clinically relevant time/time-period for observation	None
effectiveInstant_ext	Element | None	Placeholder element for effectiveInstant extensions	None
issued	Instant | None	Date/Time this version was made available	None
issued_ext	Element | None	Placeholder element for issued extensions	None
performer	List[Reference] | None	Who is responsible for the observation	None
valueQuantity	Quantity | None	Actual result	None
valueCodeableConcept	CodeableConcept | None	Actual result	None
valueString	String | None	Actual result	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueBoolean	Boolean | None	Actual result	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueInteger	Integer | None	Actual result	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueRange	Range | None	Actual result	None
valueRatio	Ratio | None	Actual result	None
valueSampledData	SampledData | None	Actual result	None
valueTime	Time | None	Actual result	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueDateTime	DateTime | None	Actual result	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valuePeriod	Period | None	Actual result	None
dataAbsentReason	CodeableConcept | None	Why the result is missing	None
interpretation	List[CodeableConcept] | None	High, low, normal, etc.	None
note	List[Annotation] | None	Comments about the observation	None
bodySite	CodeableConcept | None	Observed body part	None
method	CodeableConcept | None	How it was done	None
specimen	Reference | None	Specimen used for this observation	None
device	Reference | None	(Measurement) Device	None
referenceRange	List[ObservationReferenceRange] | None	Provides guide for interpretation	None
hasMember	List[Reference] | None	Related resource that belongs to the Observation group	None
derivedFrom	List[Reference] | None	Related measurements the observation is made from	None
component	List[ObservationComponent] | None	Component results	None
resourceType	Literal['Observation']		'Observation'

ObservationComponent

Path: fhircraft.fhir.resources.datatypes.R4.core.observation.ObservationComponent

Bases: BackboneElement

Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Type of component observation (code / type)	None
valueQuantity	Quantity | None	Actual component result	None
valueCodeableConcept	CodeableConcept | None	Actual component result	None
valueString	String | None	Actual component result	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueBoolean	Boolean | None	Actual component result	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueInteger	Integer | None	Actual component result	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueRange	Range | None	Actual component result	None
valueRatio	Ratio | None	Actual component result	None
valueSampledData	SampledData | None	Actual component result	None
valueTime	Time | None	Actual component result	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueDateTime	DateTime | None	Actual component result	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valuePeriod	Period | None	Actual component result	None
dataAbsentReason	CodeableConcept | None	Why the component result is missing	None
interpretation	List[CodeableConcept] | None	High, low, normal, etc.	None
referenceRange	List[ObservationComponentReferenceRange] | None	Provides guide for interpretation of component result	None

ObservationComponentReferenceRange

Path: fhircraft.fhir.resources.datatypes.R4.core.observation.ObservationComponentReferenceRange

Bases: BackboneElement

Guidance on how to interpret the value by comparison to a normal or recommended range.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
low	Quantity | None	Low Range, if relevant	None
high	Quantity | None	High Range, if relevant	None
type	CodeableConcept | None	Reference range qualifier	None
appliesTo	List[CodeableConcept] | None	Reference range population	None
age	Range | None	Applicable age range, if relevant	None
text	String | None	Text based reference range in an observation	None
text_ext	Element | None	Placeholder element for text extensions	None

ObservationReferenceRange

Path: fhircraft.fhir.resources.datatypes.R4.core.observation.ObservationReferenceRange

Bases: BackboneElement

Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
low	Quantity | None	Low Range, if relevant	None
high	Quantity | None	High Range, if relevant	None
type	CodeableConcept | None	Reference range qualifier	None
appliesTo	List[CodeableConcept] | None	Reference range population	None
age	Range | None	Applicable age range, if relevant	None
text	String | None	Text based reference range in an observation	None
text_ext	Element | None	Placeholder element for text extensions	None

ObservationDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.observation_definition.ObservationDefinition

Bases: DomainResource

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ObservationDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
category	List[CodeableConcept] | None	Category of observation	None
code	CodeableConcept | None	Type of observation (code / type)	None
identifier	List[Identifier] | None	Business identifier for this ObservationDefinition instance	None
permittedDataType	List[Code] | None	Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period	None
permittedDataType_ext	Element | None	Placeholder element for permittedDataType extensions	None
multipleResultsAllowed	Boolean | None	Multiple results allowed	None
multipleResultsAllowed_ext	Element | None	Placeholder element for multipleResultsAllowed extensions	None
method	CodeableConcept | None	Method used to produce the observation	None
preferredReportName	String | None	Preferred report name	None
preferredReportName_ext	Element | None	Placeholder element for preferredReportName extensions	None
quantitativeDetails	ObservationDefinitionQuantitativeDetails | None	Characteristics of quantitative results	None
qualifiedInterval	List[ObservationDefinitionQualifiedInterval] | None	Qualified range for continuous and ordinal observation results	None
validCodedValueSet	Reference | None	Value set of valid coded values for the observations conforming to this ObservationDefinition	None
normalCodedValueSet	Reference | None	Value set of normal coded values for the observations conforming to this ObservationDefinition	None
abnormalCodedValueSet	Reference | None	Value set of abnormal coded values for the observations conforming to this ObservationDefinition	None
criticalCodedValueSet	Reference | None	Value set of critical coded values for the observations conforming to this ObservationDefinition	None
resourceType	Literal['ObservationDefinition']		'ObservationDefinition'

ObservationDefinitionQualifiedInterval

Path: fhircraft.fhir.resources.datatypes.R4.core.observation_definition.ObservationDefinitionQualifiedInterval

Bases: BackboneElement

Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	Code | None	reference | critical | absolute	None
category_ext	Element | None	Placeholder element for category extensions	None
range	Range | None	The interval itself, for continuous or ordinal observations	None
context	CodeableConcept | None	Range context qualifier	None
appliesTo	List[CodeableConcept] | None	Targetted population of the range	None
gender	Code | None	male | female | other | unknown	None
gender_ext	Element | None	Placeholder element for gender extensions	None
age	Range | None	Applicable age range, if relevant	None
gestationalAge	Range | None	Applicable gestational age range, if relevant	None
condition	String | None	Condition associated with the reference range	None
condition_ext	Element | None	Placeholder element for condition extensions	None

ObservationDefinitionQuantitativeDetails

Path: fhircraft.fhir.resources.datatypes.R4.core.observation_definition.ObservationDefinitionQuantitativeDetails

Bases: BackboneElement

Characteristics for quantitative results of this observation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
customaryUnit	CodeableConcept | None	Customary unit for quantitative results	None
unit	CodeableConcept | None	SI unit for quantitative results	None
conversionFactor	Decimal | None	SI to Customary unit conversion factor	None
conversionFactor_ext	Element | None	Placeholder element for conversionFactor extensions	None
decimalPrecision	Integer | None	Decimal precision of observation quantitative results	None
decimalPrecision_ext	Element | None	Placeholder element for decimalPrecision extensions	None

OperationDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.operation_definition.OperationDefinition

Bases: DomainResource

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/OperationDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this operation definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the operation definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this operation definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this operation definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
kind	Code | None	operation | query	None
kind_ext	Element | None	Placeholder element for kind extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the operation definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for operation definition (if applicable)	None
purpose	Markdown | None	Why this operation definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
affectsState	Boolean | None	Whether content is changed by the operation	None
affectsState_ext	Element | None	Placeholder element for affectsState extensions	None
code	Code | None	Name used to invoke the operation	None
code_ext	Element | None	Placeholder element for code extensions	None
comment	Markdown | None	Additional information about use	None
comment_ext	Element | None	Placeholder element for comment extensions	None
base	Canonical | None	Marks this as a profile of the base	None
base_ext	Element | None	Placeholder element for base extensions	None
resource	List[Code] | None	Types this operation applies to	None
resource_ext	Element | None	Placeholder element for resource extensions	None
system	Boolean | None	Invoke at the system level?	None
system_ext	Element | None	Placeholder element for system extensions	None
type	Boolean | None	Invoke at the type level?	None
type_ext	Element | None	Placeholder element for type extensions	None
instance	Boolean | None	Invoke on an instance?	None
instance_ext	Element | None	Placeholder element for instance extensions	None
inputProfile	Canonical | None	Validation information for in parameters	None
inputProfile_ext	Element | None	Placeholder element for inputProfile extensions	None
outputProfile	Canonical | None	Validation information for out parameters	None
outputProfile_ext	Element | None	Placeholder element for outputProfile extensions	None
parameter	List[OperationDefinitionParameter] | None	Parameters for the operation/query	None
overload	List[OperationDefinitionOverload] | None	Define overloaded variants for when generating code	None
resourceType	Literal['OperationDefinition']		'OperationDefinition'

OperationDefinitionOverload

Path: fhircraft.fhir.resources.datatypes.R4.core.operation_definition.OperationDefinitionOverload

Bases: BackboneElement

Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
parameterName	List[String] | None	Name of parameter to include in overload	None
parameterName_ext	Element | None	Placeholder element for parameterName extensions	None
comment	String | None	Comments to go on overload	None
comment_ext	Element | None	Placeholder element for comment extensions	None

OperationDefinitionParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.operation_definition.OperationDefinitionParameter

Bases: BackboneElement

The parameters for the operation/query.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	Code | None	Name in Parameters.parameter.name or in URL	None
name_ext	Element | None	Placeholder element for name extensions	None
use	Code | None	in | out	None
use_ext	Element | None	Placeholder element for use extensions	None
min	Integer | None	Minimum Cardinality	None
min_ext	Element | None	Placeholder element for min extensions	None
max	String | None	Maximum Cardinality (a number or *)	None
max_ext	Element | None	Placeholder element for max extensions	None
documentation	String | None	Description of meaning/use	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None
type	Code | None	What type this parameter has	None
type_ext	Element | None	Placeholder element for type extensions	None
targetProfile	List[Canonical] | None	If type is Reference | canonical, allowed targets	None
targetProfile_ext	Element | None	Placeholder element for targetProfile extensions	None
searchType	Code | None	number | date | string | token | reference | composite | quantity | uri | special	None
searchType_ext	Element | None	Placeholder element for searchType extensions	None
binding	OperationDefinitionParameterBinding | None	ValueSet details if this is coded	None
referencedFrom	List[OperationDefinitionParameterReferencedFrom] | None	References to this parameter	None
part	List[OperationDefinitionParameter] | None	Parts of a nested Parameter	None

OperationDefinitionParameterBinding

Path: fhircraft.fhir.resources.datatypes.R4.core.operation_definition.OperationDefinitionParameterBinding

Bases: BackboneElement

Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
strength	Code | None	required | extensible | preferred | example	None
strength_ext	Element | None	Placeholder element for strength extensions	None
valueSet	Canonical | None	Source of value set	None
valueSet_ext	Element | None	Placeholder element for valueSet extensions	None

OperationDefinitionParameterReferencedFrom

Path: fhircraft.fhir.resources.datatypes.R4.core.operation_definition.OperationDefinitionParameterReferencedFrom

Bases: BackboneElement

Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
source	String | None	Referencing parameter	None
source_ext	Element | None	Placeholder element for source extensions	None
sourceId	String | None	Element id of reference	None
sourceId_ext	Element | None	Placeholder element for sourceId extensions	None

OperationOutcome

Path: fhircraft.fhir.resources.datatypes.R4.core.operation_outcome.OperationOutcome

Bases: DomainResource

A collection of error, warning, or information messages that result from a system action.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/OperationOutcome'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
issue	List[OperationOutcomeIssue] | None	A single issue associated with the action	None
resourceType	Literal['OperationOutcome']		'OperationOutcome'

OperationOutcomeIssue

Path: fhircraft.fhir.resources.datatypes.R4.core.operation_outcome.OperationOutcomeIssue

Bases: BackboneElement

An error, warning, or information message that results from a system action.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
severity	Code | None	fatal | error | warning | information	None
severity_ext	Element | None	Placeholder element for severity extensions	None
code	Code | None	Error or warning code	None
code_ext	Element | None	Placeholder element for code extensions	None
details	CodeableConcept | None	Additional details about the error	None
diagnostics	String | None	Additional diagnostic information about the issue	None
diagnostics_ext	Element | None	Placeholder element for diagnostics extensions	None
location	List[String] | None	Deprecated: Path of element(s) related to issue	None
location_ext	Element | None	Placeholder element for location extensions	None
expression	List[String] | None	FHIRPath of element(s) related to issue	None
expression_ext	Element | None	Placeholder element for expression extensions	None

Organization

Path: fhircraft.fhir.resources.datatypes.R4.core.organization.Organization

Bases: DomainResource

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Organization'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifies this organization across multiple systems	None
active	Boolean | None	Whether the organization's record is still in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
type	List[CodeableConcept] | None	Kind of organization	None
name	String | None	Name used for the organization	None
name_ext	Element | None	Placeholder element for name extensions	None
alias	List[String] | None	A list of alternate names that the organization is known as, or was known as in the past	None
alias_ext	Element | None	Placeholder element for alias extensions	None
telecom	List[ContactPoint] | None	A contact detail for the organization	None
address	List[Address] | None	An address for the organization	None
partOf	Reference | None	The organization of which this organization forms a part	None
contact	List[OrganizationContact] | None	Contact for the organization for a certain purpose	None
endpoint	List[Reference] | None	Technical endpoints providing access to services operated for the organization	None
resourceType	Literal['Organization']		'Organization'

OrganizationContact

Path: fhircraft.fhir.resources.datatypes.R4.core.organization.OrganizationContact

Bases: BackboneElement

Contact for the organization for a certain purpose.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
purpose	CodeableConcept | None	The type of contact	None
name	HumanName | None	A name associated with the contact	None
telecom	List[ContactPoint] | None	Contact details (telephone, email, etc.) for a contact	None
address	Address | None	Visiting or postal addresses for the contact	None

OrganizationAffiliation

Path: fhircraft.fhir.resources.datatypes.R4.core.organization_affiliation.OrganizationAffiliation

Bases: DomainResource

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifiers that are specific to this role	None
active	Boolean | None	Whether this organization affiliation record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
period	Period | None	The period during which the participatingOrganization is affiliated with the primary organization	None
organization	Reference | None	Organization where the role is available	None
participatingOrganization	Reference | None	Organization that provides/performs the role (e.g. providing services or is a member of)	None
network	List[Reference] | None	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)	None
code	List[CodeableConcept] | None	Definition of the role the participatingOrganization plays	None
specialty	List[CodeableConcept] | None	Specific specialty of the participatingOrganization in the context of the role	None
location	List[Reference] | None	The location(s) at which the role occurs	None
healthcareService	List[Reference] | None	Healthcare services provided through the role	None
telecom	List[ContactPoint] | None	Contact details at the participatingOrganization relevant to this Affiliation	None
endpoint	List[Reference] | None	Technical endpoints providing access to services operated for this role	None
resourceType	Literal['OrganizationAffiliation']		'OrganizationAffiliation'

Parameters

Path: fhircraft.fhir.resources.datatypes.R4.core.parameters.Parameters

Bases: Resource

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Parameters'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
parameter	List[ParametersParameter] | None	Operation Parameter	None
resourceType	Literal['Parameters']		'Parameters'

ParametersParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.parameters.ParametersParameter

Bases: BackboneElement

A parameter passed to or received from the operation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name from the definition	None
name_ext	Element | None	Placeholder element for name extensions	None
valueBase64Binary	Base64Binary | None	If parameter is a data type	None
valueBase64Binary_ext	Element | None	Placeholder element for valueBase64Binary extensions	None
valueBoolean	Boolean | None	If parameter is a data type	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueCanonical	Canonical | None	If parameter is a data type	None
valueCanonical_ext	Element | None	Placeholder element for valueCanonical extensions	None
valueCode	Code | None	If parameter is a data type	None
valueCode_ext	Element | None	Placeholder element for valueCode extensions	None
valueDate	Date | None	If parameter is a data type	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueDateTime	DateTime | None	If parameter is a data type	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueDecimal	Decimal | None	If parameter is a data type	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueId	Id | None	If parameter is a data type	None
valueId_ext	Element | None	Placeholder element for valueId extensions	None
valueInstant	Instant | None	If parameter is a data type	None
valueInstant_ext	Element | None	Placeholder element for valueInstant extensions	None
valueInteger	Integer | None	If parameter is a data type	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueMarkdown	Markdown | None	If parameter is a data type	None
valueMarkdown_ext	Element | None	Placeholder element for valueMarkdown extensions	None
valueOid	Oid | None	If parameter is a data type	None
valueOid_ext	Element | None	Placeholder element for valueOid extensions	None
valuePositiveInt	PositiveInt | None	If parameter is a data type	None
valuePositiveInt_ext	Element | None	Placeholder element for valuePositiveInt extensions	None
valueString	String | None	If parameter is a data type	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueTime	Time | None	If parameter is a data type	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueUnsignedInt	UnsignedInt | None	If parameter is a data type	None
valueUnsignedInt_ext	Element | None	Placeholder element for valueUnsignedInt extensions	None
valueUri	Uri | None	If parameter is a data type	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueUrl	Url | None	If parameter is a data type	None
valueUrl_ext	Element | None	Placeholder element for valueUrl extensions	None
valueUuid	Uuid | None	If parameter is a data type	None
valueUuid_ext	Element | None	Placeholder element for valueUuid extensions	None
valueAddress	Address | None	If parameter is a data type	None
valueAge	Age | None	If parameter is a data type	None
valueAnnotation	Annotation | None	If parameter is a data type	None
valueAttachment	Attachment | None	If parameter is a data type	None
valueCodeableConcept	CodeableConcept | None	If parameter is a data type	None
valueCoding	Coding | None	If parameter is a data type	None
valueContactPoint	ContactPoint | None	If parameter is a data type	None
valueCount	Count | None	If parameter is a data type	None
valueDistance	Distance | None	If parameter is a data type	None
valueDuration	Duration | None	If parameter is a data type	None
valueHumanName	HumanName | None	If parameter is a data type	None
valueIdentifier	Identifier | None	If parameter is a data type	None
valueMoney	Money | None	If parameter is a data type	None
valuePeriod	Period | None	If parameter is a data type	None
valueQuantity	Quantity | None	If parameter is a data type	None
valueRange	Range | None	If parameter is a data type	None
valueRatio	Ratio | None	If parameter is a data type	None
valueReference	Reference | None	If parameter is a data type	None
valueSampledData	SampledData | None	If parameter is a data type	None
valueSignature	Signature | None	If parameter is a data type	None
valueTiming	Timing | None	If parameter is a data type	None
valueContactDetail	ContactDetail | None	If parameter is a data type	None
valueContributor	Contributor | None	If parameter is a data type	None
valueDataRequirement	DataRequirement | None	If parameter is a data type	None
valueExpression	Expression | None	If parameter is a data type	None
valueParameterDefinition	ParameterDefinition | None	If parameter is a data type	None
valueRelatedArtifact	RelatedArtifact | None	If parameter is a data type	None
valueTriggerDefinition	TriggerDefinition | None	If parameter is a data type	None
valueUsageContext	UsageContext | None	If parameter is a data type	None
valueDosage	Dosage | None	If parameter is a data type	None
valueMeta	Meta | None	If parameter is a data type	None
resource	Resource | None	If parameter is a whole resource	None
part	List[ParametersParameter] | None	Named part of a multi-part parameter	None

Patient

Path: fhircraft.fhir.resources.datatypes.R4.core.patient.Patient

Bases: DomainResource

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Patient'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	An identifier for this patient	None
active	Boolean | None	Whether this patient's record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
name	List[HumanName] | None	A name associated with the patient	None
telecom	List[ContactPoint] | None	A contact detail for the individual	None
gender	Code | None	male | female | other | unknown	None
gender_ext	Element | None	Placeholder element for gender extensions	None
birthDate	Date | None	The date of birth for the individual	None
birthDate_ext	Element | None	Placeholder element for birthDate extensions	None
deceasedBoolean	Boolean | None	Indicates if the individual is deceased or not	None
deceasedBoolean_ext	Element | None	Placeholder element for deceasedBoolean extensions	None
deceasedDateTime	DateTime | None	Indicates if the individual is deceased or not	None
deceasedDateTime_ext	Element | None	Placeholder element for deceasedDateTime extensions	None
address	List[Address] | None	An address for the individual	None
maritalStatus	CodeableConcept | None	Marital (civil) status of a patient	None
multipleBirthBoolean	Boolean | None	Whether patient is part of a multiple birth	None
multipleBirthBoolean_ext	Element | None	Placeholder element for multipleBirthBoolean extensions	None
multipleBirthInteger	Integer | None	Whether patient is part of a multiple birth	None
multipleBirthInteger_ext	Element | None	Placeholder element for multipleBirthInteger extensions	None
photo	List[Attachment] | None	Image of the patient	None
contact	List[PatientContact] | None	A contact party (e.g. guardian, partner, friend) for the patient	None
communication	List[PatientCommunication] | None	A language which may be used to communicate with the patient about his or her health	None
generalPractitioner	List[Reference] | None	Patient's nominated primary care provider	None
managingOrganization	Reference | None	Organization that is the custodian of the patient record	None
link	List[PatientLink] | None	Link to another patient resource that concerns the same actual person	None
resourceType	Literal['Patient']		'Patient'

PatientCommunication

Path: fhircraft.fhir.resources.datatypes.R4.core.patient.PatientCommunication

Bases: BackboneElement

A language which may be used to communicate with the patient about his or her health.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
language	CodeableConcept | None	The language which can be used to communicate with the patient about his or her health	None
preferred	Boolean | None	Language preference indicator	None
preferred_ext	Element | None	Placeholder element for preferred extensions	None

PatientContact

Path: fhircraft.fhir.resources.datatypes.R4.core.patient.PatientContact

Bases: BackboneElement

A contact party (e.g. guardian, partner, friend) for the patient.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
relationship	List[CodeableConcept] | None	The kind of relationship	None
name	HumanName | None	A name associated with the contact person	None
telecom	List[ContactPoint] | None	A contact detail for the person	None
address	Address | None	Address for the contact person	None
gender	Code | None	male | female | other | unknown	None
gender_ext	Element | None	Placeholder element for gender extensions	None
organization	Reference | None	Organization that is associated with the contact	None
period	Period | None	The period during which this contact person or organization is valid to be contacted relating to this patient	None

PatientLink

Path: fhircraft.fhir.resources.datatypes.R4.core.patient.PatientLink

Bases: BackboneElement

Link to another patient resource that concerns the same actual patient.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
other	Reference | None	The other patient or related person resource that the link refers to	None
type	Code | None	replaced-by | replaces | refer | seealso	None
type_ext	Element | None	Placeholder element for type extensions	None

PaymentNotice

Path: fhircraft.fhir.resources.datatypes.R4.core.payment_notice.PaymentNotice

Bases: DomainResource

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/PaymentNotice'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for the payment noctice	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
request	Reference | None	Request reference	None
response	Reference | None	Response reference	None
created	DateTime | None	Creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
provider	Reference | None	Responsible practitioner	None
payment	Reference | None	Payment reference	None
paymentDate	Date | None	Payment or clearing date	None
paymentDate_ext	Element | None	Placeholder element for paymentDate extensions	None
payee	Reference | None	Party being paid	None
recipient	Reference | None	Party being notified	None
amount	Money | None	Monetary amount of the payment	None
paymentStatus	CodeableConcept | None	Issued or cleared Status of the payment	None
resourceType	Literal['PaymentNotice']		'PaymentNotice'

PaymentReconciliation

Path: fhircraft.fhir.resources.datatypes.R4.core.payment_reconciliation.PaymentReconciliation

Bases: DomainResource

This resource provides the details including amount of a payment and allocates the payment items being paid.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/PaymentReconciliation'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for a payment reconciliation	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
period	Period | None	Period covered	None
created	DateTime | None	Creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
paymentIssuer	Reference | None	Party generating payment	None
request	Reference | None	Reference to requesting resource	None
requestor	Reference | None	Responsible practitioner	None
outcome	Code | None	queued | complete | error | partial	None
outcome_ext	Element | None	Placeholder element for outcome extensions	None
disposition	String | None	Disposition message	None
disposition_ext	Element | None	Placeholder element for disposition extensions	None
paymentDate	Date | None	When payment issued	None
paymentDate_ext	Element | None	Placeholder element for paymentDate extensions	None
paymentAmount	Money | None	Total amount of Payment	None
paymentIdentifier	Identifier | None	Business identifier for the payment	None
detail	List[PaymentReconciliationDetail] | None	Settlement particulars	None
formCode	CodeableConcept | None	Printed form identifier	None
processNote	List[PaymentReconciliationProcessNote] | None	Note concerning processing	None
resourceType	Literal['PaymentReconciliation']		'PaymentReconciliation'

PaymentReconciliationDetail

Path: fhircraft.fhir.resources.datatypes.R4.core.payment_reconciliation.PaymentReconciliationDetail

Bases: BackboneElement

Distribution of the payment amount for a previously acknowledged payable.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Identifier | None	Business identifier of the payment detail	None
predecessor	Identifier | None	Business identifier of the prior payment detail	None
type	CodeableConcept | None	Category of payment	None
request	Reference | None	Request giving rise to the payment	None
submitter	Reference | None	Submitter of the request	None
response	Reference | None	Response committing to a payment	None
date	Date | None	Date of commitment to pay	None
date_ext	Element | None	Placeholder element for date extensions	None
responsible	Reference | None	Contact for the response	None
payee	Reference | None	Recipient of the payment	None
amount	Money | None	Amount allocated to this payable	None

PaymentReconciliationProcessNote

Path: fhircraft.fhir.resources.datatypes.R4.core.payment_reconciliation.PaymentReconciliationProcessNote

Bases: BackboneElement

A note that describes or explains the processing in a human readable form.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	display | print | printoper	None
type_ext	Element | None	Placeholder element for type extensions	None
text	String | None	Note explanatory text	None
text_ext	Element | None	Placeholder element for text extensions	None

Person

Path: fhircraft.fhir.resources.datatypes.R4.core.person.Person

Bases: DomainResource

Demographics and administrative information about a person independent of a specific health-related context.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Person'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	A human identifier for this person	None
name	List[HumanName] | None	A name associated with the person	None
telecom	List[ContactPoint] | None	A contact detail for the person	None
gender	Code | None	male | female | other | unknown	None
gender_ext	Element | None	Placeholder element for gender extensions	None
birthDate	Date | None	The date on which the person was born	None
birthDate_ext	Element | None	Placeholder element for birthDate extensions	None
address	List[Address] | None	One or more addresses for the person	None
photo	Attachment | None	Image of the person	None
managingOrganization	Reference | None	The organization that is the custodian of the person record	None
active	Boolean | None	This person's record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
link	List[PersonLink] | None	Link to a resource that concerns the same actual person	None
resourceType	Literal['Person']		'Person'

PersonLink

Path: fhircraft.fhir.resources.datatypes.R4.core.person.PersonLink

Bases: BackboneElement

Link to a resource that concerns the same actual person.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
target	Reference | None	The resource to which this actual person is associated	None
assurance	Code | None	level1 | level2 | level3 | level4	None
assurance_ext	Element | None	Placeholder element for assurance extensions	None

PlanDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinition

Bases: DomainResource

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/PlanDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this plan definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the plan definition	None
version	String | None	Business version of the plan definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this plan definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this plan definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
subtitle	String | None	Subordinate title of the plan definition	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
type	CodeableConcept | None	order-set | clinical-protocol | eca-rule | workflow-definition	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
subjectCodeableConcept	CodeableConcept | None	Type of individual the plan definition is focused on	None
subjectReference	Reference | None	Type of individual the plan definition is focused on	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the plan definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for plan definition (if applicable)	None
purpose	Markdown | None	Why this plan definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
usage	String | None	Describes the clinical usage of the plan	None
usage_ext	Element | None	Placeholder element for usage extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the plan definition was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the plan definition was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the plan definition is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations	None
library	List[Canonical] | None	Logic used by the plan definition	None
library_ext	Element | None	Placeholder element for library extensions	None
goal	List[PlanDefinitionGoal] | None	What the plan is trying to accomplish	None
action	List[PlanDefinitionAction] | None	Action defined by the plan	None
resourceType	Literal['PlanDefinition']		'PlanDefinition'

PlanDefinitionAction

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinitionAction

Bases: BackboneElement

An action or group of actions to be taken as part of the plan.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
prefix	String | None	User-visible prefix for the action (e.g. 1. or A.)	None
prefix_ext	Element | None	Placeholder element for prefix extensions	None
title	String | None	User-visible title	None
title_ext	Element | None	Placeholder element for title extensions	None
description	String | None	Brief description of the action	None
description_ext	Element | None	Placeholder element for description extensions	None
textEquivalent	String | None	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system	None
textEquivalent_ext	Element | None	Placeholder element for textEquivalent extensions	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
code	List[CodeableConcept] | None	Code representing the meaning of the action or sub-actions	None
reason	List[CodeableConcept] | None	Why the action should be performed	None
documentation	List[RelatedArtifact] | None	Supporting documentation for the intended performer of the action	None
goalId	List[Id] | None	What goals this action supports	None
goalId_ext	Element | None	Placeholder element for goalId extensions	None
subjectCodeableConcept	CodeableConcept | None	Type of individual the action is focused on	None
subjectReference	Reference | None	Type of individual the action is focused on	None
trigger	List[TriggerDefinition] | None	When the action should be triggered	None
condition	List[PlanDefinitionActionCondition] | None	Whether or not the action is applicable	None
input	List[DataRequirement] | None	Input data requirements	None
output	List[DataRequirement] | None	Output data definition	None
relatedAction	List[PlanDefinitionActionRelatedAction] | None	Relationship to another action	None
timingDateTime	DateTime | None	When the action should take place	None
timingDateTime_ext	Element | None	Placeholder element for timingDateTime extensions	None
timingAge	Age | None	When the action should take place	None
timingPeriod	Period | None	When the action should take place	None
timingDuration	Duration | None	When the action should take place	None
timingRange	Range | None	When the action should take place	None
timingTiming	Timing | None	When the action should take place	None
participant	List[PlanDefinitionActionParticipant] | None	Who should participate in the action	None
type	CodeableConcept | None	create | update | remove | fire-event	None
groupingBehavior	Code | None	visual-group | logical-group | sentence-group	None
groupingBehavior_ext	Element | None	Placeholder element for groupingBehavior extensions	None
selectionBehavior	Code | None	any | all | all-or-none | exactly-one | at-most-one | one-or-more	None
selectionBehavior_ext	Element | None	Placeholder element for selectionBehavior extensions	None
requiredBehavior	Code | None	must | could | must-unless-documented	None
requiredBehavior_ext	Element | None	Placeholder element for requiredBehavior extensions	None
precheckBehavior	Code | None	yes | no	None
precheckBehavior_ext	Element | None	Placeholder element for precheckBehavior extensions	None
cardinalityBehavior	Code | None	single | multiple	None
cardinalityBehavior_ext	Element | None	Placeholder element for cardinalityBehavior extensions	None
definitionCanonical	Canonical | None	Description of the activity to be performed	None
definitionCanonical_ext	Element | None	Placeholder element for definitionCanonical extensions	None
definitionUri	Uri | None	Description of the activity to be performed	None
definitionUri_ext	Element | None	Placeholder element for definitionUri extensions	None
transform	Canonical | None	Transform to apply the template	None
transform_ext	Element | None	Placeholder element for transform extensions	None
dynamicValue	List[PlanDefinitionActionDynamicValue] | None	Dynamic aspects of the definition	None
action	List[PlanDefinitionAction] | None	A sub-action	None

PlanDefinitionActionCondition

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinitionActionCondition

Bases: BackboneElement

An expression that describes applicability criteria or start/stop conditions for the action.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
kind	Code | None	applicability | start | stop	None
kind_ext	Element | None	Placeholder element for kind extensions	None
expression	Expression | None	Boolean-valued expression	None

PlanDefinitionActionDynamicValue

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinitionActionDynamicValue

Bases: BackboneElement

Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
path	String | None	The path to the element to be set dynamically	None
path_ext	Element | None	Placeholder element for path extensions	None
expression	Expression | None	An expression that provides the dynamic value for the customization	None

PlanDefinitionActionParticipant

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinitionActionParticipant

Bases: BackboneElement

Indicates who should participate in performing the action described.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	patient | practitioner | related-person | device	None
type_ext	Element | None	Placeholder element for type extensions	None
role	CodeableConcept | None	E.g. Nurse, Surgeon, Parent	None

PlanDefinitionActionRelatedAction

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinitionActionRelatedAction

Bases: BackboneElement

A relationship to another action such as "before" or "30-60 minutes after start of".

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
actionId	Id | None	What action is this related to	None
actionId_ext	Element | None	Placeholder element for actionId extensions	None
relationship	Code | None	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end	None
relationship_ext	Element | None	Placeholder element for relationship extensions	None
offsetDuration	Duration | None	Time offset for the relationship	None
offsetRange	Range | None	Time offset for the relationship	None

PlanDefinitionGoal

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinitionGoal

Bases: BackboneElement

Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	E.g. Treatment, dietary, behavioral	None
description	CodeableConcept | None	Code or text describing the goal	None
priority	CodeableConcept | None	high-priority | medium-priority | low-priority	None
start	CodeableConcept | None	When goal pursuit begins	None
addresses	List[CodeableConcept] | None	What does the goal address	None
documentation	List[RelatedArtifact] | None	Supporting documentation for the goal	None
target	List[PlanDefinitionGoalTarget] | None	Target outcome for the goal	None

PlanDefinitionGoalTarget

Path: fhircraft.fhir.resources.datatypes.R4.core.plan_definition.PlanDefinitionGoalTarget

Bases: BackboneElement

Indicates what should be done and within what timeframe.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
measure	CodeableConcept | None	The parameter whose value is to be tracked	None
detailQuantity	Quantity | None	The target value to be achieved	None
detailRange	Range | None	The target value to be achieved	None
detailCodeableConcept	CodeableConcept | None	The target value to be achieved	None
due	Duration | None	Reach goal within	None

Practitioner

Path: fhircraft.fhir.resources.datatypes.R4.core.practitioner.Practitioner

Bases: DomainResource

A person who is directly or indirectly involved in the provisioning of healthcare.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Practitioner'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	An identifier for the person as this agent	None
active	Boolean | None	Whether this practitioner's record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
name	List[HumanName] | None	The name(s) associated with the practitioner	None
telecom	List[ContactPoint] | None	A contact detail for the practitioner (that apply to all roles)	None
address	List[Address] | None	Address(es) of the practitioner that are not role specific (typically home address)	None
gender	Code | None	male | female | other | unknown	None
gender_ext	Element | None	Placeholder element for gender extensions	None
birthDate	Date | None	The date on which the practitioner was born	None
birthDate_ext	Element | None	Placeholder element for birthDate extensions	None
photo	List[Attachment] | None	Image of the person	None
qualification	List[PractitionerQualification] | None	Certification, licenses, or training pertaining to the provision of care	None
communication	List[CodeableConcept] | None	A language the practitioner can use in patient communication	None
resourceType	Literal['Practitioner']		'Practitioner'

PractitionerQualification

Path: fhircraft.fhir.resources.datatypes.R4.core.practitioner.PractitionerQualification

Bases: BackboneElement

The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	List[Identifier] | None	An identifier for this qualification for the practitioner	None
code	CodeableConcept | None	Coded representation of the qualification	None
period	Period | None	Period during which the qualification is valid	None
issuer	Reference | None	Organization that regulates and issues the qualification	None

PractitionerRole

Path: fhircraft.fhir.resources.datatypes.R4.core.practitioner_role.PractitionerRole

Bases: DomainResource

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/PractitionerRole'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifiers that are specific to a role/location	None
active	Boolean | None	Whether this practitioner role record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
period	Period | None	The period during which the practitioner is authorized to perform in these role(s)	None
practitioner	Reference | None	Practitioner that is able to provide the defined services for the organization	None
organization	Reference | None	Organization where the roles are available	None
code	List[CodeableConcept] | None	Roles which this practitioner may perform	None
specialty	List[CodeableConcept] | None	Specific specialty of the practitioner	None
location	List[Reference] | None	The location(s) at which this practitioner provides care	None
healthcareService	List[Reference] | None	The list of healthcare services that this worker provides for this role's Organization/Location(s)	None
telecom	List[ContactPoint] | None	Contact details that are specific to the role/location/service	None
availableTime	List[PractitionerRoleAvailableTime] | None	Times the Service Site is available	None
notAvailable	List[PractitionerRoleNotAvailable] | None	Not available during this time due to provided reason	None
availabilityExceptions	String | None	Description of availability exceptions	None
availabilityExceptions_ext	Element | None	Placeholder element for availabilityExceptions extensions	None
endpoint	List[Reference] | None	Technical endpoints providing access to services operated for the practitioner with this role	None
resourceType	Literal['PractitionerRole']		'PractitionerRole'

PractitionerRoleAvailableTime

Path: fhircraft.fhir.resources.datatypes.R4.core.practitioner_role.PractitionerRoleAvailableTime

Bases: BackboneElement

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
daysOfWeek	List[Code] | None	mon | tue | wed | thu | fri | sat | sun	None
daysOfWeek_ext	Element | None	Placeholder element for daysOfWeek extensions	None
allDay	Boolean | None	Always available? e.g. 24 hour service	None
allDay_ext	Element | None	Placeholder element for allDay extensions	None
availableStartTime	Time | None	Opening time of day (ignored if allDay = true)	None
availableStartTime_ext	Element | None	Placeholder element for availableStartTime extensions	None
availableEndTime	Time | None	Closing time of day (ignored if allDay = true)	None
availableEndTime_ext	Element | None	Placeholder element for availableEndTime extensions	None

PractitionerRoleNotAvailable

Path: fhircraft.fhir.resources.datatypes.R4.core.practitioner_role.PractitionerRoleNotAvailable

Bases: BackboneElement

The practitioner is not available or performing this role during this period of time due to the provided reason.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Reason presented to the user explaining why time not available	None
description_ext	Element | None	Placeholder element for description extensions	None
during	Period | None	Service not available from this date	None

Procedure

Path: fhircraft.fhir.resources.datatypes.R4.core.procedure.Procedure

Bases: DomainResource

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Procedure'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Identifiers for this procedure	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	A request for this procedure	None
partOf	List[Reference] | None	Part of referenced event	None
status	Code | None	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason for current status	None
category	CodeableConcept | None	Classification of the procedure	None
code	CodeableConcept | None	Identification of the procedure	None
subject	Reference | None	Who the procedure was performed on	None
encounter	Reference | None	Encounter created as part of	None
performedDateTime	DateTime | None	When the procedure was performed	None
performedDateTime_ext	Element | None	Placeholder element for performedDateTime extensions	None
performedPeriod	Period | None	When the procedure was performed	None
performedString	String | None	When the procedure was performed	None
performedString_ext	Element | None	Placeholder element for performedString extensions	None
performedAge	Age | None	When the procedure was performed	None
performedRange	Range | None	When the procedure was performed	None
recorder	Reference | None	Who recorded the procedure	None
asserter	Reference | None	Person who asserts this procedure	None
performer	List[ProcedurePerformer] | None	The people who performed the procedure	None
location	Reference | None	Where the procedure happened	None
reasonCode	List[CodeableConcept] | None	Coded reason procedure performed	None
reasonReference	List[Reference] | None	The justification that the procedure was performed	None
bodySite	List[CodeableConcept] | None	Target body sites	None
outcome	CodeableConcept | None	The result of procedure	None
report	List[Reference] | None	Any report resulting from the procedure	None
complication	List[CodeableConcept] | None	Complication following the procedure	None
complicationDetail	List[Reference] | None	A condition that is a result of the procedure	None
followUp	List[CodeableConcept] | None	Instructions for follow up	None
note	List[Annotation] | None	Additional information about the procedure	None
focalDevice	List[ProcedureFocalDevice] | None	Manipulated, implanted, or removed device	None
usedReference	List[Reference] | None	Items used during procedure	None
usedCode	List[CodeableConcept] | None	Coded items used during the procedure	None
resourceType	Literal['Procedure']		'Procedure'

ProcedureFocalDevice

Path: fhircraft.fhir.resources.datatypes.R4.core.procedure.ProcedureFocalDevice

Bases: BackboneElement

A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
action	CodeableConcept | None	Kind of change to device	None
manipulated	Reference | None	Device that was changed	None

ProcedurePerformer

Path: fhircraft.fhir.resources.datatypes.R4.core.procedure.ProcedurePerformer

Bases: BackboneElement

Limited to "real" people rather than equipment.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
function	CodeableConcept | None	Type of performance	None
actor	Reference | None	The reference to the practitioner	None
onBehalfOf	Reference | None	Organization the device or practitioner was acting for	None

Provenance

Path: fhircraft.fhir.resources.datatypes.R4.core.provenance.Provenance

Bases: DomainResource

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Provenance'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
target	List[Reference] | None	Target Reference(s) (usually version specific)	None
occurredPeriod	Period | None	When the activity occurred	None
occurredDateTime	DateTime | None	When the activity occurred	None
occurredDateTime_ext	Element | None	Placeholder element for occurredDateTime extensions	None
recorded	Instant | None	When the activity was recorded / updated	None
recorded_ext	Element | None	Placeholder element for recorded extensions	None
policy	List[Uri] | None	Policy or plan the activity was defined by	None
policy_ext	Element | None	Placeholder element for policy extensions	None
location	Reference | None	Where the activity occurred, if relevant	None
reason	List[CodeableConcept] | None	Reason the activity is occurring	None
activity	CodeableConcept | None	Activity that occurred	None
agent	List[ProvenanceAgent] | None	Actor involved	None
entity	List[ProvenanceEntity] | None	An entity used in this activity	None
signature	List[Signature] | None	Signature on target	None
resourceType	Literal['Provenance']		'Provenance'

ProvenanceAgent

Path: fhircraft.fhir.resources.datatypes.R4.core.provenance.ProvenanceAgent

Bases: BackboneElement

An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	How the agent participated	None
role	List[CodeableConcept] | None	What the agents role was	None
who	Reference | None	Who participated	None
onBehalfOf	Reference | None	Who the agent is representing	None

ProvenanceEntity

Path: fhircraft.fhir.resources.datatypes.R4.core.provenance.ProvenanceEntity

Bases: BackboneElement

An entity used in this activity.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
role	Code | None	derivation | revision | quotation | source | removal	None
role_ext	Element | None	Placeholder element for role extensions	None
what	Reference | None	Identity of entity	None
agent	List[ProvenanceEntityAgent] | None	Entity is attributed to this agent	None

ProvenanceEntityAgent

Path: fhircraft.fhir.resources.datatypes.R4.core.provenance.ProvenanceEntityAgent

Bases: BackboneElement

The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	How the agent participated	None
role	List[CodeableConcept] | None	What the agents role was	None
who	Reference | None	Who participated	None
onBehalfOf	Reference | None	Who the agent is representing	None

Questionnaire

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire.Questionnaire

Bases: DomainResource

A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Questionnaire'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this questionnaire, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the questionnaire	None
version	String | None	Business version of the questionnaire	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this questionnaire (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this questionnaire (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
derivedFrom	List[Canonical] | None	Instantiates protocol or definition	None
derivedFrom_ext	Element | None	Placeholder element for derivedFrom extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
subjectType	List[Code] | None	Resource that can be subject of QuestionnaireResponse	None
subjectType_ext	Element | None	Placeholder element for subjectType extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the questionnaire	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for questionnaire (if applicable)	None
purpose	Markdown | None	Why this questionnaire is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the questionnaire was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the questionnaire was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the questionnaire is expected to be used	None
code	List[Coding] | None	Concept that represents the overall questionnaire	None
item	List[QuestionnaireItem] | None	Questions and sections within the Questionnaire	None
resourceType	Literal['Questionnaire']		'Questionnaire'

QuestionnaireItem

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire.QuestionnaireItem

Bases: BackboneElement

A particular question, question grouping or display text that is part of the questionnaire.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
linkId	String | None	Unique id for item in questionnaire	None
linkId_ext	Element | None	Placeholder element for linkId extensions	None
definition	Uri | None	ElementDefinition - details for the item	None
definition_ext	Element | None	Placeholder element for definition extensions	None
code	List[Coding] | None	Corresponding concept for this item in a terminology	None
prefix	String | None	E.g. "1(a)", "2.5.3"	None
prefix_ext	Element | None	Placeholder element for prefix extensions	None
text	String | None	Primary text for the item	None
text_ext	Element | None	Placeholder element for text extensions	None
type	Code | None	group | display | boolean | decimal | integer | date | dateTime +	None
type_ext	Element | None	Placeholder element for type extensions	None
enableWhen	List[QuestionnaireItemEnableWhen] | None	Only allow data when	None
enableBehavior	Code | None	all | any	None
enableBehavior_ext	Element | None	Placeholder element for enableBehavior extensions	None
required	Boolean | None	Whether the item must be included in data results	None
required_ext	Element | None	Placeholder element for required extensions	None
repeats	Boolean | None	Whether the item may repeat	None
repeats_ext	Element | None	Placeholder element for repeats extensions	None
readOnly	Boolean | None	Don't allow human editing	None
readOnly_ext	Element | None	Placeholder element for readOnly extensions	None
maxLength	Integer | None	No more than this many characters	None
maxLength_ext	Element | None	Placeholder element for maxLength extensions	None
answerValueSet	Canonical | None	Valueset containing permitted answers	None
answerValueSet_ext	Element | None	Placeholder element for answerValueSet extensions	None
answerOption	List[QuestionnaireItemAnswerOption] | None	Permitted answer	None
initial	List[QuestionnaireItemInitial] | None	Initial value(s) when item is first rendered	None
item	List[QuestionnaireItem] | None	Nested questionnaire items	None

QuestionnaireItemAnswerOption

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire.QuestionnaireItemAnswerOption

Bases: BackboneElement

One of the permitted answers for a "choice" or "open-choice" question.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueInteger	Integer | None	Answer value	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueDate	Date | None	Answer value	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueTime	Time | None	Answer value	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueString	String | None	Answer value	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueCoding	Coding | None	Answer value	None
valueReference	Reference | None	Answer value	None
initialSelected	Boolean | None	Whether option is selected by default	None
initialSelected_ext	Element | None	Placeholder element for initialSelected extensions	None

QuestionnaireItemEnableWhen

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire.QuestionnaireItemEnableWhen

Bases: BackboneElement

A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
question	String | None	Question that determines whether item is enabled	None
question_ext	Element | None	Placeholder element for question extensions	None
operator	Code | None	exists | = | != | > | < | >= | <=	None
operator_ext	Element | None	Placeholder element for operator extensions	None
answerBoolean	Boolean | None	Value for question comparison based on operator	None
answerBoolean_ext	Element | None	Placeholder element for answerBoolean extensions	None
answerDecimal	Decimal | None	Value for question comparison based on operator	None
answerDecimal_ext	Element | None	Placeholder element for answerDecimal extensions	None
answerInteger	Integer | None	Value for question comparison based on operator	None
answerInteger_ext	Element | None	Placeholder element for answerInteger extensions	None
answerDate	Date | None	Value for question comparison based on operator	None
answerDate_ext	Element | None	Placeholder element for answerDate extensions	None
answerDateTime	DateTime | None	Value for question comparison based on operator	None
answerDateTime_ext	Element | None	Placeholder element for answerDateTime extensions	None
answerTime	Time | None	Value for question comparison based on operator	None
answerTime_ext	Element | None	Placeholder element for answerTime extensions	None
answerString	String | None	Value for question comparison based on operator	None
answerString_ext	Element | None	Placeholder element for answerString extensions	None
answerCoding	Coding | None	Value for question comparison based on operator	None
answerQuantity	Quantity | None	Value for question comparison based on operator	None
answerReference	Reference | None	Value for question comparison based on operator	None

QuestionnaireItemInitial

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire.QuestionnaireItemInitial

Bases: BackboneElement

One or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueBoolean	Boolean | None	Actual value for initializing the question	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueDecimal	Decimal | None	Actual value for initializing the question	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueInteger	Integer | None	Actual value for initializing the question	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueDate	Date | None	Actual value for initializing the question	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueDateTime	DateTime | None	Actual value for initializing the question	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueTime	Time | None	Actual value for initializing the question	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueString	String | None	Actual value for initializing the question	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueUri	Uri | None	Actual value for initializing the question	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueAttachment	Attachment | None	Actual value for initializing the question	None
valueCoding	Coding | None	Actual value for initializing the question	None
valueQuantity	Quantity | None	Actual value for initializing the question	None
valueReference	Reference | None	Actual value for initializing the question	None

QuestionnaireResponse

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire_response.QuestionnaireResponse

Bases: DomainResource

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.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	Identifier | None	Unique id for this set of answers	None
basedOn	List[Reference] | None	Request fulfilled by this QuestionnaireResponse	None
partOf	List[Reference] | None	Part of this action	None
questionnaire	Canonical | None	Form being answered	None
questionnaire_ext	Element | None	Placeholder element for questionnaire extensions	None
status	Code | None	in-progress | completed | amended | entered-in-error | stopped	None
status_ext	Element | None	Placeholder element for status extensions	None
subject	Reference | None	The subject of the questions	None
encounter	Reference | None	Encounter created as part of	None
authored	DateTime | None	Date the answers were gathered	None
authored_ext	Element | None	Placeholder element for authored extensions	None
author	Reference | None	Person who received and recorded the answers	None
source	Reference | None	The person who answered the questions	None
item	List[QuestionnaireResponseItem] | None	Groups and questions	None
resourceType	Literal['QuestionnaireResponse']		'QuestionnaireResponse'

QuestionnaireResponseItem

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire_response.QuestionnaireResponseItem

Bases: BackboneElement

A group or question item from the original questionnaire for which answers are provided.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
linkId	String | None	Pointer to specific item from Questionnaire	None
linkId_ext	Element | None	Placeholder element for linkId extensions	None
definition	Uri | None	ElementDefinition - details for the item	None
definition_ext	Element | None	Placeholder element for definition extensions	None
text	String | None	Name for group or question text	None
text_ext	Element | None	Placeholder element for text extensions	None
answer	List[QuestionnaireResponseItemAnswer] | None	The response(s) to the question	None
item	List[QuestionnaireResponseItem] | None	Nested questionnaire response items	None

QuestionnaireResponseItemAnswer

Path: fhircraft.fhir.resources.datatypes.R4.core.questionnaire_response.QuestionnaireResponseItemAnswer

Bases: BackboneElement

The respondent's answer(s) to the question.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueBoolean	Boolean | None	Single-valued answer to the question	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueDecimal	Decimal | None	Single-valued answer to the question	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueInteger	Integer | None	Single-valued answer to the question	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueDate	Date | None	Single-valued answer to the question	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueDateTime	DateTime | None	Single-valued answer to the question	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueTime	Time | None	Single-valued answer to the question	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueString	String | None	Single-valued answer to the question	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueUri	Uri | None	Single-valued answer to the question	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueAttachment	Attachment | None	Single-valued answer to the question	None
valueCoding	Coding | None	Single-valued answer to the question	None
valueQuantity	Quantity | None	Single-valued answer to the question	None
valueReference	Reference | None	Single-valued answer to the question	None
item	List[QuestionnaireResponseItem] | None	Nested groups and questions	None

RelatedPerson

Path: fhircraft.fhir.resources.datatypes.R4.core.related_person.RelatedPerson

Bases: DomainResource

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/RelatedPerson'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	A human identifier for this person	None
active	Boolean | None	Whether this related person's record is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
patient	Reference | None	The patient this person is related to	None
relationship	List[CodeableConcept] | None	The nature of the relationship	None
name	List[HumanName] | None	A name associated with the person	None
telecom	List[ContactPoint] | None	A contact detail for the person	None
gender	Code | None	male | female | other | unknown	None
gender_ext	Element | None	Placeholder element for gender extensions	None
birthDate	Date | None	The date on which the related person was born	None
birthDate_ext	Element | None	Placeholder element for birthDate extensions	None
address	List[Address] | None	Address where the related person can be contacted or visited	None
photo	List[Attachment] | None	Image of the person	None
period	Period | None	Period of time that this relationship is considered valid	None
communication	List[RelatedPersonCommunication] | None	A language which may be used to communicate with about the patient's health	None
resourceType	Literal['RelatedPerson']		'RelatedPerson'

RelatedPersonCommunication

Path: fhircraft.fhir.resources.datatypes.R4.core.related_person.RelatedPersonCommunication

Bases: BackboneElement

A language which may be used to communicate with about the patient's health.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
language	CodeableConcept | None	The language which can be used to communicate with the patient about his or her health	None
preferred	Boolean | None	Language preference indicator	None
preferred_ext	Element | None	Placeholder element for preferred extensions	None

RequestGroup

Path: fhircraft.fhir.resources.datatypes.R4.core.request_group.RequestGroup

Bases: DomainResource

A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/RequestGroup'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business identifier	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	Fulfills plan, proposal, or order	None
replaces	List[Reference] | None	Request(s) replaced by this request	None
groupIdentifier	Identifier | None	Composite request this is part of	None
status	Code | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
intent	Code | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
code	CodeableConcept | None	What's being requested/ordered	None
subject	Reference | None	Who the request group is about	None
encounter	Reference | None	Created as part of	None
authoredOn	DateTime | None	When the request group was authored	None
authoredOn_ext	Element | None	Placeholder element for authoredOn extensions	None
author	Reference | None	Device or practitioner that authored the request group	None
reasonCode	List[CodeableConcept] | None	Why the request group is needed	None
reasonReference	List[Reference] | None	Why the request group is needed	None
note	List[Annotation] | None	Additional notes about the response	None
action	List[RequestGroupAction] | None	Proposed actions, if any	None
resourceType	Literal['RequestGroup']		'RequestGroup'

RequestGroupAction

Path: fhircraft.fhir.resources.datatypes.R4.core.request_group.RequestGroupAction

Bases: BackboneElement

The actions, if any, produced by the evaluation of the artifact.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
prefix	String | None	User-visible prefix for the action (e.g. 1. or A.)	None
prefix_ext	Element | None	Placeholder element for prefix extensions	None
title	String | None	User-visible title	None
title_ext	Element | None	Placeholder element for title extensions	None
description	String | None	Short description of the action	None
description_ext	Element | None	Placeholder element for description extensions	None
textEquivalent	String | None	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system	None
textEquivalent_ext	Element | None	Placeholder element for textEquivalent extensions	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
code	List[CodeableConcept] | None	Code representing the meaning of the action or sub-actions	None
documentation	List[RelatedArtifact] | None	Supporting documentation for the intended performer of the action	None
condition	List[RequestGroupActionCondition] | None	Whether or not the action is applicable	None
relatedAction	List[RequestGroupActionRelatedAction] | None	Relationship to another action	None
timingDateTime	DateTime | None	When the action should take place	None
timingDateTime_ext	Element | None	Placeholder element for timingDateTime extensions	None
timingAge	Age | None	When the action should take place	None
timingPeriod	Period | None	When the action should take place	None
timingDuration	Duration | None	When the action should take place	None
timingRange	Range | None	When the action should take place	None
timingTiming	Timing | None	When the action should take place	None
participant	List[Reference] | None	Who should perform the action	None
type	CodeableConcept | None	create | update | remove | fire-event	None
groupingBehavior	Code | None	visual-group | logical-group | sentence-group	None
groupingBehavior_ext	Element | None	Placeholder element for groupingBehavior extensions	None
selectionBehavior	Code | None	any | all | all-or-none | exactly-one | at-most-one | one-or-more	None
selectionBehavior_ext	Element | None	Placeholder element for selectionBehavior extensions	None
requiredBehavior	Code | None	must | could | must-unless-documented	None
requiredBehavior_ext	Element | None	Placeholder element for requiredBehavior extensions	None
precheckBehavior	Code | None	yes | no	None
precheckBehavior_ext	Element | None	Placeholder element for precheckBehavior extensions	None
cardinalityBehavior	Code | None	single | multiple	None
cardinalityBehavior_ext	Element | None	Placeholder element for cardinalityBehavior extensions	None
resource	Reference | None	The target of the action	None
action	List[RequestGroupAction] | None	Sub action	None

RequestGroupActionCondition

Path: fhircraft.fhir.resources.datatypes.R4.core.request_group.RequestGroupActionCondition

Bases: BackboneElement

An expression that describes applicability criteria, or start/stop conditions for the action.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
kind	Code | None	applicability | start | stop	None
kind_ext	Element | None	Placeholder element for kind extensions	None
expression	Expression | None	Boolean-valued expression	None

RequestGroupActionRelatedAction

Path: fhircraft.fhir.resources.datatypes.R4.core.request_group.RequestGroupActionRelatedAction

Bases: BackboneElement

A relationship to another action such as "before" or "30-60 minutes after start of".

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
actionId	Id | None	What action this is related to	None
actionId_ext	Element | None	Placeholder element for actionId extensions	None
relationship	Code | None	before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end	None
relationship_ext	Element | None	Placeholder element for relationship extensions	None
offsetDuration	Duration | None	Time offset for the relationship	None
offsetRange	Range | None	Time offset for the relationship	None

ResearchDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.research_definition.ResearchDefinition

Bases: DomainResource

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ResearchDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this research definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the research definition	None
version	String | None	Business version of the research definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this research definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this research definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
shortTitle	String | None	Title for use in informal contexts	None
shortTitle_ext	Element | None	Placeholder element for shortTitle extensions	None
subtitle	String | None	Subordinate title of the ResearchDefinition	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
subjectCodeableConcept	CodeableConcept | None	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device	None
subjectReference	Reference | None	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the research definition	None
description_ext	Element | None	Placeholder element for description extensions	None
comment	List[String] | None	Used for footnotes or explanatory notes	None
comment_ext	Element | None	Placeholder element for comment extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for research definition (if applicable)	None
purpose	Markdown | None	Why this research definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
usage	String | None	Describes the clinical usage of the ResearchDefinition	None
usage_ext	Element | None	Placeholder element for usage extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the research definition was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the research definition was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the research definition is expected to be used	None
topic	List[CodeableConcept] | None	The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
library	List[Canonical] | None	Logic used by the ResearchDefinition	None
library_ext	Element | None	Placeholder element for library extensions	None
population	Reference | None	What population?	None
exposure	Reference | None	What exposure?	None
exposureAlternative	Reference | None	What alternative exposure state?	None
outcome	Reference | None	What outcome?	None
resourceType	Literal['ResearchDefinition']		'ResearchDefinition'

ResearchElementDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.research_element_definition.ResearchElementDefinition

Bases: DomainResource

The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this research element definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the research element definition	None
version	String | None	Business version of the research element definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this research element definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this research element definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
shortTitle	String | None	Title for use in informal contexts	None
shortTitle_ext	Element | None	Placeholder element for shortTitle extensions	None
subtitle	String | None	Subordinate title of the ResearchElementDefinition	None
subtitle_ext	Element | None	Placeholder element for subtitle extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
subjectCodeableConcept	CodeableConcept | None	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device	None
subjectReference	Reference | None	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the research element definition	None
description_ext	Element | None	Placeholder element for description extensions	None
comment	List[String] | None	Used for footnotes or explanatory notes	None
comment_ext	Element | None	Placeholder element for comment extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for research element definition (if applicable)	None
purpose	Markdown | None	Why this research element definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
usage	String | None	Describes the clinical usage of the ResearchElementDefinition	None
usage_ext	Element | None	Placeholder element for usage extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the research element definition was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the research element definition was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the research element definition is expected to be used	None
topic	List[CodeableConcept] | None	The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
library	List[Canonical] | None	Logic used by the ResearchElementDefinition	None
library_ext	Element | None	Placeholder element for library extensions	None
type	Code | None	population | exposure | outcome	None
type_ext	Element | None	Placeholder element for type extensions	None
variableType	Code | None	dichotomous | continuous | descriptive	None
variableType_ext	Element | None	Placeholder element for variableType extensions	None
characteristic	List[ResearchElementDefinitionCharacteristic] | None	What defines the members of the research element	None
resourceType	Literal['ResearchElementDefinition']		'ResearchElementDefinition'

ResearchElementDefinitionCharacteristic

Path: fhircraft.fhir.resources.datatypes.R4.core.research_element_definition.ResearchElementDefinitionCharacteristic

Bases: BackboneElement

A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
definitionCodeableConcept	CodeableConcept | None	What code or expression defines members?	None
definitionCanonical	Canonical | None	What code or expression defines members?	None
definitionCanonical_ext	Element | None	Placeholder element for definitionCanonical extensions	None
definitionExpression	Expression | None	What code or expression defines members?	None
definitionDataRequirement	DataRequirement | None	What code or expression defines members?	None
usageContext	List[UsageContext] | None	What code/value pairs define members?	None
exclude	Boolean | None	Whether the characteristic includes or excludes members	None
exclude_ext	Element | None	Placeholder element for exclude extensions	None
unitOfMeasure	CodeableConcept | None	What unit is the outcome described in?	None
studyEffectiveDescription	String | None	What time period does the study cover	None
studyEffectiveDescription_ext	Element | None	Placeholder element for studyEffectiveDescription extensions	None
studyEffectiveDateTime	DateTime | None	What time period does the study cover	None
studyEffectiveDateTime_ext	Element | None	Placeholder element for studyEffectiveDateTime extensions	None
studyEffectivePeriod	Period | None	What time period does the study cover	None
studyEffectiveDuration	Duration | None	What time period does the study cover	None
studyEffectiveTiming	Timing | None	What time period does the study cover	None
studyEffectiveTimeFromStart	Duration | None	Observation time from study start	None
studyEffectiveGroupMeasure	Code | None	mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median	None
studyEffectiveGroupMeasure_ext	Element | None	Placeholder element for studyEffectiveGroupMeasure extensions	None
participantEffectiveDescription	String | None	What time period do participants cover	None
participantEffectiveDescription_ext	Element | None	Placeholder element for participantEffectiveDescription extensions	None
participantEffectiveDateTime	DateTime | None	What time period do participants cover	None
participantEffectiveDateTime_ext	Element | None	Placeholder element for participantEffectiveDateTime extensions	None
participantEffectivePeriod	Period | None	What time period do participants cover	None
participantEffectiveDuration	Duration | None	What time period do participants cover	None
participantEffectiveTiming	Timing | None	What time period do participants cover	None
participantEffectiveTimeFromStart	Duration | None	Observation time from study start	None
participantEffectiveGroupMeasure	Code | None	mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median	None
participantEffectiveGroupMeasure_ext	Element | None	Placeholder element for participantEffectiveGroupMeasure extensions	None

ResearchStudy

Path: fhircraft.fhir.resources.datatypes.R4.core.research_study.ResearchStudy

Bases: DomainResource

A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ResearchStudy'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for study	None
title	String | None	Name for this study	None
title_ext	Element | None	Placeholder element for title extensions	None
protocol	List[Reference] | None	Steps followed in executing study	None
partOf	List[Reference] | None	Part of larger study	None
status	Code | None	active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn	None
status_ext	Element | None	Placeholder element for status extensions	None
primaryPurposeType	CodeableConcept | None	treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility	None
phase	CodeableConcept | None	n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4	None
category	List[CodeableConcept] | None	Classifications for the study	None
focus	List[CodeableConcept] | None	Drugs, devices, etc. under study	None
condition	List[CodeableConcept] | None	Condition being studied	None
contact	List[ContactDetail] | None	Contact details for the study	None
relatedArtifact	List[RelatedArtifact] | None	References and dependencies	None
keyword	List[CodeableConcept] | None	Used to search for the study	None
location	List[CodeableConcept] | None	Geographic region(s) for study	None
description	Markdown | None	What this is study doing	None
description_ext	Element | None	Placeholder element for description extensions	None
enrollment	List[Reference] | None	Inclusion & exclusion criteria	None
period	Period | None	When the study began and ended	None
sponsor	Reference | None	Organization that initiates and is legally responsible for the study	None
principalInvestigator	Reference | None	Researcher who oversees multiple aspects of the study	None
site	List[Reference] | None	Facility where study activities are conducted	None
reasonStopped	CodeableConcept | None	accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design	None
note	List[Annotation] | None	Comments made about the study	None
arm	List[ResearchStudyArm] | None	Defined path through the study for a subject	None
objective	List[ResearchStudyObjective] | None	A goal for the study	None
resourceType	Literal['ResearchStudy']		'ResearchStudy'

ResearchStudyArm

Path: fhircraft.fhir.resources.datatypes.R4.core.research_study.ResearchStudyArm

Bases: BackboneElement

Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Label for study arm	None
name_ext	Element | None	Placeholder element for name extensions	None
type	CodeableConcept | None	Categorization of study arm	None
description	String | None	Short explanation of study path	None
description_ext	Element | None	Placeholder element for description extensions	None

ResearchStudyObjective

Path: fhircraft.fhir.resources.datatypes.R4.core.research_study.ResearchStudyObjective

Bases: BackboneElement

A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Label for the objective	None
name_ext	Element | None	Placeholder element for name extensions	None
type	CodeableConcept | None	primary | secondary | exploratory	None

ResearchSubject

Path: fhircraft.fhir.resources.datatypes.R4.core.research_subject.ResearchSubject

Bases: DomainResource

A physical entity which is the primary unit of operational and/or administrative interest in a study.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ResearchSubject'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for research subject in a study	None
status	Code | None	candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn	None
status_ext	Element | None	Placeholder element for status extensions	None
period	Period | None	Start and end of participation	None
study	Reference | None	Study subject is part of	None
individual	Reference | None	Who is part of study	None
assignedArm	String | None	What path should be followed	None
assignedArm_ext	Element | None	Placeholder element for assignedArm extensions	None
actualArm	String | None	What path was followed	None
actualArm_ext	Element | None	Placeholder element for actualArm extensions	None
consent	Reference | None	Agreement to participate in study	None
resourceType	Literal['ResearchSubject']		'ResearchSubject'

Resource

Path: fhircraft.fhir.resources.datatypes.R4.core.resource.Resource

Bases: FHIRBaseModel

This is the base resource type for everything.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Resource'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
resourceType	Literal['Resource']		'Resource'

RiskAssessment

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_assessment.RiskAssessment

Bases: DomainResource

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/RiskAssessment'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique identifier for the assessment	None
basedOn	Reference | None	Request fulfilled by this assessment	None
parent	Reference | None	Part of this occurrence	None
status	Code | None	registered | preliminary | final | amended +	None
status_ext	Element | None	Placeholder element for status extensions	None
method	CodeableConcept | None	Evaluation mechanism	None
code	CodeableConcept | None	Type of assessment	None
subject	Reference | None	Who/what does assessment apply to?	None
encounter	Reference | None	Where was assessment performed?	None
occurrenceDateTime	DateTime | None	When was assessment made?	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	When was assessment made?	None
condition	Reference | None	Condition assessed	None
performer	Reference | None	Who did assessment?	None
reasonCode	List[CodeableConcept] | None	Why the assessment was necessary?	None
reasonReference	List[Reference] | None	Why the assessment was necessary?	None
basis	List[Reference] | None	Information used in assessment	None
prediction	List[RiskAssessmentPrediction] | None	Outcome predicted	None
mitigation	String | None	How to reduce risk	None
mitigation_ext	Element | None	Placeholder element for mitigation extensions	None
note	List[Annotation] | None	Comments on the risk assessment	None
resourceType	Literal['RiskAssessment']		'RiskAssessment'

RiskAssessmentPrediction

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_assessment.RiskAssessmentPrediction

Bases: BackboneElement

Describes the expected outcome for the subject.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
outcome	CodeableConcept | None	Possible outcome for the subject	None
probabilityDecimal	Decimal | None	Likelihood of specified outcome	None
probabilityDecimal_ext	Element | None	Placeholder element for probabilityDecimal extensions	None
probabilityRange	Range | None	Likelihood of specified outcome	None
qualitativeRisk	CodeableConcept | None	Likelihood of specified outcome as a qualitative value	None
relativeRisk	Decimal | None	Relative likelihood	None
relativeRisk_ext	Element | None	Placeholder element for relativeRisk extensions	None
whenPeriod	Period | None	Timeframe or age range	None
whenRange	Range | None	Timeframe or age range	None
rationale	String | None	Explanation of prediction	None
rationale_ext	Element | None	Placeholder element for rationale extensions	None

RiskEvidenceSynthesis

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_evidence_synthesis.RiskEvidenceSynthesis

Bases: DomainResource

The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the risk evidence synthesis	None
version	String | None	Business version of the risk evidence synthesis	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this risk evidence synthesis (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this risk evidence synthesis (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the risk evidence synthesis	None
description_ext	Element | None	Placeholder element for description extensions	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for risk evidence synthesis (if applicable)	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
approvalDate	Date | None	When the risk evidence synthesis was approved by publisher	None
approvalDate_ext	Element | None	Placeholder element for approvalDate extensions	None
lastReviewDate	Date | None	When the risk evidence synthesis was last reviewed	None
lastReviewDate_ext	Element | None	Placeholder element for lastReviewDate extensions	None
effectivePeriod	Period | None	When the risk evidence synthesis is expected to be used	None
topic	List[CodeableConcept] | None	The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.	None
author	List[ContactDetail] | None	Who authored the content	None
editor	List[ContactDetail] | None	Who edited the content	None
reviewer	List[ContactDetail] | None	Who reviewed the content	None
endorser	List[ContactDetail] | None	Who endorsed the content	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc.	None
synthesisType	CodeableConcept | None	Type of synthesis	None
studyType	CodeableConcept | None	Type of study	None
population	Reference | None	What population?	None
exposure	Reference | None	What exposure?	None
outcome	Reference | None	What outcome?	None
sampleSize	RiskEvidenceSynthesisSampleSize | None	What sample size was involved?	None
riskEstimate	RiskEvidenceSynthesisRiskEstimate | None	What was the estimated risk	None
certainty	List[RiskEvidenceSynthesisCertainty] | None	How certain is the risk	None
resourceType	Literal['RiskEvidenceSynthesis']		'RiskEvidenceSynthesis'

RiskEvidenceSynthesisCertainty

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_evidence_synthesis.RiskEvidenceSynthesisCertainty

Bases: BackboneElement

A description of the certainty of the risk estimate.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
rating	List[CodeableConcept] | None	Certainty rating	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
certaintySubcomponent	List[RiskEvidenceSynthesisCertaintyCertaintySubcomponent] | None	A component that contributes to the overall certainty	None

RiskEvidenceSynthesisCertaintyCertaintySubcomponent

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_evidence_synthesis.RiskEvidenceSynthesisCertaintyCertaintySubcomponent

Bases: BackboneElement

A description of a component of the overall certainty.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of subcomponent of certainty rating	None
rating	List[CodeableConcept] | None	Subcomponent certainty rating	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None

RiskEvidenceSynthesisRiskEstimate

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_evidence_synthesis.RiskEvidenceSynthesisRiskEstimate

Bases: BackboneElement

The estimated risk of the outcome.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of risk estimate	None
description_ext	Element | None	Placeholder element for description extensions	None
type	CodeableConcept | None	Type of risk estimate	None
value	Decimal | None	Point estimate	None
value_ext	Element | None	Placeholder element for value extensions	None
unitOfMeasure	CodeableConcept | None	What unit is the outcome described in?	None
denominatorCount	Integer | None	Sample size for group measured	None
denominatorCount_ext	Element | None	Placeholder element for denominatorCount extensions	None
numeratorCount	Integer | None	Number with the outcome	None
numeratorCount_ext	Element | None	Placeholder element for numeratorCount extensions	None
precisionEstimate	List[RiskEvidenceSynthesisRiskEstimatePrecisionEstimate] | None	How precise the estimate is	None

RiskEvidenceSynthesisRiskEstimatePrecisionEstimate

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_evidence_synthesis.RiskEvidenceSynthesisRiskEstimatePrecisionEstimate

Bases: BackboneElement

A description of the precision of the estimate for the effect.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Type of precision estimate	None
level	Decimal | None	Level of confidence interval	None
level_ext	Element | None	Placeholder element for level extensions	None
from_	Decimal | None	Lower bound	None
from_ext	Element | None	Placeholder element for from extensions	None
to	Decimal | None	Upper bound	None
to_ext	Element | None	Placeholder element for to extensions	None

RiskEvidenceSynthesisSampleSize

Path: fhircraft.fhir.resources.datatypes.R4.core.risk_evidence_synthesis.RiskEvidenceSynthesisSampleSize

Bases: BackboneElement

A description of the size of the sample involved in the synthesis.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Description of sample size	None
description_ext	Element | None	Placeholder element for description extensions	None
numberOfStudies	Integer | None	How many studies?	None
numberOfStudies_ext	Element | None	Placeholder element for numberOfStudies extensions	None
numberOfParticipants	Integer | None	How many participants?	None
numberOfParticipants_ext	Element | None	Placeholder element for numberOfParticipants extensions	None

Schedule

Path: fhircraft.fhir.resources.datatypes.R4.core.schedule.Schedule

Bases: DomainResource

A container for slots of time that may be available for booking appointments.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Schedule'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this item	None
active	Boolean | None	Whether this schedule is in active use	None
active_ext	Element | None	Placeholder element for active extensions	None
serviceCategory	List[CodeableConcept] | None	High-level category	None
serviceType	List[CodeableConcept] | None	Specific service	None
specialty	List[CodeableConcept] | None	Type of specialty needed	None
actor	List[Reference] | None	Resource(s) that availability information is being provided for	None
planningHorizon	Period | None	Period of time covered by schedule	None
comment	String | None	Comments on availability	None
comment_ext	Element | None	Placeholder element for comment extensions	None
resourceType	Literal['Schedule']		'Schedule'

SearchParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.search_parameter.SearchParameter

Bases: DomainResource

A search parameter that defines a named search item that can be used to search/filter on a resource.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SearchParameter'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this search parameter, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the search parameter	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this search parameter (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
derivedFrom	Canonical | None	Original definition for the search parameter	None
derivedFrom_ext	Element | None	Placeholder element for derivedFrom extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the search parameter	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for search parameter (if applicable)	None
purpose	Markdown | None	Why this search parameter is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
code	Code | None	Code used in URL	None
code_ext	Element | None	Placeholder element for code extensions	None
base	List[Code] | None	The resource type(s) this search parameter applies to	None
base_ext	Element | None	Placeholder element for base extensions	None
type	Code | None	number | date | string | token | reference | composite | quantity | uri | special	None
type_ext	Element | None	Placeholder element for type extensions	None
expression	String | None	FHIRPath expression that extracts the values	None
expression_ext	Element | None	Placeholder element for expression extensions	None
xpath	String | None	XPath that extracts the values	None
xpath_ext	Element | None	Placeholder element for xpath extensions	None
xpathUsage	Code | None	normal | phonetic | nearby | distance | other	None
xpathUsage_ext	Element | None	Placeholder element for xpathUsage extensions	None
target	List[Code] | None	Types of resource (if a resource reference)	None
target_ext	Element | None	Placeholder element for target extensions	None
multipleOr	Boolean | None	Allow multiple values per parameter (or)	None
multipleOr_ext	Element | None	Placeholder element for multipleOr extensions	None
multipleAnd	Boolean | None	Allow multiple parameters (and)	None
multipleAnd_ext	Element | None	Placeholder element for multipleAnd extensions	None
comparator	List[Code] | None	eq | ne | gt | lt | ge | le | sa | eb | ap	None
comparator_ext	Element | None	Placeholder element for comparator extensions	None
modifier	List[Code] | None	missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType	None
modifier_ext	Element | None	Placeholder element for modifier extensions	None
chain	List[String] | None	Chained names supported	None
chain_ext	Element | None	Placeholder element for chain extensions	None
component	List[SearchParameterComponent] | None	For Composite resources to define the parts	None
resourceType	Literal['SearchParameter']		'SearchParameter'

SearchParameterComponent

Path: fhircraft.fhir.resources.datatypes.R4.core.search_parameter.SearchParameterComponent

Bases: BackboneElement

Used to define the parts of a composite search parameter.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
definition	Canonical | None	Defines how the part works	None
definition_ext	Element | None	Placeholder element for definition extensions	None
expression	String | None	Subexpression relative to main expression	None
expression_ext	Element | None	Placeholder element for expression extensions	None

ServiceRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.service_request.ServiceRequest

Bases: DomainResource

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ServiceRequest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Identifiers assigned to this order	None
instantiatesCanonical	List[Canonical] | None	Instantiates FHIR protocol or definition	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	List[Uri] | None	Instantiates external protocol or definition	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	What request fulfills	None
replaces	List[Reference] | None	What request replaces	None
requisition	Identifier | None	Composite Request ID	None
status	Code | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
intent	Code | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
category	List[CodeableConcept] | None	Classification of service	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
doNotPerform	Boolean | None	True if service/procedure should not be performed	None
doNotPerform_ext	Element | None	Placeholder element for doNotPerform extensions	None
code	CodeableConcept | None	What is being requested/ordered	None
orderDetail	List[CodeableConcept] | None	Additional order information	None
quantityQuantity	Quantity | None	Service amount	None
quantityRatio	Ratio | None	Service amount	None
quantityRange	Range | None	Service amount	None
subject	Reference | None	Individual or Entity the service is ordered for	None
encounter	Reference | None	Encounter in which the request was created	None
occurrenceDateTime	DateTime | None	When service should occur	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	When service should occur	None
occurrenceTiming	Timing | None	When service should occur	None
asNeededBoolean	Boolean | None	Preconditions for service	None
asNeededBoolean_ext	Element | None	Placeholder element for asNeededBoolean extensions	None
asNeededCodeableConcept	CodeableConcept | None	Preconditions for service	None
authoredOn	DateTime | None	Date request signed	None
authoredOn_ext	Element | None	Placeholder element for authoredOn extensions	None
requester	Reference | None	Who/what is requesting service	None
performerType	CodeableConcept | None	Performer role	None
performer	List[Reference] | None	Requested performer	None
locationCode	List[CodeableConcept] | None	Requested location	None
locationReference	List[Reference] | None	Requested location	None
reasonCode	List[CodeableConcept] | None	Explanation/Justification for procedure or service	None
reasonReference	List[Reference] | None	Explanation/Justification for service or service	None
insurance	List[Reference] | None	Associated insurance coverage	None
supportingInfo	List[Reference] | None	Additional clinical information	None
specimen	List[Reference] | None	Procedure Samples	None
bodySite	List[CodeableConcept] | None	Location on Body	None
note	List[Annotation] | None	Comments	None
patientInstruction	String | None	Patient or consumer-oriented instructions	None
patientInstruction_ext	Element | None	Placeholder element for patientInstruction extensions	None
relevantHistory	List[Reference] | None	Request provenance	None
resourceType	Literal['ServiceRequest']		'ServiceRequest'

Slot

Path: fhircraft.fhir.resources.datatypes.R4.core.slot.Slot

Bases: DomainResource

A slot of time on a schedule that may be available for booking appointments.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Slot'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Ids for this item	None
serviceCategory	List[CodeableConcept] | None	A broad categorization of the service that is to be performed during this appointment	None
serviceType	List[CodeableConcept] | None	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource	None
specialty	List[CodeableConcept] | None	The specialty of a practitioner that would be required to perform the service requested in this appointment	None
appointmentType	CodeableConcept | None	The style of appointment or patient that may be booked in the slot (not service type)	None
schedule	Reference | None	The schedule resource that this slot defines an interval of status information	None
status	Code | None	busy | free | busy-unavailable | busy-tentative | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
start	Instant | None	Date/Time that the slot is to begin	None
start_ext	Element | None	Placeholder element for start extensions	None
end	Instant | None	Date/Time that the slot is to conclude	None
end_ext	Element | None	Placeholder element for end extensions	None
overbooked	Boolean | None	This slot has already been overbooked, appointments are unlikely to be accepted for this time	None
overbooked_ext	Element | None	Placeholder element for overbooked extensions	None
comment	String | None	Comments on the slot to describe any extended information. Such as custom constraints on the slot	None
comment_ext	Element | None	Placeholder element for comment extensions	None
resourceType	Literal['Slot']		'Slot'

Specimen

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen.Specimen

Bases: DomainResource

A sample to be used for analysis.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Specimen'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External Identifier	None
accessionIdentifier	Identifier | None	Identifier assigned by the lab	None
status	Code | None	available | unavailable | unsatisfactory | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
type	CodeableConcept | None	Kind of material that forms the specimen	None
subject	Reference | None	Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device	None
receivedTime	DateTime | None	The time when specimen was received for processing	None
receivedTime_ext	Element | None	Placeholder element for receivedTime extensions	None
parent	List[Reference] | None	Specimen from which this specimen originated	None
request	List[Reference] | None	Why the specimen was collected	None
collection	SpecimenCollection | None	Collection details	None
processing	List[SpecimenProcessing] | None	Processing and processing step details	None
container	List[SpecimenContainer] | None	Direct container of specimen (tube/slide, etc.)	None
condition	List[CodeableConcept] | None	State of the specimen	None
note	List[Annotation] | None	Comments	None
resourceType	Literal['Specimen']		'Specimen'

SpecimenCollection

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen.SpecimenCollection

Bases: BackboneElement

Details concerning the specimen collection.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
collector	Reference | None	Who collected the specimen	None
collectedDateTime	DateTime | None	Collection time	None
collectedDateTime_ext	Element | None	Placeholder element for collectedDateTime extensions	None
collectedPeriod	Period | None	Collection time	None
duration	Duration | None	How long it took to collect specimen	None
quantity	Quantity | None	The quantity of specimen collected	None
method	CodeableConcept | None	Technique used to perform collection	None
bodySite	CodeableConcept | None	Anatomical collection site	None
fastingStatusCodeableConcept	CodeableConcept | None	Whether or how long patient abstained from food and/or drink	None
fastingStatusDuration	Duration | None	Whether or how long patient abstained from food and/or drink	None

SpecimenContainer

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen.SpecimenContainer

Bases: BackboneElement

The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	List[Identifier] | None	Id for the container	None
description	String | None	Textual description of the container	None
description_ext	Element | None	Placeholder element for description extensions	None
type	CodeableConcept | None	Kind of container directly associated with specimen	None
capacity	Quantity | None	Container volume or size	None
specimenQuantity	Quantity | None	Quantity of specimen within container	None
additiveCodeableConcept	CodeableConcept | None	Additive associated with container	None
additiveReference	Reference | None	Additive associated with container	None

SpecimenProcessing

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen.SpecimenProcessing

Bases: BackboneElement

Details concerning processing and processing steps for the specimen.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Textual description of procedure	None
description_ext	Element | None	Placeholder element for description extensions	None
procedure	CodeableConcept | None	Indicates the treatment step applied to the specimen	None
additive	List[Reference] | None	Material used in the processing step	None
timeDateTime	DateTime | None	Date and time of specimen processing	None
timeDateTime_ext	Element | None	Placeholder element for timeDateTime extensions	None
timePeriod	Period | None	Date and time of specimen processing	None

SpecimenDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen_definition.SpecimenDefinition

Bases: DomainResource

A kind of specimen with associated set of requirements.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SpecimenDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	Identifier | None	Business identifier of a kind of specimen	None
typeCollected	CodeableConcept | None	Kind of material to collect	None
patientPreparation	List[CodeableConcept] | None	Patient preparation for collection	None
timeAspect	String | None	Time aspect for collection	None
timeAspect_ext	Element | None	Placeholder element for timeAspect extensions	None
collection	List[CodeableConcept] | None	Specimen collection procedure	None
typeTested	List[SpecimenDefinitionTypeTested] | None	Specimen in container intended for testing by lab	None
resourceType	Literal['SpecimenDefinition']		'SpecimenDefinition'

SpecimenDefinitionTypeTested

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen_definition.SpecimenDefinitionTypeTested

Bases: BackboneElement

Specimen conditioned in a container as expected by the testing laboratory.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
isDerived	Boolean | None	Primary or secondary specimen	None
isDerived_ext	Element | None	Placeholder element for isDerived extensions	None
type	CodeableConcept | None	Type of intended specimen	None
preference	Code | None	preferred | alternate	None
preference_ext	Element | None	Placeholder element for preference extensions	None
container	SpecimenDefinitionTypeTestedContainer | None	The specimen's container	None
requirement	String | None	Specimen requirements	None
requirement_ext	Element | None	Placeholder element for requirement extensions	None
retentionTime	Duration | None	Specimen retention time	None
rejectionCriterion	List[CodeableConcept] | None	Rejection criterion	None
handling	List[SpecimenDefinitionTypeTestedHandling] | None	Specimen handling before testing	None

SpecimenDefinitionTypeTestedContainer

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen_definition.SpecimenDefinitionTypeTestedContainer

Bases: BackboneElement

The specimen's container.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
material	CodeableConcept | None	Container material	None
type	CodeableConcept | None	Kind of container associated with the kind of specimen	None
cap	CodeableConcept | None	Color of container cap	None
description	String | None	Container description	None
description_ext	Element | None	Placeholder element for description extensions	None
capacity	Quantity | None	Container capacity	None
minimumVolumeQuantity	Quantity | None	Minimum volume	None
minimumVolumeString	String | None	Minimum volume	None
minimumVolumeString_ext	Element | None	Placeholder element for minimumVolumeString extensions	None
additive	List[SpecimenDefinitionTypeTestedContainerAdditive] | None	Additive associated with container	None
preparation	String | None	Specimen container preparation	None
preparation_ext	Element | None	Placeholder element for preparation extensions	None

SpecimenDefinitionTypeTestedContainerAdditive

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen_definition.SpecimenDefinitionTypeTestedContainerAdditive

Bases: BackboneElement

Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
additiveCodeableConcept	CodeableConcept | None	Additive associated with container	None
additiveReference	Reference | None	Additive associated with container	None

SpecimenDefinitionTypeTestedHandling

Path: fhircraft.fhir.resources.datatypes.R4.core.specimen_definition.SpecimenDefinitionTypeTestedHandling

Bases: BackboneElement

Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
temperatureQualifier	CodeableConcept | None	Temperature qualifier	None
temperatureRange	Range | None	Temperature range	None
maxDuration	Duration | None	Maximum preservation time	None
instruction	String | None	Preservation instruction	None
instruction_ext	Element | None	Placeholder element for instruction extensions	None

StructureDefinition

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_definition.StructureDefinition

Bases: DomainResource

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/StructureDefinition'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this structure definition, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the structure definition	None
version	String | None	Business version of the structure definition	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this structure definition (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this structure definition (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the structure definition	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for structure definition (if applicable)	None
purpose	Markdown | None	Why this structure definition is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
keyword	List[Coding] | None	Assist with indexing and finding	None
fhirVersion	Code | None	FHIR Version this StructureDefinition targets	None
fhirVersion_ext	Element | None	Placeholder element for fhirVersion extensions	None
mapping	List[StructureDefinitionMapping] | None	External specification that the content is mapped to	None
kind	Code | None	primitive-type | complex-type | resource | logical	None
kind_ext	Element | None	Placeholder element for kind extensions	None
abstract	Boolean | None	Whether the structure is abstract	None
abstract_ext	Element | None	Placeholder element for abstract extensions	None
context	List[StructureDefinitionContext] | None	If an extension, where it can be used in instances	None
contextInvariant	List[String] | None	FHIRPath invariants - when the extension can be used	None
contextInvariant_ext	Element | None	Placeholder element for contextInvariant extensions	None
type	Uri | None	Type defined or constrained by this structure	None
type_ext	Element | None	Placeholder element for type extensions	None
baseDefinition	Canonical | None	Definition that this type is constrained/specialized from	None
baseDefinition_ext	Element | None	Placeholder element for baseDefinition extensions	None
derivation	Code | None	specialization | constraint - How relates to base definition	None
derivation_ext	Element | None	Placeholder element for derivation extensions	None
snapshot	StructureDefinitionSnapshot | None	Snapshot view of the structure	None
differential	StructureDefinitionDifferential | None	Differential view of the structure	None
resourceType	Literal['StructureDefinition']		'StructureDefinition'

StructureDefinitionContext

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_definition.StructureDefinitionContext

Bases: BackboneElement

Identifies the types of resource or data type elements to which the extension can be applied.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	fhirpath | element | extension	None
type_ext	Element | None	Placeholder element for type extensions	None
expression	String | None	Where the extension can be used in instances	None
expression_ext	Element | None	Placeholder element for expression extensions	None

StructureDefinitionDifferential

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_definition.StructureDefinitionDifferential

Bases: BackboneElement

A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
element	List[ElementDefinition] | None	Definition of elements in the resource (if no StructureDefinition)	None

StructureDefinitionMapping

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_definition.StructureDefinitionMapping

Bases: BackboneElement

An external specification that the content is mapped to.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identity	Id | None	Internal id when this mapping is used	None
identity_ext	Element | None	Placeholder element for identity extensions	None
uri	Uri | None	Identifies what this mapping refers to	None
uri_ext	Element | None	Placeholder element for uri extensions	None
name	String | None	Names what this mapping refers to	None
name_ext	Element | None	Placeholder element for name extensions	None
comment	String | None	Versions, Issues, Scope limitations etc.	None
comment_ext	Element | None	Placeholder element for comment extensions	None

StructureDefinitionSnapshot

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_definition.StructureDefinitionSnapshot

Bases: BackboneElement

A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
element	List[ElementDefinition] | None	Definition of elements in the resource (if no StructureDefinition)	None

StructureMap

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMap

Bases: DomainResource

A Map of relationships between 2 structures that can be used to transform data.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/StructureMap'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this structure map, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the structure map	None
version	String | None	Business version of the structure map	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this structure map (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this structure map (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the structure map	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for structure map (if applicable)	None
purpose	Markdown | None	Why this structure map is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
structure	List[StructureMapStructure] | None	Structure Definition used by this map	None
import_	List[Canonical] | None	Other maps used by this map (canonical URLs)	None
import_ext	Element | None	Placeholder element for import extensions	None
group	List[StructureMapGroup] | None	Named sections for reader convenience	None
resourceType	Literal['StructureMap']		'StructureMap'

StructureMapGroup

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapGroup

Bases: BackboneElement

Organizes the mapping into manageable chunks for human review/ease of maintenance.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	Id | None	Human-readable label	None
name_ext	Element | None	Placeholder element for name extensions	None
extends	Id | None	Another group that this group adds rules to	None
extends_ext	Element | None	Placeholder element for extends extensions	None
typeMode	Code | None	none | types | type-and-types	None
typeMode_ext	Element | None	Placeholder element for typeMode extensions	None
documentation	String | None	Additional description/explanation for group	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None
input	List[StructureMapGroupInput] | None	Named instance provided when invoking the map	None
rule	List[StructureMapGroupRule] | None	Transform Rule from source to target	None

StructureMapGroupInput

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapGroupInput

Bases: BackboneElement

A name assigned to an instance of data. The instance must be provided when the mapping is invoked.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	Id | None	Name for this instance of data	None
name_ext	Element | None	Placeholder element for name extensions	None
type	String | None	Type for this instance of data	None
type_ext	Element | None	Placeholder element for type extensions	None
mode	Code | None	source | target	None
mode_ext	Element | None	Placeholder element for mode extensions	None
documentation	String | None	Documentation for this instance of data	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

StructureMapGroupRule

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapGroupRule

Bases: BackboneElement

Transform Rule from source to target.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	Id | None	Name of the rule for internal references	None
name_ext	Element | None	Placeholder element for name extensions	None
source	List[StructureMapGroupRuleSource] | None	Source inputs to the mapping	None
target	List[StructureMapGroupRuleTarget] | None	Content to create because of this mapping rule	None
rule	List[StructureMapGroupRule] | None	Rules contained in this rule	None
dependent	List[StructureMapGroupRuleDependent] | None	Which other rules to apply in the context of this rule	None
documentation	String | None	Documentation for this instance of data	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

StructureMapGroupRuleDependent

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapGroupRuleDependent

Bases: BackboneElement

Which other rules to apply in the context of this rule.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	Id | None	Name of a rule or group to apply	None
name_ext	Element | None	Placeholder element for name extensions	None
variable	List[String] | None	Variable to pass to the rule or group	None
variable_ext	Element | None	Placeholder element for variable extensions	None

StructureMapGroupRuleSource

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapGroupRuleSource

Bases: BackboneElement

Source inputs to the mapping.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
context	Id | None	Type or variable this rule applies to	None
context_ext	Element | None	Placeholder element for context extensions	None
min	Integer | None	Specified minimum cardinality	None
min_ext	Element | None	Placeholder element for min extensions	None
max	String | None	Specified maximum cardinality (number or *)	None
max_ext	Element | None	Placeholder element for max extensions	None
type	String | None	Rule only applies if source has this type	None
type_ext	Element | None	Placeholder element for type extensions	None
defaultValueBase64Binary	Base64Binary | None	Default value if no value exists	None
defaultValueBase64Binary_ext	Element | None	Placeholder element for defaultValueBase64Binary extensions	None
defaultValueBoolean	Boolean | None	Default value if no value exists	None
defaultValueBoolean_ext	Element | None	Placeholder element for defaultValueBoolean extensions	None
defaultValueCanonical	Canonical | None	Default value if no value exists	None
defaultValueCanonical_ext	Element | None	Placeholder element for defaultValueCanonical extensions	None
defaultValueCode	Code | None	Default value if no value exists	None
defaultValueCode_ext	Element | None	Placeholder element for defaultValueCode extensions	None
defaultValueDate	Date | None	Default value if no value exists	None
defaultValueDate_ext	Element | None	Placeholder element for defaultValueDate extensions	None
defaultValueDateTime	DateTime | None	Default value if no value exists	None
defaultValueDateTime_ext	Element | None	Placeholder element for defaultValueDateTime extensions	None
defaultValueDecimal	Decimal | None	Default value if no value exists	None
defaultValueDecimal_ext	Element | None	Placeholder element for defaultValueDecimal extensions	None
defaultValueId	Id | None	Default value if no value exists	None
defaultValueId_ext	Element | None	Placeholder element for defaultValueId extensions	None
defaultValueInstant	Instant | None	Default value if no value exists	None
defaultValueInstant_ext	Element | None	Placeholder element for defaultValueInstant extensions	None
defaultValueInteger	Integer | None	Default value if no value exists	None
defaultValueInteger_ext	Element | None	Placeholder element for defaultValueInteger extensions	None
defaultValueMarkdown	Markdown | None	Default value if no value exists	None
defaultValueMarkdown_ext	Element | None	Placeholder element for defaultValueMarkdown extensions	None
defaultValueOid	Oid | None	Default value if no value exists	None
defaultValueOid_ext	Element | None	Placeholder element for defaultValueOid extensions	None
defaultValuePositiveInt	PositiveInt | None	Default value if no value exists	None
defaultValuePositiveInt_ext	Element | None	Placeholder element for defaultValuePositiveInt extensions	None
defaultValueString	String | None	Default value if no value exists	None
defaultValueString_ext	Element | None	Placeholder element for defaultValueString extensions	None
defaultValueTime	Time | None	Default value if no value exists	None
defaultValueTime_ext	Element | None	Placeholder element for defaultValueTime extensions	None
defaultValueUnsignedInt	UnsignedInt | None	Default value if no value exists	None
defaultValueUnsignedInt_ext	Element | None	Placeholder element for defaultValueUnsignedInt extensions	None
defaultValueUri	Uri | None	Default value if no value exists	None
defaultValueUri_ext	Element | None	Placeholder element for defaultValueUri extensions	None
defaultValueUrl	Url | None	Default value if no value exists	None
defaultValueUrl_ext	Element | None	Placeholder element for defaultValueUrl extensions	None
defaultValueUuid	Uuid | None	Default value if no value exists	None
defaultValueUuid_ext	Element | None	Placeholder element for defaultValueUuid extensions	None
defaultValueAddress	Address | None	Default value if no value exists	None
defaultValueAge	Age | None	Default value if no value exists	None
defaultValueAnnotation	Annotation | None	Default value if no value exists	None
defaultValueAttachment	Attachment | None	Default value if no value exists	None
defaultValueCodeableConcept	CodeableConcept | None	Default value if no value exists	None
defaultValueCoding	Coding | None	Default value if no value exists	None
defaultValueContactPoint	ContactPoint | None	Default value if no value exists	None
defaultValueCount	Count | None	Default value if no value exists	None
defaultValueDistance	Distance | None	Default value if no value exists	None
defaultValueDuration	Duration | None	Default value if no value exists	None
defaultValueHumanName	HumanName | None	Default value if no value exists	None
defaultValueIdentifier	Identifier | None	Default value if no value exists	None
defaultValueMoney	Money | None	Default value if no value exists	None
defaultValuePeriod	Period | None	Default value if no value exists	None
defaultValueQuantity	Quantity | None	Default value if no value exists	None
defaultValueRange	Range | None	Default value if no value exists	None
defaultValueRatio	Ratio | None	Default value if no value exists	None
defaultValueReference	Reference | None	Default value if no value exists	None
defaultValueSampledData	SampledData | None	Default value if no value exists	None
defaultValueSignature	Signature | None	Default value if no value exists	None
defaultValueTiming	Timing | None	Default value if no value exists	None
defaultValueContactDetail	ContactDetail | None	Default value if no value exists	None
defaultValueContributor	Contributor | None	Default value if no value exists	None
defaultValueDataRequirement	DataRequirement | None	Default value if no value exists	None
defaultValueExpression	Expression | None	Default value if no value exists	None
defaultValueParameterDefinition	ParameterDefinition | None	Default value if no value exists	None
defaultValueRelatedArtifact	RelatedArtifact | None	Default value if no value exists	None
defaultValueTriggerDefinition	TriggerDefinition | None	Default value if no value exists	None
defaultValueUsageContext	UsageContext | None	Default value if no value exists	None
defaultValueDosage	Dosage | None	Default value if no value exists	None
defaultValueMeta	Meta | None	Default value if no value exists	None
element	String | None	Optional field for this source	None
element_ext	Element | None	Placeholder element for element extensions	None
listMode	Code | None	first | not_first | last | not_last | only_one	None
listMode_ext	Element | None	Placeholder element for listMode extensions	None
variable	Id | None	Named context for field, if a field is specified	None
variable_ext	Element | None	Placeholder element for variable extensions	None
condition	String | None	FHIRPath expression - must be true or the rule does not apply	None
condition_ext	Element | None	Placeholder element for condition extensions	None
check	String | None	FHIRPath expression - must be true or the mapping engine throws an error instead of completing	None
check_ext	Element | None	Placeholder element for check extensions	None
logMessage	String | None	Message to put in log if source exists (FHIRPath)	None
logMessage_ext	Element | None	Placeholder element for logMessage extensions	None

StructureMapGroupRuleTarget

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapGroupRuleTarget

Bases: BackboneElement

Content to create because of this mapping rule.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
context	Id | None	Type or variable this rule applies to	None
context_ext	Element | None	Placeholder element for context extensions	None
contextType	Code | None	type | variable	None
contextType_ext	Element | None	Placeholder element for contextType extensions	None
element	String | None	Field to create in the context	None
element_ext	Element | None	Placeholder element for element extensions	None
variable	Id | None	Named context for field, if desired, and a field is specified	None
variable_ext	Element | None	Placeholder element for variable extensions	None
listMode	List[Code] | None	first | share | last | collate	None
listMode_ext	Element | None	Placeholder element for listMode extensions	None
listRuleId	Id | None	Internal rule reference for shared list items	None
listRuleId_ext	Element | None	Placeholder element for listRuleId extensions	None
transform	Code | None	create | copy +	None
transform_ext	Element | None	Placeholder element for transform extensions	None
parameter	List[StructureMapGroupRuleTargetParameter] | None	Parameters to the transform	None

StructureMapGroupRuleTargetParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapGroupRuleTargetParameter

Bases: BackboneElement

Parameters to the transform.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueId	Id | None	Parameter value - variable or literal	None
valueId_ext	Element | None	Placeholder element for valueId extensions	None
valueString	String | None	Parameter value - variable or literal	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueBoolean	Boolean | None	Parameter value - variable or literal	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueInteger	Integer | None	Parameter value - variable or literal	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueDecimal	Decimal | None	Parameter value - variable or literal	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None

StructureMapStructure

Path: fhircraft.fhir.resources.datatypes.R4.core.structure_map.StructureMapStructure

Bases: BackboneElement

A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
url	Canonical | None	Canonical reference to structure definition	None
url_ext	Element | None	Placeholder element for url extensions	None
mode	Code | None	source | queried | target | produced	None
mode_ext	Element | None	Placeholder element for mode extensions	None
alias	String | None	Name for type in this map	None
alias_ext	Element | None	Placeholder element for alias extensions	None
documentation	String | None	Documentation on use of structure	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

Subscription

Path: fhircraft.fhir.resources.datatypes.R4.core.subscription.Subscription

Bases: DomainResource

The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Subscription'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
status	Code | None	requested | active | error | off	None
status_ext	Element | None	Placeholder element for status extensions	None
contact	List[ContactPoint] | None	Contact details for source (e.g. troubleshooting)	None
end	Instant | None	When to automatically delete the subscription	None
end_ext	Element | None	Placeholder element for end extensions	None
reason	String | None	Description of why this subscription was created	None
reason_ext	Element | None	Placeholder element for reason extensions	None
criteria	String | None	Rule for server push	None
criteria_ext	Element | None	Placeholder element for criteria extensions	None
error	String | None	Latest error note	None
error_ext	Element | None	Placeholder element for error extensions	None
channel	SubscriptionChannel | None	The channel on which to report matches to the criteria	None
resourceType	Literal['Subscription']		'Subscription'

SubscriptionChannel

Path: fhircraft.fhir.resources.datatypes.R4.core.subscription.SubscriptionChannel

Bases: BackboneElement

Details where to send notifications when resources are received that meet the criteria.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	rest-hook | websocket | email | sms | message	None
type_ext	Element | None	Placeholder element for type extensions	None
endpoint	Url | None	Where the channel points to	None
endpoint_ext	Element | None	Placeholder element for endpoint extensions	None
payload	Code | None	MIME type to send, or omit for no payload	None
payload_ext	Element | None	Placeholder element for payload extensions	None
header	List[String] | None	Usage depends on the channel type	None
header_ext	Element | None	Placeholder element for header extensions	None

Substance

Path: fhircraft.fhir.resources.datatypes.R4.core.substance.Substance

Bases: DomainResource

A homogeneous material with a definite composition.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Substance'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Unique identifier	None
status	Code | None	active | inactive | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
category	List[CodeableConcept] | None	What class/type of substance this is	None
code	CodeableConcept | None	What substance this is	None
description	String | None	Textual description of the substance, comments	None
description_ext	Element | None	Placeholder element for description extensions	None
instance	List[SubstanceInstance] | None	If this describes a specific package/container of the substance	None
ingredient	List[SubstanceIngredient] | None	Composition information about the substance	None
resourceType	Literal['Substance']		'Substance'

SubstanceIngredient

Path: fhircraft.fhir.resources.datatypes.R4.core.substance.SubstanceIngredient

Bases: BackboneElement

A substance can be composed of other substances.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
quantity	Ratio | None	Optional amount (concentration)	None
substanceCodeableConcept	CodeableConcept | None	A component of the substance	None
substanceReference	Reference | None	A component of the substance	None

SubstanceInstance

Path: fhircraft.fhir.resources.datatypes.R4.core.substance.SubstanceInstance

Bases: BackboneElement

Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Identifier | None	Identifier of the package/container	None
expiry	DateTime | None	When no longer valid to use	None
expiry_ext	Element | None	Placeholder element for expiry extensions	None
quantity	Quantity | None	Amount of substance in the package	None

SubstanceNucleicAcid

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_nucleic_acid.SubstanceNucleicAcid

Bases: DomainResource

Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
sequenceType	CodeableConcept | None	The type of the sequence shall be specified based on a controlled vocabulary	None
numberOfSubunits	Integer | None	The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit	None
numberOfSubunits_ext	Element | None	Placeholder element for numberOfSubunits extensions	None
areaOfHybridisation	String | None	The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”	None
areaOfHybridisation_ext	Element | None	Placeholder element for areaOfHybridisation extensions	None
oligoNucleotideType	CodeableConcept | None	(TBC)	None
subunit	List[SubstanceNucleicAcidSubunit] | None	Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times	None
resourceType	Literal['SubstanceNucleicAcid']		'SubstanceNucleicAcid'

SubstanceNucleicAcidSubunit

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_nucleic_acid.SubstanceNucleicAcidSubunit

Bases: BackboneElement

Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
subunit	Integer | None	Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts	None
subunit_ext	Element | None	Placeholder element for subunit extensions	None
sequence	String | None	Actual nucleotide sequence notation from 5' to 3' end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
length	Integer | None	The length of the sequence shall be captured	None
length_ext	Element | None	Placeholder element for length extensions	None
sequenceAttachment	Attachment | None	(TBC)	None
fivePrime	CodeableConcept | None	The nucleotide present at the 5’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant	None
threePrime	CodeableConcept | None	The nucleotide present at the 3’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant	None
linkage	List[SubstanceNucleicAcidSubunitLinkage] | None	The linkages between sugar residues will also be captured	None
sugar	List[SubstanceNucleicAcidSubunitSugar] | None	5.3.6.8.1 Sugar ID (Mandatory)	None

SubstanceNucleicAcidSubunitLinkage

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_nucleic_acid.SubstanceNucleicAcidSubunitLinkage

Bases: BackboneElement

The linkages between sugar residues will also be captured.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
connectivity	String | None	The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified	None
connectivity_ext	Element | None	Placeholder element for connectivity extensions	None
identifier	Identifier | None	Each linkage will be registered as a fragment and have an ID	None
name	String | None	Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage	None
name_ext	Element | None	Placeholder element for name extensions	None
residueSite	String | None	Residues shall be captured as described in 5.3.6.8.3	None
residueSite_ext	Element | None	Placeholder element for residueSite extensions	None

SubstanceNucleicAcidSubunitSugar

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_nucleic_acid.SubstanceNucleicAcidSubunitSugar

Bases: BackboneElement

5.3.6.8.1 Sugar ID (Mandatory).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Identifier | None	The Substance ID of the sugar or sugar-like component that make up the nucleotide	None
name	String | None	The name of the sugar or sugar-like component that make up the nucleotide	None
name_ext	Element | None	Placeholder element for name extensions	None
residueSite	String | None	The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above	None
residueSite_ext	Element | None	Placeholder element for residueSite extensions	None

SubstancePolymer

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_polymer.SubstancePolymer

Bases: DomainResource

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SubstancePolymer'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
class_	CodeableConcept | None	Todo	None
geometry	CodeableConcept | None	Todo	None
copolymerConnectivity	List[CodeableConcept] | None	Todo	None
modification	List[String] | None	Todo	None
modification_ext	Element | None	Placeholder element for modification extensions	None
monomerSet	List[SubstancePolymerMonomerSet] | None	Todo	None
repeat	List[SubstancePolymerRepeat] | None	Todo	None
resourceType	Literal['SubstancePolymer']		'SubstancePolymer'

SubstancePolymerMonomerSet

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_polymer.SubstancePolymerMonomerSet

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
ratioType	CodeableConcept | None	Todo	None
startingMaterial	List[SubstancePolymerMonomerSetStartingMaterial] | None	Todo	None

SubstancePolymerMonomerSetStartingMaterial

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_polymer.SubstancePolymerMonomerSetStartingMaterial

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
material	CodeableConcept | None	Todo	None
type	CodeableConcept | None	Todo	None
isDefining	Boolean | None	Todo	None
isDefining_ext	Element | None	Placeholder element for isDefining extensions	None
amount	SubstanceAmount | None	Todo	None

SubstancePolymerRepeat

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_polymer.SubstancePolymerRepeat

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
numberOfUnits	Integer | None	Todo	None
numberOfUnits_ext	Element | None	Placeholder element for numberOfUnits extensions	None
averageMolecularFormula	String | None	Todo	None
averageMolecularFormula_ext	Element | None	Placeholder element for averageMolecularFormula extensions	None
repeatUnitAmountType	CodeableConcept | None	Todo	None
repeatUnit	List[SubstancePolymerRepeatRepeatUnit] | None	Todo	None

SubstancePolymerRepeatRepeatUnit

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_polymer.SubstancePolymerRepeatRepeatUnit

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
orientationOfPolymerisation	CodeableConcept | None	Todo	None
repeatUnit	String | None	Todo	None
repeatUnit_ext	Element | None	Placeholder element for repeatUnit extensions	None
amount	SubstanceAmount | None	Todo	None
degreeOfPolymerisation	List[SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation] | None	Todo	None
structuralRepresentation	List[SubstancePolymerRepeatRepeatUnitStructuralRepresentation] | None	Todo	None

SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_polymer.SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
degree	CodeableConcept | None	Todo	None
amount	SubstanceAmount | None	Todo	None

SubstancePolymerRepeatRepeatUnitStructuralRepresentation

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_polymer.SubstancePolymerRepeatRepeatUnitStructuralRepresentation

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Todo	None
representation	String | None	Todo	None
representation_ext	Element | None	Placeholder element for representation extensions	None
attachment	Attachment | None	Todo	None

SubstanceProtein

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_protein.SubstanceProtein

Bases: DomainResource

A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SubstanceProtein'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
sequenceType	CodeableConcept | None	The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence	None
numberOfSubunits	Integer | None	Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable	None
numberOfSubunits_ext	Element | None	Placeholder element for numberOfSubunits extensions	None
disulfideLinkage	List[String] | None	The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions	None
disulfideLinkage_ext	Element | None	Placeholder element for disulfideLinkage extensions	None
subunit	List[SubstanceProteinSubunit] | None	This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times	None
resourceType	Literal['SubstanceProtein']		'SubstanceProtein'

SubstanceProteinSubunit

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_protein.SubstanceProteinSubunit

Bases: BackboneElement

This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
subunit	Integer | None	Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts	None
subunit_ext	Element | None	Placeholder element for subunit extensions	None
sequence	String | None	The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence	None
sequence_ext	Element | None	Placeholder element for sequence extensions	None
length	Integer | None	Length of linear sequences of amino acids contained in the subunit	None
length_ext	Element | None	Placeholder element for length extensions	None
sequenceAttachment	Attachment | None	The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence	None
nTerminalModificationId	Identifier | None	Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID	None
nTerminalModification	String | None	The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified	None
nTerminalModification_ext	Element | None	Placeholder element for nTerminalModification extensions	None
cTerminalModificationId	Identifier | None	Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID	None
cTerminalModification	String | None	The modification at the C-terminal shall be specified	None
cTerminalModification_ext	Element | None	Placeholder element for cTerminalModification extensions	None

SubstanceReferenceInformation

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_reference_information.SubstanceReferenceInformation

Bases: DomainResource

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
comment	String | None	Todo	None
comment_ext	Element | None	Placeholder element for comment extensions	None
gene	List[SubstanceReferenceInformationGene] | None	Todo	None
geneElement	List[SubstanceReferenceInformationGeneElement] | None	Todo	None
classification	List[SubstanceReferenceInformationClassification] | None	Todo	None
target	List[SubstanceReferenceInformationTarget] | None	Todo	None
resourceType	Literal['SubstanceReferenceInformation']		'SubstanceReferenceInformation'

SubstanceReferenceInformationClassification

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_reference_information.SubstanceReferenceInformationClassification

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
domain	CodeableConcept | None	Todo	None
classification	CodeableConcept | None	Todo	None
subtype	List[CodeableConcept] | None	Todo	None
source	List[Reference] | None	Todo	None

SubstanceReferenceInformationGene

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_reference_information.SubstanceReferenceInformationGene

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
geneSequenceOrigin	CodeableConcept | None	Todo	None
gene	CodeableConcept | None	Todo	None
source	List[Reference] | None	Todo	None

SubstanceReferenceInformationGeneElement

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_reference_information.SubstanceReferenceInformationGeneElement

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Todo	None
element	Identifier | None	Todo	None
source	List[Reference] | None	Todo	None

SubstanceReferenceInformationTarget

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_reference_information.SubstanceReferenceInformationTarget

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
target	Identifier | None	Todo	None
type	CodeableConcept | None	Todo	None
interaction	CodeableConcept | None	Todo	None
organism	CodeableConcept | None	Todo	None
organismType	CodeableConcept | None	Todo	None
amountQuantity	Quantity | None	Todo	None
amountRange	Range | None	Todo	None
amountString	String | None	Todo	None
amountString_ext	Element | None	Placeholder element for amountString extensions	None
amountType	CodeableConcept | None	Todo	None
source	List[Reference] | None	Todo	None

SubstanceSourceMaterial

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_source_material.SubstanceSourceMaterial

Bases: DomainResource

Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
sourceMaterialClass	CodeableConcept | None	General high level classification of the source material specific to the origin of the material	None
sourceMaterialType	CodeableConcept | None	The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent	None
sourceMaterialState	CodeableConcept | None	The state of the source material when extracted	None
organismId	Identifier | None	The unique identifier associated with the source material parent organism shall be specified	None
organismName	String | None	The organism accepted Scientific name shall be provided based on the organism taxonomy	None
organismName_ext	Element | None	Placeholder element for organismName extensions	None
parentSubstanceId	List[Identifier] | None	The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant)	None
parentSubstanceName	List[String] | None	The parent substance of the Herbal Drug, or Herbal preparation	None
parentSubstanceName_ext	Element | None	Placeholder element for parentSubstanceName extensions	None
countryOfOrigin	List[CodeableConcept] | None	The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate	None
geographicalLocation	List[String] | None	The place/region where the plant is harvested or the places/regions where the animal source material has its habitat	None
geographicalLocation_ext	Element | None	Placeholder element for geographicalLocation extensions	None
developmentStage	CodeableConcept | None	Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum)	None
fractionDescription	List[SubstanceSourceMaterialFractionDescription] | None	Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels	None
organism	SubstanceSourceMaterialOrganism | None	This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf	None
partDescription	List[SubstanceSourceMaterialPartDescription] | None	To do	None
resourceType	Literal['SubstanceSourceMaterial']		'SubstanceSourceMaterial'

SubstanceSourceMaterialFractionDescription

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_source_material.SubstanceSourceMaterialFractionDescription

Bases: BackboneElement

Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
fraction	String | None	This element is capturing information about the fraction of a plant part, or human plasma for fractionation	None
fraction_ext	Element | None	Placeholder element for fraction extensions	None
materialType	CodeableConcept | None	The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1	None

SubstanceSourceMaterialOrganism

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_source_material.SubstanceSourceMaterialOrganism

Bases: BackboneElement

This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
family	CodeableConcept | None	The family of an organism shall be specified	None
genus	CodeableConcept | None	The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies	None
species	CodeableConcept | None	The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies	None
intraspecificType	CodeableConcept | None	The Intraspecific type of an organism shall be specified	None
intraspecificDescription	String | None	The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention	None
intraspecificDescription_ext	Element | None	Placeholder element for intraspecificDescription extensions	None
author	List[SubstanceSourceMaterialOrganismAuthor] | None	4.9.13.6.1 Author type (Conditional)	None
hybrid	SubstanceSourceMaterialOrganismHybrid | None	4.9.13.8.1 Hybrid species maternal organism ID (Optional)	None
organismGeneral	SubstanceSourceMaterialOrganismOrganismGeneral | None	4.9.13.7.1 Kingdom (Conditional)	None

SubstanceSourceMaterialOrganismAuthor

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_source_material.SubstanceSourceMaterialOrganismAuthor

Bases: BackboneElement

4.9.13.6.1 Author type (Conditional).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
authorType	CodeableConcept | None	The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name	None
authorDescription	String | None	The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)	None
authorDescription_ext	Element | None	Placeholder element for authorDescription extensions	None

SubstanceSourceMaterialOrganismHybrid

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_source_material.SubstanceSourceMaterialOrganismHybrid

Bases: BackboneElement

4.9.13.8.1 Hybrid species maternal organism ID (Optional).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
maternalOrganismId	String | None	The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal	None
maternalOrganismId_ext	Element | None	Placeholder element for maternalOrganismId extensions	None
maternalOrganismName	String | None	The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal	None
maternalOrganismName_ext	Element | None	Placeholder element for maternalOrganismName extensions	None
paternalOrganismId	String | None	The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary	None
paternalOrganismId_ext	Element | None	Placeholder element for paternalOrganismId extensions	None
paternalOrganismName	String | None	The name of the paternal species constituting the hybrid organism shall be specified	None
paternalOrganismName_ext	Element | None	Placeholder element for paternalOrganismName extensions	None
hybridType	CodeableConcept | None	The hybrid type of an organism shall be specified	None

SubstanceSourceMaterialOrganismOrganismGeneral

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_source_material.SubstanceSourceMaterialOrganismOrganismGeneral

Bases: BackboneElement

4.9.13.7.1 Kingdom (Conditional).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
kingdom	CodeableConcept | None	The kingdom of an organism shall be specified	None
phylum	CodeableConcept | None	The phylum of an organism shall be specified	None
class_	CodeableConcept | None	The class of an organism shall be specified	None
order	CodeableConcept | None	The order of an organism shall be specified,	None

SubstanceSourceMaterialPartDescription

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_source_material.SubstanceSourceMaterialPartDescription

Bases: BackboneElement

To do.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
part	CodeableConcept | None	Entity of anatomical origin of source material within an organism	None
partLocation	CodeableConcept | None	The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply	None

SubstanceSpecification

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecification

Bases: DomainResource

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SubstanceSpecification'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	Identifier | None	Identifier by which this substance is known	None
type	CodeableConcept | None	High level categorization, e.g. polymer or nucleic acid	None
status	CodeableConcept | None	Status of substance within the catalogue e.g. approved	None
domain	CodeableConcept | None	If the substance applies to only human or veterinary use	None
description	String | None	Textual description of the substance	None
description_ext	Element | None	Placeholder element for description extensions	None
source	List[Reference] | None	Supporting literature	None
comment	String | None	Textual comment about this record of a substance	None
comment_ext	Element | None	Placeholder element for comment extensions	None
moiety	List[SubstanceSpecificationMoiety] | None	Moiety, for structural modifications	None
property_	List[SubstanceSpecificationProperty] | None	General specifications for this substance, including how it is related to other substances	None
referenceInformation	Reference | None	General information detailing this substance	None
structure	SubstanceSpecificationStructure | None	Structural information	None
code	List[SubstanceSpecificationCode] | None	Codes associated with the substance	None
name	List[SubstanceSpecificationName] | None	Names applicable to this substance	None
molecularWeight	List[SubstanceSpecificationStructureIsotopeMolecularWeight] | None	The molecular weight or weight range (for proteins, polymers or nucleic acids)	None
relationship	List[SubstanceSpecificationRelationship] | None	A link between this substance and another, with details of the relationship	None
nucleicAcid	Reference | None	Data items specific to nucleic acids	None
polymer	Reference | None	Data items specific to polymers	None
protein	Reference | None	Data items specific to proteins	None
sourceMaterial	Reference | None	Material or taxonomic/anatomical source for the substance	None
resourceType	Literal['SubstanceSpecification']		'SubstanceSpecification'

SubstanceSpecificationCode

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationCode

Bases: BackboneElement

Codes associated with the substance.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	The specific code	None
status	CodeableConcept | None	Status of the code assignment	None
statusDate	DateTime | None	The date at which the code status is changed as part of the terminology maintenance	None
statusDate_ext	Element | None	Placeholder element for statusDate extensions	None
comment	String | None	Any comment can be provided in this field, if necessary	None
comment_ext	Element | None	Placeholder element for comment extensions	None
source	List[Reference] | None	Supporting literature	None

SubstanceSpecificationMoiety

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationMoiety

Bases: BackboneElement

Moiety, for structural modifications.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
role	CodeableConcept | None	Role that the moiety is playing	None
identifier	Identifier | None	Identifier by which this moiety substance is known	None
name	String | None	Textual name for this moiety substance	None
name_ext	Element | None	Placeholder element for name extensions	None
stereochemistry	CodeableConcept | None	Stereochemistry type	None
opticalActivity	CodeableConcept | None	Optical activity type	None
molecularFormula	String | None	Molecular formula	None
molecularFormula_ext	Element | None	Placeholder element for molecularFormula extensions	None
amountQuantity	Quantity | None	Quantitative value for this moiety	None
amountString	String | None	Quantitative value for this moiety	None
amountString_ext	Element | None	Placeholder element for amountString extensions	None

SubstanceSpecificationName

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationName

Bases: BackboneElement

Names applicable to this substance.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	The actual name	None
name_ext	Element | None	Placeholder element for name extensions	None
type	CodeableConcept | None	Name type	None
status	CodeableConcept | None	The status of the name	None
preferred	Boolean | None	If this is the preferred name for this substance	None
preferred_ext	Element | None	Placeholder element for preferred extensions	None
language	List[CodeableConcept] | None	Language of the name	None
domain	List[CodeableConcept] | None	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	None
jurisdiction	List[CodeableConcept] | None	The jurisdiction where this name applies	None
synonym	List[SubstanceSpecificationName] | None	A synonym of this name	None
translation	List[SubstanceSpecificationName] | None	A translation for this name	None
official	List[SubstanceSpecificationNameOfficial] | None	Details of the official nature of this name	None
source	List[Reference] | None	Supporting literature	None

SubstanceSpecificationNameOfficial

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationNameOfficial

Bases: BackboneElement

Details of the official nature of this name.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
authority	CodeableConcept | None	Which authority uses this official name	None
status	CodeableConcept | None	The status of the official name	None
date	DateTime | None	Date of official name change	None
date_ext	Element | None	Placeholder element for date extensions	None

SubstanceSpecificationProperty

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationProperty

Bases: BackboneElement

General specifications for this substance, including how it is related to other substances.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
category	CodeableConcept | None	A category for this property, e.g. Physical, Chemical, Enzymatic	None
code	CodeableConcept | None	Property type e.g. viscosity, pH, isoelectric point	None
parameters	String | None	Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)	None
parameters_ext	Element | None	Placeholder element for parameters extensions	None
definingSubstanceReference	Reference | None	A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)	None
definingSubstanceCodeableConcept	CodeableConcept | None	A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)	None
amountQuantity	Quantity | None	Quantitative value for this property	None
amountString	String | None	Quantitative value for this property	None
amountString_ext	Element | None	Placeholder element for amountString extensions	None

SubstanceSpecificationRelationship

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationRelationship

Bases: BackboneElement

A link between this substance and another, with details of the relationship.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
substanceReference	Reference | None	A pointer to another substance, as a resource or just a representational code	None
substanceCodeableConcept	CodeableConcept | None	A pointer to another substance, as a resource or just a representational code	None
relationship	CodeableConcept | None	For example "salt to parent", "active moiety", "starting material"	None
isDefining	Boolean | None	For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships	None
isDefining_ext	Element | None	Placeholder element for isDefining extensions	None
amountQuantity	Quantity | None	A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other	None
amountRange	Range | None	A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other	None
amountRatio	Ratio | None	A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other	None
amountString	String | None	A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other	None
amountString_ext	Element | None	Placeholder element for amountString extensions	None
amountRatioLowLimit	Ratio | None	For use when the numeric	None
amountType	CodeableConcept | None	An operator for the amount, for example "average", "approximately", "less than"	None
source	List[Reference] | None	Supporting literature	None

SubstanceSpecificationStructure

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationStructure

Bases: BackboneElement

Structural information.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
stereochemistry	CodeableConcept | None	Stereochemistry type	None
opticalActivity	CodeableConcept | None	Optical activity type	None
molecularFormula	String | None	Molecular formula	None
molecularFormula_ext	Element | None	Placeholder element for molecularFormula extensions	None
molecularFormulaByMoiety	String | None	Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot	None
molecularFormulaByMoiety_ext	Element | None	Placeholder element for molecularFormulaByMoiety extensions	None
isotope	List[SubstanceSpecificationStructureIsotope] | None	Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio	None
molecularWeight	SubstanceSpecificationStructureMolecularWeight | None	The molecular weight or weight range (for proteins, polymers or nucleic acids)	None
source	List[Reference] | None	Supporting literature	None
representation	List[SubstanceSpecificationStructureRepresentation] | None	Molecular structural representation	None

SubstanceSpecificationStructureIsotope

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationStructureIsotope

Bases: BackboneElement

Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Identifier | None	Substance identifier for each non-natural or radioisotope	None
name	CodeableConcept | None	Substance name for each non-natural or radioisotope	None
substitution	CodeableConcept | None	The type of isotopic substitution present in a single substance	None
halfLife	Quantity | None	Half life - for a non-natural nuclide	None
molecularWeight	SubstanceSpecificationStructureIsotopeMolecularWeight | None	The molecular weight or weight range (for proteins, polymers or nucleic acids)	None

SubstanceSpecificationStructureIsotopeMolecularWeight

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationStructureIsotopeMolecularWeight

Bases: BackboneElement

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
method	CodeableConcept | None	The method by which the molecular weight was determined	None
type	CodeableConcept | None	Type of molecular weight such as exact, average (also known as. number average), weight average	None
amount	Quantity | None	Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field	None

SubstanceSpecificationStructureMolecularWeight

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationStructureMolecularWeight

Bases: BackboneElement

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
method	CodeableConcept | None	The method by which the molecular weight was determined	None
type	CodeableConcept | None	Type of molecular weight such as exact, average (also known as. number average), weight average	None
amount	Quantity | None	Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field	None

SubstanceSpecificationStructureRepresentation

Path: fhircraft.fhir.resources.datatypes.R4.core.substance_specification.SubstanceSpecificationStructureRepresentation

Bases: BackboneElement

Molecular structural representation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	The type of structure (e.g. Full, Partial, Representative)	None
representation	String | None	The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX	None
representation_ext	Element | None	Placeholder element for representation extensions	None
attachment	Attachment | None	An attached file with the structural representation	None

SupplyDelivery

Path: fhircraft.fhir.resources.datatypes.R4.core.supply_delivery.SupplyDelivery

Bases: DomainResource

Record of delivery of what is supplied.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SupplyDelivery'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	External identifier	None
basedOn	List[Reference] | None	Fulfills plan, proposal or order	None
partOf	List[Reference] | None	Part of referenced event	None
status	Code | None	in-progress | completed | abandoned | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
patient	Reference | None	Patient for whom the item is supplied	None
type	CodeableConcept | None	Category of dispense event	None
suppliedItem	SupplyDeliverySuppliedItem | None	The item that is delivered or supplied	None
occurrenceDateTime	DateTime | None	When event occurred	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	When event occurred	None
occurrenceTiming	Timing | None	When event occurred	None
supplier	Reference | None	Dispenser	None
destination	Reference | None	Where the Supply was sent	None
receiver	List[Reference] | None	Who collected the Supply	None
resourceType	Literal['SupplyDelivery']		'SupplyDelivery'

SupplyDeliverySuppliedItem

Path: fhircraft.fhir.resources.datatypes.R4.core.supply_delivery.SupplyDeliverySuppliedItem

Bases: BackboneElement

The item that is being delivered or has been supplied.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
quantity	Quantity | None	Amount dispensed	None
itemCodeableConcept	CodeableConcept | None	Medication, Substance, or Device supplied	None
itemReference	Reference | None	Medication, Substance, or Device supplied	None

SupplyRequest

Path: fhircraft.fhir.resources.datatypes.R4.core.supply_request.SupplyRequest

Bases: DomainResource

A record of a request for a medication, substance or device used in the healthcare setting.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/SupplyRequest'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for SupplyRequest	None
status	Code | None	draft | active | suspended +	None
status_ext	Element | None	Placeholder element for status extensions	None
category	CodeableConcept | None	The kind of supply (central, non-stock, etc.)	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
itemCodeableConcept	CodeableConcept | None	Medication, Substance, or Device requested to be supplied	None
itemReference	Reference | None	Medication, Substance, or Device requested to be supplied	None
quantity	Quantity | None	The requested amount of the item indicated	None
parameter	List[SupplyRequestParameter] | None	Ordered item details	None
occurrenceDateTime	DateTime | None	When the request should be fulfilled	None
occurrenceDateTime_ext	Element | None	Placeholder element for occurrenceDateTime extensions	None
occurrencePeriod	Period | None	When the request should be fulfilled	None
occurrenceTiming	Timing | None	When the request should be fulfilled	None
authoredOn	DateTime | None	When the request was made	None
authoredOn_ext	Element | None	Placeholder element for authoredOn extensions	None
requester	Reference | None	Individual making the request	None
supplier	List[Reference] | None	Who is intended to fulfill the request	None
reasonCode	List[CodeableConcept] | None	The reason why the supply item was requested	None
reasonReference	List[Reference] | None	The reason why the supply item was requested	None
deliverFrom	Reference | None	The origin of the supply	None
deliverTo	Reference | None	The destination of the supply	None
resourceType	Literal['SupplyRequest']		'SupplyRequest'

SupplyRequestParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.supply_request.SupplyRequestParameter

Bases: BackboneElement

Specific parameters for the ordered item. For example, the size of the indicated item.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	CodeableConcept | None	Item detail	None
valueCodeableConcept	CodeableConcept | None	Value of detail	None
valueQuantity	Quantity | None	Value of detail	None
valueRange	Range | None	Value of detail	None
valueBoolean	Boolean | None	Value of detail	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None

Task

Path: fhircraft.fhir.resources.datatypes.R4.core.task.Task

Bases: DomainResource

A task to be performed.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/Task'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Task Instance Identifier	None
instantiatesCanonical	Canonical | None	Formal definition of task	None
instantiatesCanonical_ext	Element | None	Placeholder element for instantiatesCanonical extensions	None
instantiatesUri	Uri | None	Formal definition of task	None
instantiatesUri_ext	Element | None	Placeholder element for instantiatesUri extensions	None
basedOn	List[Reference] | None	Request fulfilled by this task	None
groupIdentifier	Identifier | None	Requisition or grouper id	None
partOf	List[Reference] | None	Composite task	None
status	Code | None	draft | requested | received | accepted | +	None
status_ext	Element | None	Placeholder element for status extensions	None
statusReason	CodeableConcept | None	Reason for current status	None
businessStatus	CodeableConcept | None	E.g. "Specimen collected", "IV prepped"	None
intent	Code | None	unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option	None
intent_ext	Element | None	Placeholder element for intent extensions	None
priority	Code | None	routine | urgent | asap | stat	None
priority_ext	Element | None	Placeholder element for priority extensions	None
code	CodeableConcept | None	Task Type	None
description	String | None	Human-readable explanation of task	None
description_ext	Element | None	Placeholder element for description extensions	None
focus	Reference | None	What task is acting on	None
for_	Reference | None	Beneficiary of the Task	None
encounter	Reference | None	Healthcare event during which this task originated	None
executionPeriod	Period | None	Start and end time of execution	None
authoredOn	DateTime | None	Task Creation Date	None
authoredOn_ext	Element | None	Placeholder element for authoredOn extensions	None
lastModified	DateTime | None	Task Last Modified Date	None
lastModified_ext	Element | None	Placeholder element for lastModified extensions	None
requester	Reference | None	Who is asking for task to be done	None
performerType	List[CodeableConcept] | None	Requested performer	None
owner	Reference | None	Responsible individual	None
location	Reference | None	Where task occurs	None
reasonCode	CodeableConcept | None	Why task is needed	None
reasonReference	Reference | None	Why task is needed	None
insurance	List[Reference] | None	Associated insurance coverage	None
note	List[Annotation] | None	Comments made about the task	None
relevantHistory	List[Reference] | None	Key events in history of the Task	None
restriction	TaskRestriction | None	Constraints on fulfillment tasks	None
input	List[TaskInput] | None	Information used to perform task	None
output	List[TaskOutput] | None	Information produced as part of task	None
resourceType	Literal['Task']		'Task'

TaskInput

Path: fhircraft.fhir.resources.datatypes.R4.core.task.TaskInput

Bases: BackboneElement

Additional information that may be needed in the execution of the task.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Label for the input	None
valueBase64Binary	Base64Binary | None	Content to use in performing the task	None
valueBase64Binary_ext	Element | None	Placeholder element for valueBase64Binary extensions	None
valueBoolean	Boolean | None	Content to use in performing the task	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueCanonical	Canonical | None	Content to use in performing the task	None
valueCanonical_ext	Element | None	Placeholder element for valueCanonical extensions	None
valueCode	Code | None	Content to use in performing the task	None
valueCode_ext	Element | None	Placeholder element for valueCode extensions	None
valueDate	Date | None	Content to use in performing the task	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueDateTime	DateTime | None	Content to use in performing the task	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueDecimal	Decimal | None	Content to use in performing the task	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueId	Id | None	Content to use in performing the task	None
valueId_ext	Element | None	Placeholder element for valueId extensions	None
valueInstant	Instant | None	Content to use in performing the task	None
valueInstant_ext	Element | None	Placeholder element for valueInstant extensions	None
valueInteger	Integer | None	Content to use in performing the task	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueMarkdown	Markdown | None	Content to use in performing the task	None
valueMarkdown_ext	Element | None	Placeholder element for valueMarkdown extensions	None
valueOid	Oid | None	Content to use in performing the task	None
valueOid_ext	Element | None	Placeholder element for valueOid extensions	None
valuePositiveInt	PositiveInt | None	Content to use in performing the task	None
valuePositiveInt_ext	Element | None	Placeholder element for valuePositiveInt extensions	None
valueString	String | None	Content to use in performing the task	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueTime	Time | None	Content to use in performing the task	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueUnsignedInt	UnsignedInt | None	Content to use in performing the task	None
valueUnsignedInt_ext	Element | None	Placeholder element for valueUnsignedInt extensions	None
valueUri	Uri | None	Content to use in performing the task	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueUrl	Url | None	Content to use in performing the task	None
valueUrl_ext	Element | None	Placeholder element for valueUrl extensions	None
valueUuid	Uuid | None	Content to use in performing the task	None
valueUuid_ext	Element | None	Placeholder element for valueUuid extensions	None
valueAddress	Address | None	Content to use in performing the task	None
valueAge	Age | None	Content to use in performing the task	None
valueAnnotation	Annotation | None	Content to use in performing the task	None
valueAttachment	Attachment | None	Content to use in performing the task	None
valueCodeableConcept	CodeableConcept | None	Content to use in performing the task	None
valueCoding	Coding | None	Content to use in performing the task	None
valueContactPoint	ContactPoint | None	Content to use in performing the task	None
valueCount	Count | None	Content to use in performing the task	None
valueDistance	Distance | None	Content to use in performing the task	None
valueDuration	Duration | None	Content to use in performing the task	None
valueHumanName	HumanName | None	Content to use in performing the task	None
valueIdentifier	Identifier | None	Content to use in performing the task	None
valueMoney	Money | None	Content to use in performing the task	None
valuePeriod	Period | None	Content to use in performing the task	None
valueQuantity	Quantity | None	Content to use in performing the task	None
valueRange	Range | None	Content to use in performing the task	None
valueRatio	Ratio | None	Content to use in performing the task	None
valueReference	Reference | None	Content to use in performing the task	None
valueSampledData	SampledData | None	Content to use in performing the task	None
valueSignature	Signature | None	Content to use in performing the task	None
valueTiming	Timing | None	Content to use in performing the task	None
valueContactDetail	ContactDetail | None	Content to use in performing the task	None
valueContributor	Contributor | None	Content to use in performing the task	None
valueDataRequirement	DataRequirement | None	Content to use in performing the task	None
valueExpression	Expression | None	Content to use in performing the task	None
valueParameterDefinition	ParameterDefinition | None	Content to use in performing the task	None
valueRelatedArtifact	RelatedArtifact | None	Content to use in performing the task	None
valueTriggerDefinition	TriggerDefinition | None	Content to use in performing the task	None
valueUsageContext	UsageContext | None	Content to use in performing the task	None
valueDosage	Dosage | None	Content to use in performing the task	None
valueMeta	Meta | None	Content to use in performing the task	None

TaskOutput

Path: fhircraft.fhir.resources.datatypes.R4.core.task.TaskOutput

Bases: BackboneElement

Outputs produced by the Task.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	CodeableConcept | None	Label for output	None
valueBase64Binary	Base64Binary | None	Result of output	None
valueBase64Binary_ext	Element | None	Placeholder element for valueBase64Binary extensions	None
valueBoolean	Boolean | None	Result of output	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueCanonical	Canonical | None	Result of output	None
valueCanonical_ext	Element | None	Placeholder element for valueCanonical extensions	None
valueCode	Code | None	Result of output	None
valueCode_ext	Element | None	Placeholder element for valueCode extensions	None
valueDate	Date | None	Result of output	None
valueDate_ext	Element | None	Placeholder element for valueDate extensions	None
valueDateTime	DateTime | None	Result of output	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None
valueDecimal	Decimal | None	Result of output	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueId	Id | None	Result of output	None
valueId_ext	Element | None	Placeholder element for valueId extensions	None
valueInstant	Instant | None	Result of output	None
valueInstant_ext	Element | None	Placeholder element for valueInstant extensions	None
valueInteger	Integer | None	Result of output	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueMarkdown	Markdown | None	Result of output	None
valueMarkdown_ext	Element | None	Placeholder element for valueMarkdown extensions	None
valueOid	Oid | None	Result of output	None
valueOid_ext	Element | None	Placeholder element for valueOid extensions	None
valuePositiveInt	PositiveInt | None	Result of output	None
valuePositiveInt_ext	Element | None	Placeholder element for valuePositiveInt extensions	None
valueString	String | None	Result of output	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueTime	Time | None	Result of output	None
valueTime_ext	Element | None	Placeholder element for valueTime extensions	None
valueUnsignedInt	UnsignedInt | None	Result of output	None
valueUnsignedInt_ext	Element | None	Placeholder element for valueUnsignedInt extensions	None
valueUri	Uri | None	Result of output	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueUrl	Url | None	Result of output	None
valueUrl_ext	Element | None	Placeholder element for valueUrl extensions	None
valueUuid	Uuid | None	Result of output	None
valueUuid_ext	Element | None	Placeholder element for valueUuid extensions	None
valueAddress	Address | None	Result of output	None
valueAge	Age | None	Result of output	None
valueAnnotation	Annotation | None	Result of output	None
valueAttachment	Attachment | None	Result of output	None
valueCodeableConcept	CodeableConcept | None	Result of output	None
valueCoding	Coding | None	Result of output	None
valueContactPoint	ContactPoint | None	Result of output	None
valueCount	Count | None	Result of output	None
valueDistance	Distance | None	Result of output	None
valueDuration	Duration | None	Result of output	None
valueHumanName	HumanName | None	Result of output	None
valueIdentifier	Identifier | None	Result of output	None
valueMoney	Money | None	Result of output	None
valuePeriod	Period | None	Result of output	None
valueQuantity	Quantity | None	Result of output	None
valueRange	Range | None	Result of output	None
valueRatio	Ratio | None	Result of output	None
valueReference	Reference | None	Result of output	None
valueSampledData	SampledData | None	Result of output	None
valueSignature	Signature | None	Result of output	None
valueTiming	Timing | None	Result of output	None
valueContactDetail	ContactDetail | None	Result of output	None
valueContributor	Contributor | None	Result of output	None
valueDataRequirement	DataRequirement | None	Result of output	None
valueExpression	Expression | None	Result of output	None
valueParameterDefinition	ParameterDefinition | None	Result of output	None
valueRelatedArtifact	RelatedArtifact | None	Result of output	None
valueTriggerDefinition	TriggerDefinition | None	Result of output	None
valueUsageContext	UsageContext | None	Result of output	None
valueDosage	Dosage | None	Result of output	None
valueMeta	Meta | None	Result of output	None

TaskRestriction

Path: fhircraft.fhir.resources.datatypes.R4.core.task.TaskRestriction

Bases: BackboneElement

If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
repetitions	PositiveInt | None	How many times to repeat	None
repetitions_ext	Element | None	Placeholder element for repetitions extensions	None
period	Period | None	When fulfillment sought	None
recipient	List[Reference] | None	For whom is fulfillment sought?	None

TerminologyCapabilities

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilities

Bases: DomainResource

A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
version	String | None	Business version of the terminology capabilities	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this terminology capabilities (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this terminology capabilities (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the terminology capabilities	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for terminology capabilities (if applicable)	None
purpose	Markdown | None	Why this terminology capabilities is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
kind	Code | None	instance | capability | requirements	None
kind_ext	Element | None	Placeholder element for kind extensions	None
software	TerminologyCapabilitiesSoftware | None	Software that is covered by this terminology capability statement	None
implementation	TerminologyCapabilitiesImplementation | None	If this describes a specific instance	None
lockedDate	Boolean | None	Whether lockedDate is supported	None
lockedDate_ext	Element | None	Placeholder element for lockedDate extensions	None
codeSystem	List[TerminologyCapabilitiesCodeSystem] | None	A code system supported by the server	None
expansion	TerminologyCapabilitiesExpansion | None	Information about the ValueSet/$expand operation	None
codeSearch	Code | None	explicit | all	None
codeSearch_ext	Element | None	Placeholder element for codeSearch extensions	None
validateCode	TerminologyCapabilitiesValidateCode | None	Information about the ValueSet/$validate-code operation	None
translation	TerminologyCapabilitiesTranslation | None	Information about the ConceptMap/$translate operation	None
closure	TerminologyCapabilitiesClosure | None	Information about the ConceptMap/$closure operation	None
resourceType	Literal['TerminologyCapabilities']		'TerminologyCapabilities'

TerminologyCapabilitiesClosure

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesClosure

Bases: BackboneElement

Whether the $closure operation is supported.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
translation	Boolean | None	If cross-system closure is supported	None
translation_ext	Element | None	Placeholder element for translation extensions	None

TerminologyCapabilitiesCodeSystem

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesCodeSystem

Bases: BackboneElement

Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
uri	Canonical | None	URI for the Code System	None
uri_ext	Element | None	Placeholder element for uri extensions	None
version	List[TerminologyCapabilitiesCodeSystemVersion] | None	Version of Code System supported	None
subsumption	Boolean | None	Whether subsumption is supported	None
subsumption_ext	Element | None	Placeholder element for subsumption extensions	None

TerminologyCapabilitiesCodeSystemVersion

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesCodeSystemVersion

Bases: BackboneElement

For the code system, a list of versions that are supported by the server.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	String | None	Version identifier for this version	None
code_ext	Element | None	Placeholder element for code extensions	None
isDefault	Boolean | None	If this is the default version for this code system	None
isDefault_ext	Element | None	Placeholder element for isDefault extensions	None
compositional	Boolean | None	If compositional grammar is supported	None
compositional_ext	Element | None	Placeholder element for compositional extensions	None
language	List[Code] | None	Language Displays supported	None
language_ext	Element | None	Placeholder element for language extensions	None
filter	List[TerminologyCapabilitiesCodeSystemVersionFilter] | None	Filter Properties supported	None
property_	List[Code] | None	Properties supported for $lookup	None
property_ext	Element | None	Placeholder element for property extensions	None

TerminologyCapabilitiesCodeSystemVersionFilter

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesCodeSystemVersionFilter

Bases: BackboneElement

Filter Properties supported.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Code of the property supported	None
code_ext	Element | None	Placeholder element for code extensions	None
op	List[Code] | None	Operations supported for the property	None
op_ext	Element | None	Placeholder element for op extensions	None

TerminologyCapabilitiesExpansion

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesExpansion

Bases: BackboneElement

Information about the ValueSet/$expand operation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
hierarchical	Boolean | None	Whether the server can return nested value sets	None
hierarchical_ext	Element | None	Placeholder element for hierarchical extensions	None
paging	Boolean | None	Whether the server supports paging on expansion	None
paging_ext	Element | None	Placeholder element for paging extensions	None
incomplete	Boolean | None	Allow request for incomplete expansions?	None
incomplete_ext	Element | None	Placeholder element for incomplete extensions	None
parameter	List[TerminologyCapabilitiesExpansionParameter] | None	Supported expansion parameter	None
textFilter	Markdown | None	Documentation about text searching works	None
textFilter_ext	Element | None	Placeholder element for textFilter extensions	None

TerminologyCapabilitiesExpansionParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesExpansionParameter

Bases: BackboneElement

Supported expansion parameter.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	Code | None	Expansion Parameter name	None
name_ext	Element | None	Placeholder element for name extensions	None
documentation	String | None	Description of support for parameter	None
documentation_ext	Element | None	Placeholder element for documentation extensions	None

TerminologyCapabilitiesImplementation

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesImplementation

Bases: BackboneElement

Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
description	String | None	Describes this specific instance	None
description_ext	Element | None	Placeholder element for description extensions	None
url	Url | None	Base URL for the implementation	None
url_ext	Element | None	Placeholder element for url extensions	None

TerminologyCapabilitiesSoftware

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesSoftware

Bases: BackboneElement

Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	A name the software is known by	None
name_ext	Element | None	Placeholder element for name extensions	None
version	String | None	Version covered by this statement	None
version_ext	Element | None	Placeholder element for version extensions	None

TerminologyCapabilitiesTranslation

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesTranslation

Bases: BackboneElement

Information about the ConceptMap/$translate operation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
needsMap	Boolean | None	Whether the client must identify the map	None
needsMap_ext	Element | None	Placeholder element for needsMap extensions	None

TerminologyCapabilitiesValidateCode

Path: fhircraft.fhir.resources.datatypes.R4.core.terminology_capabilities.TerminologyCapabilitiesValidateCode

Bases: BackboneElement

Information about the ValueSet/$validate-code operation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
translations	Boolean | None	Whether translations are validated	None
translations_ext	Element | None	Placeholder element for translations extensions	None

TestReport

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReport

Bases: DomainResource

A summary of information based on the results of executing a TestScript.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/TestReport'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	Identifier | None	External identifier	None
name	String | None	Informal name of the executed TestScript	None
name_ext	Element | None	Placeholder element for name extensions	None
status	Code | None	completed | in-progress | waiting | stopped | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
testScript	Reference | None	Reference to the version-specific TestScript that was executed to produce this TestReport	None
result	Code | None	pass | fail | pending	None
result_ext	Element | None	Placeholder element for result extensions	None
score	Decimal | None	The final score (percentage of tests passed) resulting from the execution of the TestScript	None
score_ext	Element | None	Placeholder element for score extensions	None
tester	String | None	Name of the tester producing this report (Organization or individual)	None
tester_ext	Element | None	Placeholder element for tester extensions	None
issued	DateTime | None	When the TestScript was executed and this TestReport was generated	None
issued_ext	Element | None	Placeholder element for issued extensions	None
participant	List[TestReportParticipant] | None	A participant in the test execution, either the execution engine, a client, or a server	None
setup	TestReportSetup | None	The results of the series of required setup operations before the tests were executed	None
test	List[TestReportTest] | None	A test executed from the test script	None
teardown	TestReportTeardown | None	The results of running the series of required clean up steps	None
resourceType	Literal['TestReport']		'TestReport'

TestReportParticipant

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportParticipant

Bases: BackboneElement

A participant in the test execution, either the execution engine, a client, or a server.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Code | None	test-engine | client | server	None
type_ext	Element | None	Placeholder element for type extensions	None
uri	Uri | None	The uri of the participant. An absolute URL is preferred	None
uri_ext	Element | None	Placeholder element for uri extensions	None
display	String | None	The display name of the participant	None
display_ext	Element | None	Placeholder element for display extensions	None

TestReportSetup

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportSetup

Bases: BackboneElement

The results of the series of required setup operations before the tests were executed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
action	List[TestReportSetupAction] | None	A setup operation or assert that was executed	None

TestReportSetupAction

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportSetupAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
operation	TestReportSetupActionOperation | None	The operation to perform	None
assert_	TestReportSetupActionAssert | None	The assertion to perform	None

TestReportSetupActionAssert

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportSetupActionAssert

Bases: BackboneElement

The results of the assertion performed on the previous operations.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
result	Code | None	pass | skip | fail | warning | error	None
result_ext	Element | None	Placeholder element for result extensions	None
message	Markdown | None	A message associated with the result	None
message_ext	Element | None	Placeholder element for message extensions	None
detail	String | None	A link to further details on the result	None
detail_ext	Element | None	Placeholder element for detail extensions	None

TestReportSetupActionOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportSetupActionOperation

Bases: BackboneElement

The operation performed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
result	Code | None	pass | skip | fail | warning | error	None
result_ext	Element | None	Placeholder element for result extensions	None
message	Markdown | None	A message associated with the result	None
message_ext	Element | None	Placeholder element for message extensions	None
detail	Uri | None	A link to further details on the result	None
detail_ext	Element | None	Placeholder element for detail extensions	None

TestReportTeardown

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportTeardown

Bases: BackboneElement

The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
action	List[TestReportTeardownAction] | None	One or more teardown operations performed	None

TestReportTeardownAction

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportTeardownAction

Bases: BackboneElement

The teardown action will only contain an operation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
operation	TestReportSetupActionOperation | None	The teardown operation performed	None

TestReportTest

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportTest

Bases: BackboneElement

A test executed from the test script.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Tracking/logging name of this test	None
name_ext	Element | None	Placeholder element for name extensions	None
description	String | None	Tracking/reporting short description of the test	None
description_ext	Element | None	Placeholder element for description extensions	None
action	List[TestReportTestAction] | None	A test operation or assert that was performed	None

TestReportTestAction

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportTestAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
operation	TestReportTestActionOperation | None	The operation performed	None
assert_	TestReportTestActionAssert | None	The assertion performed	None

TestReportTestActionAssert

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportTestActionAssert

Bases: BackboneElement

The results of the assertion performed on the previous operations.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
result	Code | None	pass | skip | fail | warning | error	None
result_ext	Element | None	Placeholder element for result extensions	None
message	Markdown | None	A message associated with the result	None
message_ext	Element | None	Placeholder element for message extensions	None
detail	String | None	A link to further details on the result	None
detail_ext	Element | None	Placeholder element for detail extensions	None

TestReportTestActionOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.test_report.TestReportTestActionOperation

Bases: BackboneElement

An operation would involve a REST request to a server.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
result	Code | None	pass | skip | fail | warning | error	None
result_ext	Element | None	Placeholder element for result extensions	None
message	Markdown | None	A message associated with the result	None
message_ext	Element | None	Placeholder element for message extensions	None
detail	Uri | None	A link to further details on the result	None
detail_ext	Element | None	Placeholder element for detail extensions	None

TestScript

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScript

Bases: DomainResource

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/TestScript'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this test script, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	Identifier | None	Additional identifier for the test script	None
version	String | None	Business version of the test script	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this test script (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this test script (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the test script	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for test script (if applicable)	None
purpose	Markdown | None	Why this test script is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
origin	List[TestScriptOrigin] | None	An abstract server representing a client or sender in a message exchange	None
destination	List[TestScriptDestination] | None	An abstract server representing a destination or receiver in a message exchange	None
metadata	TestScriptMetadata | None	Required capability that is assumed to function correctly on the FHIR server being tested	None
fixture	List[TestScriptFixture] | None	Fixture in the test script - by reference (uri)	None
profile	List[Reference] | None	Reference of the validation profile	None
variable	List[TestScriptVariable] | None	Placeholder for evaluated elements	None
setup	TestScriptSetup | None	A series of required setup operations before tests are executed	None
test	List[TestScriptTest] | None	A test in this script	None
teardown	TestScriptTeardown | None	A series of required clean up steps	None
resourceType	Literal['TestScript']		'TestScript'

TestScriptDestination

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptDestination

Bases: BackboneElement

An abstract server used in operations within this test script in the destination element.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
index	Integer | None	The index of the abstract destination server starting at 1	None
index_ext	Element | None	Placeholder element for index extensions	None
profile	Coding | None	FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor	None

TestScriptFixture

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptFixture

Bases: BackboneElement

Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
autocreate	Boolean | None	Whether or not to implicitly create the fixture during setup	None
autocreate_ext	Element | None	Placeholder element for autocreate extensions	None
autodelete	Boolean | None	Whether or not to implicitly delete the fixture during teardown	None
autodelete_ext	Element | None	Placeholder element for autodelete extensions	None
resource	Reference | None	Reference of the resource	None

TestScriptMetadata

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptMetadata

Bases: BackboneElement

The required capability must exist and are assumed to function correctly on the FHIR server being tested.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
link	List[TestScriptMetadataLink] | None	Links to the FHIR specification	None
capability	List[TestScriptMetadataCapability] | None	Capabilities that are assumed to function correctly on the FHIR server being tested	None

TestScriptMetadataCapability

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptMetadataCapability

Bases: BackboneElement

Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
required	Boolean | None	Are the capabilities required?	None
required_ext	Element | None	Placeholder element for required extensions	None
validated	Boolean | None	Are the capabilities validated?	None
validated_ext	Element | None	Placeholder element for validated extensions	None
description	String | None	The expected capabilities of the server	None
description_ext	Element | None	Placeholder element for description extensions	None
origin	List[Integer] | None	Which origin server these requirements apply to	None
origin_ext	Element | None	Placeholder element for origin extensions	None
destination	Integer | None	Which server these requirements apply to	None
destination_ext	Element | None	Placeholder element for destination extensions	None
link	List[Uri] | None	Links to the FHIR specification	None
link_ext	Element | None	Placeholder element for link extensions	None
capabilities	Canonical | None	Required Capability Statement	None
capabilities_ext	Element | None	Placeholder element for capabilities extensions	None

TestScriptMetadataLink

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptMetadataLink

Bases: BackboneElement

A link to the FHIR specification that this test is covering.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
url	Uri | None	URL to the specification	None
url_ext	Element | None	Placeholder element for url extensions	None
description	String | None	Short description	None
description_ext	Element | None	Placeholder element for description extensions	None

TestScriptOrigin

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptOrigin

Bases: BackboneElement

An abstract server used in operations within this test script in the origin element.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
index	Integer | None	The index of the abstract origin server starting at 1	None
index_ext	Element | None	Placeholder element for index extensions	None
profile	Coding | None	FHIR-Client | FHIR-SDC-FormFiller	None

TestScriptSetup

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptSetup

Bases: BackboneElement

A series of required setup operations before tests are executed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
action	List[TestScriptSetupAction] | None	A setup operation or assert to perform	None

TestScriptSetupAction

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptSetupAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
operation	TestScriptSetupActionOperation | None	The setup operation to perform	None
assert_	TestScriptSetupActionAssert | None	The assertion to perform	None

TestScriptSetupActionAssert

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptSetupActionAssert

Bases: BackboneElement

Evaluates the results of previous operations to determine if the server under test behaves appropriately.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
label	String | None	Tracking/logging assertion label	None
label_ext	Element | None	Placeholder element for label extensions	None
description	String | None	Tracking/reporting assertion description	None
description_ext	Element | None	Placeholder element for description extensions	None
direction	Code | None	response | request	None
direction_ext	Element | None	Placeholder element for direction extensions	None
compareToSourceId	String | None	Id of the source fixture to be evaluated	None
compareToSourceId_ext	Element | None	Placeholder element for compareToSourceId extensions	None
compareToSourceExpression	String | None	The FHIRPath expression to evaluate against the source fixture	None
compareToSourceExpression_ext	Element | None	Placeholder element for compareToSourceExpression extensions	None
compareToSourcePath	String | None	XPath or JSONPath expression to evaluate against the source fixture	None
compareToSourcePath_ext	Element | None	Placeholder element for compareToSourcePath extensions	None
contentType	Code | None	Mime type to compare against the 'Content-Type' header	None
contentType_ext	Element | None	Placeholder element for contentType extensions	None
expression	String | None	The FHIRPath expression to be evaluated	None
expression_ext	Element | None	Placeholder element for expression extensions	None
headerField	String | None	HTTP header field name	None
headerField_ext	Element | None	Placeholder element for headerField extensions	None
minimumId	String | None	Fixture Id of minimum content resource	None
minimumId_ext	Element | None	Placeholder element for minimumId extensions	None
navigationLinks	Boolean | None	Perform validation on navigation links?	None
navigationLinks_ext	Element | None	Placeholder element for navigationLinks extensions	None
operator	Code | None	equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval	None
operator_ext	Element | None	Placeholder element for operator extensions	None
path	String | None	XPath or JSONPath expression	None
path_ext	Element | None	Placeholder element for path extensions	None
requestMethod	Code | None	delete | get | options | patch | post | put | head	None
requestMethod_ext	Element | None	Placeholder element for requestMethod extensions	None
requestURL	String | None	Request URL comparison value	None
requestURL_ext	Element | None	Placeholder element for requestURL extensions	None
resource	Code | None	Resource type	None
resource_ext	Element | None	Placeholder element for resource extensions	None
response	Code | None	okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable	None
response_ext	Element | None	Placeholder element for response extensions	None
responseCode	String | None	HTTP response code to test	None
responseCode_ext	Element | None	Placeholder element for responseCode extensions	None
sourceId	Id | None	Fixture Id of source expression or headerField	None
sourceId_ext	Element | None	Placeholder element for sourceId extensions	None
validateProfileId	Id | None	Profile Id of validation profile reference	None
validateProfileId_ext	Element | None	Placeholder element for validateProfileId extensions	None
value	String | None	The value to compare to	None
value_ext	Element | None	Placeholder element for value extensions	None
warningOnly	Boolean | None	Will this assert produce a warning only on error?	None
warningOnly_ext	Element | None	Placeholder element for warningOnly extensions	None

TestScriptSetupActionOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptSetupActionOperation

Bases: BackboneElement

The operation to perform.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Coding | None	The operation code type that will be executed	None
resource	Code | None	Resource type	None
resource_ext	Element | None	Placeholder element for resource extensions	None
label	String | None	Tracking/logging operation label	None
label_ext	Element | None	Placeholder element for label extensions	None
description	String | None	Tracking/reporting operation description	None
description_ext	Element | None	Placeholder element for description extensions	None
accept	Code | None	Mime type to accept in the payload of the response, with charset etc.	None
accept_ext	Element | None	Placeholder element for accept extensions	None
contentType	Code | None	Mime type of the request payload contents, with charset etc.	None
contentType_ext	Element | None	Placeholder element for contentType extensions	None
destination	Integer | None	Server responding to the request	None
destination_ext	Element | None	Placeholder element for destination extensions	None
encodeRequestUrl	Boolean | None	Whether or not to send the request url in encoded format	None
encodeRequestUrl_ext	Element | None	Placeholder element for encodeRequestUrl extensions	None
method	Code | None	delete | get | options | patch | post | put | head	None
method_ext	Element | None	Placeholder element for method extensions	None
origin	Integer | None	Server initiating the request	None
origin_ext	Element | None	Placeholder element for origin extensions	None
params	String | None	Explicitly defined path parameters	None
params_ext	Element | None	Placeholder element for params extensions	None
requestHeader	List[TestScriptSetupActionOperationRequestHeader] | None	Each operation can have one or more header elements	None
requestId	Id | None	Fixture Id of mapped request	None
requestId_ext	Element | None	Placeholder element for requestId extensions	None
responseId	Id | None	Fixture Id of mapped response	None
responseId_ext	Element | None	Placeholder element for responseId extensions	None
sourceId	Id | None	Fixture Id of body for PUT and POST requests	None
sourceId_ext	Element | None	Placeholder element for sourceId extensions	None
targetId	Id | None	Id of fixture used for extracting the [id], [type], and [vid] for GET requests	None
targetId_ext	Element | None	Placeholder element for targetId extensions	None
url	String | None	Request URL	None
url_ext	Element | None	Placeholder element for url extensions	None

TestScriptSetupActionOperationRequestHeader

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptSetupActionOperationRequestHeader

Bases: BackboneElement

Header elements would be used to set HTTP headers.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
field	String | None	HTTP header field name	None
field_ext	Element | None	Placeholder element for field extensions	None
value	String | None	HTTP headerfield value	None
value_ext	Element | None	Placeholder element for value extensions	None

TestScriptTeardown

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptTeardown

Bases: BackboneElement

A series of operations required to clean up after all the tests are executed (successfully or otherwise).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
action	List[TestScriptTeardownAction] | None	One or more teardown operations to perform	None

TestScriptTeardownAction

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptTeardownAction

Bases: BackboneElement

The teardown action will only contain an operation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
operation	TestScriptSetupActionOperation | None	The teardown operation to perform	None

TestScriptTest

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptTest

Bases: BackboneElement

A test in this script.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Tracking/logging name of this test	None
name_ext	Element | None	Placeholder element for name extensions	None
description	String | None	Tracking/reporting short description of the test	None
description_ext	Element | None	Placeholder element for description extensions	None
action	List[TestScriptTestAction] | None	A test operation or assert to perform	None

TestScriptTestAction

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptTestAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
operation	TestScriptTestActionOperation | None	The setup operation to perform	None
assert_	TestScriptTestActionAssert | None	The setup assertion to perform	None

TestScriptTestActionAssert

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptTestActionAssert

Bases: BackboneElement

Evaluates the results of previous operations to determine if the server under test behaves appropriately.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
label	String | None	Tracking/logging assertion label	None
label_ext	Element | None	Placeholder element for label extensions	None
description	String | None	Tracking/reporting assertion description	None
description_ext	Element | None	Placeholder element for description extensions	None
direction	Code | None	response | request	None
direction_ext	Element | None	Placeholder element for direction extensions	None
compareToSourceId	String | None	Id of the source fixture to be evaluated	None
compareToSourceId_ext	Element | None	Placeholder element for compareToSourceId extensions	None
compareToSourceExpression	String | None	The FHIRPath expression to evaluate against the source fixture	None
compareToSourceExpression_ext	Element | None	Placeholder element for compareToSourceExpression extensions	None
compareToSourcePath	String | None	XPath or JSONPath expression to evaluate against the source fixture	None
compareToSourcePath_ext	Element | None	Placeholder element for compareToSourcePath extensions	None
contentType	Code | None	Mime type to compare against the 'Content-Type' header	None
contentType_ext	Element | None	Placeholder element for contentType extensions	None
expression	String | None	The FHIRPath expression to be evaluated	None
expression_ext	Element | None	Placeholder element for expression extensions	None
headerField	String | None	HTTP header field name	None
headerField_ext	Element | None	Placeholder element for headerField extensions	None
minimumId	String | None	Fixture Id of minimum content resource	None
minimumId_ext	Element | None	Placeholder element for minimumId extensions	None
navigationLinks	Boolean | None	Perform validation on navigation links?	None
navigationLinks_ext	Element | None	Placeholder element for navigationLinks extensions	None
operator	Code | None	equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval	None
operator_ext	Element | None	Placeholder element for operator extensions	None
path	String | None	XPath or JSONPath expression	None
path_ext	Element | None	Placeholder element for path extensions	None
requestMethod	Code | None	delete | get | options | patch | post | put | head	None
requestMethod_ext	Element | None	Placeholder element for requestMethod extensions	None
requestURL	String | None	Request URL comparison value	None
requestURL_ext	Element | None	Placeholder element for requestURL extensions	None
resource	Code | None	Resource type	None
resource_ext	Element | None	Placeholder element for resource extensions	None
response	Code | None	okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable	None
response_ext	Element | None	Placeholder element for response extensions	None
responseCode	String | None	HTTP response code to test	None
responseCode_ext	Element | None	Placeholder element for responseCode extensions	None
sourceId	Id | None	Fixture Id of source expression or headerField	None
sourceId_ext	Element | None	Placeholder element for sourceId extensions	None
validateProfileId	Id | None	Profile Id of validation profile reference	None
validateProfileId_ext	Element | None	Placeholder element for validateProfileId extensions	None
value	String | None	The value to compare to	None
value_ext	Element | None	Placeholder element for value extensions	None
warningOnly	Boolean | None	Will this assert produce a warning only on error?	None
warningOnly_ext	Element | None	Placeholder element for warningOnly extensions	None

TestScriptTestActionOperation

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptTestActionOperation

Bases: BackboneElement

An operation would involve a REST request to a server.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
type	Coding | None	The operation code type that will be executed	None
resource	Code | None	Resource type	None
resource_ext	Element | None	Placeholder element for resource extensions	None
label	String | None	Tracking/logging operation label	None
label_ext	Element | None	Placeholder element for label extensions	None
description	String | None	Tracking/reporting operation description	None
description_ext	Element | None	Placeholder element for description extensions	None
accept	Code | None	Mime type to accept in the payload of the response, with charset etc.	None
accept_ext	Element | None	Placeholder element for accept extensions	None
contentType	Code | None	Mime type of the request payload contents, with charset etc.	None
contentType_ext	Element | None	Placeholder element for contentType extensions	None
destination	Integer | None	Server responding to the request	None
destination_ext	Element | None	Placeholder element for destination extensions	None
encodeRequestUrl	Boolean | None	Whether or not to send the request url in encoded format	None
encodeRequestUrl_ext	Element | None	Placeholder element for encodeRequestUrl extensions	None
method	Code | None	delete | get | options | patch | post | put | head	None
method_ext	Element | None	Placeholder element for method extensions	None
origin	Integer | None	Server initiating the request	None
origin_ext	Element | None	Placeholder element for origin extensions	None
params	String | None	Explicitly defined path parameters	None
params_ext	Element | None	Placeholder element for params extensions	None
requestHeader	List[TestScriptSetupActionOperationRequestHeader] | None	Each operation can have one or more header elements	None
requestId	Id | None	Fixture Id of mapped request	None
requestId_ext	Element | None	Placeholder element for requestId extensions	None
responseId	Id | None	Fixture Id of mapped response	None
responseId_ext	Element | None	Placeholder element for responseId extensions	None
sourceId	Id | None	Fixture Id of body for PUT and POST requests	None
sourceId_ext	Element | None	Placeholder element for sourceId extensions	None
targetId	Id | None	Id of fixture used for extracting the [id], [type], and [vid] for GET requests	None
targetId_ext	Element | None	Placeholder element for targetId extensions	None
url	String | None	Request URL	None
url_ext	Element | None	Placeholder element for url extensions	None

TestScriptVariable

Path: fhircraft.fhir.resources.datatypes.R4.core.test_script.TestScriptVariable

Bases: BackboneElement

Variable is set based either on element value in response body or on header field value in the response headers.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Descriptive name for this variable	None
name_ext	Element | None	Placeholder element for name extensions	None
defaultValue	String | None	Default, hard-coded, or user-defined value for this variable	None
defaultValue_ext	Element | None	Placeholder element for defaultValue extensions	None
description	String | None	Natural language description of the variable	None
description_ext	Element | None	Placeholder element for description extensions	None
expression	String | None	The FHIRPath expression against the fixture body	None
expression_ext	Element | None	Placeholder element for expression extensions	None
headerField	String | None	HTTP header field name for source	None
headerField_ext	Element | None	Placeholder element for headerField extensions	None
hint	String | None	Hint help text for default value to enter	None
hint_ext	Element | None	Placeholder element for hint extensions	None
path	String | None	XPath or JSONPath against the fixture body	None
path_ext	Element | None	Placeholder element for path extensions	None
sourceId	Id | None	Fixture Id of source expression or headerField within this variable	None
sourceId_ext	Element | None	Placeholder element for sourceId extensions	None

ValueSet

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSet

Bases: DomainResource

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/ValueSet'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
url	Uri | None	Canonical identifier for this value set, represented as a URI (globally unique)	None
url_ext	Element | None	Placeholder element for url extensions	None
identifier	List[Identifier] | None	Additional identifier for the value set (business identifier)	None
version	String | None	Business version of the value set	None
version_ext	Element | None	Placeholder element for version extensions	None
name	String | None	Name for this value set (computer friendly)	None
name_ext	Element | None	Placeholder element for name extensions	None
title	String | None	Name for this value set (human friendly)	None
title_ext	Element | None	Placeholder element for title extensions	None
status	Code | None	draft | active | retired | unknown	None
status_ext	Element | None	Placeholder element for status extensions	None
experimental	Boolean | None	For testing purposes, not real usage	None
experimental_ext	Element | None	Placeholder element for experimental extensions	None
date	DateTime | None	Date last changed	None
date_ext	Element | None	Placeholder element for date extensions	None
publisher	String | None	Name of the publisher (organization or individual)	None
publisher_ext	Element | None	Placeholder element for publisher extensions	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Markdown | None	Natural language description of the value set	None
description_ext	Element | None	Placeholder element for description extensions	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for value set (if applicable)	None
immutable	Boolean | None	Indicates whether or not any change to the content logical definition may occur	None
immutable_ext	Element | None	Placeholder element for immutable extensions	None
purpose	Markdown | None	Why this value set is defined	None
purpose_ext	Element | None	Placeholder element for purpose extensions	None
copyright	Markdown | None	Use and/or publishing restrictions	None
copyright_ext	Element | None	Placeholder element for copyright extensions	None
compose	ValueSetCompose | None	Content logical definition of the value set (CLD)	None
expansion	ValueSetExpansion | None	Used when the value set is "expanded"	None
resourceType	Literal['ValueSet']		'ValueSet'

ValueSetCompose

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetCompose

Bases: BackboneElement

A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
lockedDate	Date | None	Fixed date for references with no specified version (transitive)	None
lockedDate_ext	Element | None	Placeholder element for lockedDate extensions	None
inactive	Boolean | None	Whether inactive codes are in the value set	None
inactive_ext	Element | None	Placeholder element for inactive extensions	None
include	List[ValueSetComposeInclude] | None	Include one or more codes from a code system or other value set(s)	None
exclude	List[ValueSetComposeExclude] | None	Explicitly exclude codes from a code system or other value sets	None

ValueSetComposeExclude

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetComposeExclude

Bases: BackboneElement

Exclude one or more codes from the value set based on code system filters and/or other value sets.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
system	Uri | None	The system the codes come from	None
system_ext	Element | None	Placeholder element for system extensions	None
version	String | None	Specific version of the code system referred to	None
version_ext	Element | None	Placeholder element for version extensions	None
concept	List[ValueSetComposeIncludeConcept] | None	A concept defined in the system	None
filter	List[ValueSetComposeIncludeFilter] | None	Select codes/concepts by their properties (including relationships)	None
valueSet	List[Canonical] | None	Select the contents included in this value set	None
valueSet_ext	Element | None	Placeholder element for valueSet extensions	None

ValueSetComposeInclude

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetComposeInclude

Bases: BackboneElement

Include one or more codes from a code system or other value set(s).

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
system	Uri | None	The system the codes come from	None
system_ext	Element | None	Placeholder element for system extensions	None
version	String | None	Specific version of the code system referred to	None
version_ext	Element | None	Placeholder element for version extensions	None
concept	List[ValueSetComposeIncludeConcept] | None	A concept defined in the system	None
filter	List[ValueSetComposeIncludeFilter] | None	Select codes/concepts by their properties (including relationships)	None
valueSet	List[Canonical] | None	Select the contents included in this value set	None
valueSet_ext	Element | None	Placeholder element for valueSet extensions	None

ValueSetComposeIncludeConcept

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetComposeIncludeConcept

Bases: BackboneElement

Specifies a concept to be included or excluded.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
code	Code | None	Code or expression from system	None
code_ext	Element | None	Placeholder element for code extensions	None
display	String | None	Text to display for this code for this value set in this valueset	None
display_ext	Element | None	Placeholder element for display extensions	None
designation	List[ValueSetComposeIncludeConceptDesignation] | None	Additional representations for this concept	None

ValueSetComposeIncludeConceptDesignation

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetComposeIncludeConceptDesignation

Bases: BackboneElement

Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
language	Code | None	Human language of the designation	None
language_ext	Element | None	Placeholder element for language extensions	None
use	Coding | None	Types of uses of designations	None
value	String | None	The text value for this designation	None
value_ext	Element | None	Placeholder element for value extensions	None

ValueSetComposeIncludeFilter

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetComposeIncludeFilter

Bases: BackboneElement

Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
property_	Code | None	A property/filter defined by the code system	None
property_ext	Element | None	Placeholder element for property extensions	None
op	Code | None	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists	None
op_ext	Element | None	Placeholder element for op extensions	None
value	String | None	Code from the system, or regex criteria, or boolean value for exists	None
value_ext	Element | None	Placeholder element for value extensions	None

ValueSetExpansion

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetExpansion

Bases: BackboneElement

A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
identifier	Uri | None	Identifies the value set expansion (business identifier)	None
identifier_ext	Element | None	Placeholder element for identifier extensions	None
timestamp	DateTime | None	Time ValueSet expansion happened	None
timestamp_ext	Element | None	Placeholder element for timestamp extensions	None
total	Integer | None	Total number of codes in the expansion	None
total_ext	Element | None	Placeholder element for total extensions	None
offset	Integer | None	Offset at which this resource starts	None
offset_ext	Element | None	Placeholder element for offset extensions	None
parameter	List[ValueSetExpansionParameter] | None	Parameter that controlled the expansion process	None
contains	List[ValueSetExpansionContains] | None	Codes in the value set	None

ValueSetExpansionContains

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetExpansionContains

Bases: BackboneElement

The codes that are contained in the value set expansion.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
system	Uri | None	System value for the code	None
system_ext	Element | None	Placeholder element for system extensions	None
abstract	Boolean | None	If user cannot select this entry	None
abstract_ext	Element | None	Placeholder element for abstract extensions	None
inactive	Boolean | None	If concept is inactive in the code system	None
inactive_ext	Element | None	Placeholder element for inactive extensions	None
version	String | None	Version in which this code/display is defined	None
version_ext	Element | None	Placeholder element for version extensions	None
code	Code | None	Code - if blank, this is not a selectable code	None
code_ext	Element | None	Placeholder element for code extensions	None
display	String | None	User display for the concept	None
display_ext	Element | None	Placeholder element for display extensions	None
designation	List[ValueSetExpansionContainsDesignation] | None	Additional representations for this item	None
contains	List[ValueSetExpansionContains] | None	Codes contained under this entry	None

ValueSetExpansionContainsDesignation

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetExpansionContainsDesignation

Bases: BackboneElement

Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
language	Code | None	Human language of the designation	None
language_ext	Element | None	Placeholder element for language extensions	None
use	Coding | None	Types of uses of designations	None
value	String | None	The text value for this designation	None
value_ext	Element | None	Placeholder element for value extensions	None

ValueSetExpansionParameter

Path: fhircraft.fhir.resources.datatypes.R4.core.value_set.ValueSetExpansionParameter

Bases: BackboneElement

A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
name	String | None	Name as assigned by the client or server	None
name_ext	Element | None	Placeholder element for name extensions	None
valueString	String | None	Value of the named parameter	None
valueString_ext	Element | None	Placeholder element for valueString extensions	None
valueBoolean	Boolean | None	Value of the named parameter	None
valueBoolean_ext	Element | None	Placeholder element for valueBoolean extensions	None
valueInteger	Integer | None	Value of the named parameter	None
valueInteger_ext	Element | None	Placeholder element for valueInteger extensions	None
valueDecimal	Decimal | None	Value of the named parameter	None
valueDecimal_ext	Element | None	Placeholder element for valueDecimal extensions	None
valueUri	Uri | None	Value of the named parameter	None
valueUri_ext	Element | None	Placeholder element for valueUri extensions	None
valueCode	Code | None	Value of the named parameter	None
valueCode_ext	Element | None	Placeholder element for valueCode extensions	None
valueDateTime	DateTime | None	Value of the named parameter	None
valueDateTime_ext	Element | None	Placeholder element for valueDateTime extensions	None

VerificationResult

Path: fhircraft.fhir.resources.datatypes.R4.core.verification_result.VerificationResult

Bases: DomainResource

Describes validation requirements, source(s), status and dates for one or more elements.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/VerificationResult'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
target	List[Reference] | None	A resource that was validated	None
targetLocation	List[String] | None	The fhirpath location(s) within the resource that was validated	None
targetLocation_ext	Element | None	Placeholder element for targetLocation extensions	None
need	CodeableConcept | None	none | initial | periodic	None
status	Code | None	attested | validated | in-process | req-revalid | val-fail | reval-fail	None
status_ext	Element | None	Placeholder element for status extensions	None
statusDate	DateTime | None	When the validation status was updated	None
statusDate_ext	Element | None	Placeholder element for statusDate extensions	None
validationType	CodeableConcept | None	nothing | primary | multiple	None
validationProcess	List[CodeableConcept] | None	The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)	None
frequency	Timing | None	Frequency of revalidation	None
lastPerformed	DateTime | None	The date/time validation was last completed (including failed validations)	None
lastPerformed_ext	Element | None	Placeholder element for lastPerformed extensions	None
nextScheduled	Date | None	The date when target is next validated, if appropriate	None
nextScheduled_ext	Element | None	Placeholder element for nextScheduled extensions	None
failureAction	CodeableConcept | None	fatal | warn | rec-only | none	None
primarySource	List[VerificationResultPrimarySource] | None	Information about the primary source(s) involved in validation	None
attestation	VerificationResultAttestation | None	Information about the entity attesting to information	None
validator	List[VerificationResultValidator] | None	Information about the entity validating information	None
resourceType	Literal['VerificationResult']		'VerificationResult'

VerificationResultAttestation

Path: fhircraft.fhir.resources.datatypes.R4.core.verification_result.VerificationResultAttestation

Bases: BackboneElement

Information about the entity attesting to information.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
who	Reference | None	The individual or organization attesting to information	None
onBehalfOf	Reference | None	When the who is asserting on behalf of another (organization or individual)	None
communicationMethod	CodeableConcept | None	The method by which attested information was submitted/retrieved	None
date	Date | None	The date the information was attested to	None
date_ext	Element | None	Placeholder element for date extensions	None
sourceIdentityCertificate	String | None	A digital identity certificate associated with the attestation source	None
sourceIdentityCertificate_ext	Element | None	Placeholder element for sourceIdentityCertificate extensions	None
proxyIdentityCertificate	String | None	A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source	None
proxyIdentityCertificate_ext	Element | None	Placeholder element for proxyIdentityCertificate extensions	None
proxySignature	Signature | None	Proxy signature	None
sourceSignature	Signature | None	Attester signature	None

VerificationResultPrimarySource

Path: fhircraft.fhir.resources.datatypes.R4.core.verification_result.VerificationResultPrimarySource

Bases: BackboneElement

Information about the primary source(s) involved in validation.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
who	Reference | None	Reference to the primary source	None
type	List[CodeableConcept] | None	Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)	None
communicationMethod	List[CodeableConcept] | None	Method for exchanging information with the primary source	None
validationStatus	CodeableConcept | None	successful | failed | unknown	None
validationDate	DateTime | None	When the target was validated against the primary source	None
validationDate_ext	Element | None	Placeholder element for validationDate extensions	None
canPushUpdates	CodeableConcept | None	yes | no | undetermined	None
pushTypeAvailable	List[CodeableConcept] | None	specific | any | source	None

VerificationResultValidator

Path: fhircraft.fhir.resources.datatypes.R4.core.verification_result.VerificationResultValidator

Bases: BackboneElement

Information about the entity validating information.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
organization	Reference | None	Reference to the organization validating information	None
identityCertificate	String | None	A digital identity certificate associated with the validator	None
identityCertificate_ext	Element | None	Placeholder element for identityCertificate extensions	None
attestationSignature	Signature | None	Validator signature	None

VisionPrescription

Path: fhircraft.fhir.resources.datatypes.R4.core.vision_prescription.VisionPrescription

Bases: DomainResource

An authorization for the provision of glasses and/or contact lenses to a patient.

Parameters:

Name	Type	Description	Default
id	String | None	Logical id of this artifact	None
id_ext	Element | None	Placeholder element for id extensions	None
meta	Meta | None	Metadata about the resource.	Meta(profile=['http://hl7.org/fhir/StructureDefinition/VisionPrescription'])
implicitRules	Uri | None	A set of rules under which this content was created	None
implicitRules_ext	Element | None	Placeholder element for implicitRules extensions	None
language	Code | None	Language of the resource content	None
language_ext	Element | None	Placeholder element for language extensions	None
text	Narrative | None	Text summary of the resource, for human interpretation	None
contained	List[Resource] | None	Contained, inline Resources	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored	None
identifier	List[Identifier] | None	Business Identifier for vision prescription	None
status	Code | None	active | cancelled | draft | entered-in-error	None
status_ext	Element | None	Placeholder element for status extensions	None
created	DateTime | None	Response creation date	None
created_ext	Element | None	Placeholder element for created extensions	None
patient	Reference | None	Who prescription is for	None
encounter	Reference | None	Created during encounter / admission / stay	None
dateWritten	DateTime | None	When prescription was authorized	None
dateWritten_ext	Element | None	Placeholder element for dateWritten extensions	None
prescriber	Reference | None	Who authorized the vision prescription	None
lensSpecification	List[VisionPrescriptionLensSpecification] | None	Vision lens authorization	None
resourceType	Literal['VisionPrescription']		'VisionPrescription'

VisionPrescriptionLensSpecification

Path: fhircraft.fhir.resources.datatypes.R4.core.vision_prescription.VisionPrescriptionLensSpecification

Bases: BackboneElement

Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
product	CodeableConcept | None	Product to be supplied	None
eye	Code | None	right | left	None
eye_ext	Element | None	Placeholder element for eye extensions	None
sphere	Decimal | None	Power of the lens	None
sphere_ext	Element | None	Placeholder element for sphere extensions	None
cylinder	Decimal | None	Lens power for astigmatism	None
cylinder_ext	Element | None	Placeholder element for cylinder extensions	None
axis	Integer | None	Lens meridian which contain no power for astigmatism	None
axis_ext	Element | None	Placeholder element for axis extensions	None
prism	List[VisionPrescriptionLensSpecificationPrism] | None	Eye alignment compensation	None
add	Decimal | None	Added power for multifocal levels	None
add_ext	Element | None	Placeholder element for add extensions	None
power	Decimal | None	Contact lens power	None
power_ext	Element | None	Placeholder element for power extensions	None
backCurve	Decimal | None	Contact lens back curvature	None
backCurve_ext	Element | None	Placeholder element for backCurve extensions	None
diameter	Decimal | None	Contact lens diameter	None
diameter_ext	Element | None	Placeholder element for diameter extensions	None
duration	Quantity | None	Lens wear duration	None
color	String | None	Color required	None
color_ext	Element | None	Placeholder element for color extensions	None
brand	String | None	Brand required	None
brand_ext	Element | None	Placeholder element for brand extensions	None
note	List[Annotation] | None	Notes for coatings	None

VisionPrescriptionLensSpecificationPrism

Path: fhircraft.fhir.resources.datatypes.R4.core.vision_prescription.VisionPrescriptionLensSpecificationPrism

Bases: BackboneElement

Allows for adjustment on two axis.

Parameters:

Name	Type	Description	Default
id	String | None	Unique id for inter-element referencing	None
id_ext	Element | None	Placeholder element for id extensions	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
amount	Decimal | None	Amount of adjustment	None
amount_ext	Element | None	Placeholder element for amount extensions	None
base	Code | None	up | down | in | out	None
base_ext	Element | None	Placeholder element for base extensions	None