FHIR R5 Core Resources

Classes representing FHIR R5 core resources.

Account

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | inactive | entered-in-error | on-hold | unknown	None
billingStatus	CodeableConcept | None	Tracks the lifecycle of the account through the billing process	None
type	CodeableConcept | None	E.g. patient, expense, depreciation	None
name	Annotated[str | String, BeforeValidator] | None	Human-readable label	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	Annotated[str | Markdown, BeforeValidator] | None	Explanation of purpose/use	None
guarantor	List[AccountGuarantor] | None	The parties ultimately responsible for balancing the Account	None
diagnosis	List[AccountDiagnosis] | None	The ListType of diagnoses relevant to this account	None
procedure	List[AccountProcedure] | None	The ListType of procedures relevant to this account	None
relatedAccount	List[AccountRelatedAccount] | None	Other associated accounts related to this account	None
currency	CodeableConcept | None	The base or default currency	None
balance	List[AccountBalance] | None	Calculated account balance(s)	None
calculatedAt	Annotated[datetime | Instant, BeforeValidator] | None	time the balance amount was calculated	None

AccountBalance

Path: fhircraft.fhir.resources.datatypes.R5.core.account.AccountBalance

Bases: BackboneElement

The calculated account balances - these are calculated and processed by the finance system.

The balances with a term that is not current are usually generated/updated by an invoicing or similar process.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
aggregate	CodeableConcept | None	Who is expected to pay this part of the balance	None
term	CodeableConcept | None	current | 30 | 60 | 90 | 120	None
estimate	Annotated[bool | Boolean, BeforeValidator] | None	Estimated balance	None
amount	Money | None	Calculated amount	None

AccountCoverage

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	The priority of the coverage in the context of this account	None

AccountDiagnosis

Path: fhircraft.fhir.resources.datatypes.R5.core.account.AccountDiagnosis

Bases: BackboneElement

When using an account for billing a specific Encounter the set of diagnoses that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Ranking of the diagnosis (for each type)	None
condition	CodeableReference | None	The diagnosis relevant to the account	None
dateOfDiagnosis	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date of the diagnosis (when coded diagnosis)	None
type	List[CodeableConcept] | None	Type that this diagnosis has relevant to the account (e.g. admission, billing, discharge …)	None
onAdmission	Annotated[bool | Boolean, BeforeValidator] | None	Diagnosis present on Admission	None
packageCode	List[CodeableConcept] | None	Package code specific for billing	None

AccountGuarantor

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Credit or other hold applied	None
period	Period | None	Guarantee account during	None

AccountProcedure

Path: fhircraft.fhir.resources.datatypes.R5.core.account.AccountProcedure

Bases: BackboneElement

When using an account for billing a specific Encounter the set of procedures that are relevant for billing are stored here on the account where they are able to be sequenced appropriately prior to processing to produce claim(s).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Ranking of the procedure (for each type)	None
code	CodeableReference | None	The procedure relevant to the account	None
dateOfService	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date of the procedure (when coded procedure)	None
type	List[CodeableConcept] | None	How this procedure value should be used in charging the account	None
packageCode	List[CodeableConcept] | None	Package code specific for billing	None
device	List[Reference] | None	Any devices that were associated with the procedure	None

AccountRelatedAccount

Path: fhircraft.fhir.resources.datatypes.R5.core.account.AccountRelatedAccount

Bases: BackboneElement

Other associated accounts related to this account.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableConcept | None	Relationship of the associated Account	None
account	Reference | None	Reference to an associated Account	None

ActivityDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this activity definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the activity definition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the activity definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this activity definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this activity definition (human friendly)	None
subtitle	Annotated[str | String, BeforeValidator] | None	Subordinate title of the activity definition	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	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
subjectCanonical	Annotated[str | Canonical, BeforeValidator] | None	Type of individual the activity definition is intended for	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the activity definition	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	Annotated[str | Markdown, BeforeValidator] | None	Why this activity definition is defined	None
usage	Annotated[str | Markdown, BeforeValidator] | None	Describes the clinical usage of the activity definition	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the activity definition was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the activity definition was last reviewed by the publisher	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[Annotated[str | Canonical, BeforeValidator]] | None	Logic used by the activity definition	None
kind	Annotated[str | Code, BeforeValidator] | None	Kind of resource	None
profile	Annotated[str | Canonical, BeforeValidator] | None	What profile the resource needs to conform to	None
code	CodeableConcept | None	Detail type of activity	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
doNotPerform	Annotated[bool | Boolean, BeforeValidator] | None	True if the activity should not be performed	None
timingTiming	Timing | None	When activity is to occur	None
timingAge	Age | 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
asNeededBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Preconditions for service	None
asNeededCodeableConcept	CodeableConcept | None	Preconditions for service	None
location	CodeableReference | 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[Annotated[str | Canonical, BeforeValidator]] | None	What specimens are required to perform this action	None
observationRequirement	List[Annotated[str | Canonical, BeforeValidator]] | None	What observations are required to perform this action	None
observationResultRequirement	List[Annotated[str | Canonical, BeforeValidator]] | None	What observations must be produced by this action	None
transform	Annotated[str | Canonical, BeforeValidator] | None	Transform to apply the template	None
dynamicValue	List[ActivityDefinitionDynamicValue] | None	Dynamic aspects of the definition	None

ActivityDefinitionDynamicValue

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The path to the element to be set dynamically	None
expression	Expression | None	An expression that provides the dynamic value for the customization	None

ActivityDefinitionParticipant

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

Bases: BackboneElement

Indicates who should participate in performing the action described.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson	None
typeCanonical	Annotated[str | Canonical, BeforeValidator] | None	Who or what can participate	None
typeReference	Reference | None	Who or what can participate	None
role	CodeableConcept | None	E.g. Nurse, Surgeon, Parent, etc	None
function	CodeableConcept | None	E.g. Author, Reviewer, Witness, etc	None

ActorDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.actor_definition.ActorDefinition

Bases: DomainResource

The ActorDefinition resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this actor definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the actor definition (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the actor definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this actor definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this actor definition (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the actor	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for actor definition (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this actor definition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
type	Annotated[str | Code, BeforeValidator] | None	person | system	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Functionality associated with the actor	None
reference	List[Annotated[str | Url, BeforeValidator]] | None	Reference to more information about the actor	None
capabilities	Annotated[str | Canonical, BeforeValidator] | None	CapabilityStatement for the actor (if applicable)	None
derivedFrom	List[Annotated[str | Canonical, BeforeValidator]] | None	Definition of this actor in another context / IG	None

AdministrableProductDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.administrable_product_definition.AdministrableProductDefinition

Bases: DomainResource

A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 administrable product	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
formOf	List[Reference] | None	References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product	None
administrableDoseForm	CodeableConcept | None	The dose form of the final product after necessary reconstitution or processing	None
unitOfPresentation	CodeableConcept | None	The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'	None
producedFrom	List[Reference] | None	Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form	None
ingredient	List[CodeableConcept] | None	The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton, or using by incoming references from the Ingredient resource	None
device	Reference | None	A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product	None
description	Annotated[str | Markdown, BeforeValidator] | None	A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed	None
property_	List[AdministrableProductDefinitionProperty] | None	Characteristics e.g. a product's onset of action	None
routeOfAdministration	List[AdministrableProductDefinitionRouteOfAdministration] | None	The path by which the product is taken into or makes contact with the body	None

AdministrableProductDefinitionProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.administrable_product_definition.AdministrableProductDefinitionProperty

Bases: BackboneElement

Characteristics e.g. a product's onset of action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 expressing the type of characteristic	None
valueCodeableConcept	CodeableConcept | None	A value for the characteristic	None
valueQuantity	Quantity | None	A value for the characteristic	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	A value for the characteristic	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	A value for the characteristic	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	A value for the characteristic	None
valueAttachment	Attachment | None	A value for the characteristic	None
valueReference	Reference | None	A value for the characteristic	None
status	CodeableConcept | None	The status of characteristic e.g. assigned or pending	None

AdministrableProductDefinitionRouteOfAdministration

Path: fhircraft.fhir.resources.datatypes.R5.core.administrable_product_definition.AdministrableProductDefinitionRouteOfAdministration

Bases: BackboneElement

The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 can be specified for the product	None
maxSingleDose	Quantity | None	The maximum single dose that can be administered	None
maxDosePerDay	Quantity | None	The maximum dose quantity to be administered in any one 24-h period	None
maxDosePerTreatmentPeriod	Ratio | None	The maximum dose per treatment period that can be administered	None
maxTreatmentPeriod	Duration | None	The maximum treatment period during which the product can be administered	None
targetSpecies	List[AdministrableProductDefinitionRouteOfAdministrationTargetSpecies] | None	A species for which this route applies	None

AdministrableProductDefinitionRouteOfAdministrationTargetSpecies

Path: fhircraft.fhir.resources.datatypes.R5.core.administrable_product_definition.AdministrableProductDefinitionRouteOfAdministrationTargetSpecies

Bases: BackboneElement

A species for which this route applies.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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[AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriod] | None	A species specific time during which consumption of animal product is not appropriate	None

AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriod

Path: fhircraft.fhir.resources.datatypes.R5.core.administrable_product_definition.AdministrableProductDefinitionRouteOfAdministrationTargetSpeciesWithdrawalPeriod

Bases: BackboneElement

A species specific time during which consumption of animal product is not appropriate.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The type of tissue for which the withdrawal period applies, e.g. meat, milk	None
value	Quantity | None	A value for the time	None
supportingInformation	Annotated[str | String, BeforeValidator] | None	Extra information about the withdrawal period	None

AdverseEvent

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

Bases: DomainResource

An event (i.e. any change to current patient status) that may be related to unintended effects on a patient or research participant. The unintended effects may require additional monitoring, treatment, hospitalization, or may result in death. The AdverseEvent resource also extends to potential or avoided events that could have had such effects. There are two major domains where the AdverseEvent resource is expected to be used. One is in clinical care reported adverse events and the other is in reporting adverse events in clinical research trial management. Adverse events can be reported by healthcare providers, patients, caregivers or by medical products manufacturers. Given the differences between these two concepts, we recommend consulting the domain specific implementation guides when implementing the AdverseEvent Resource. The implementation guides include specific extensions, value sets and constraints.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 event	None
status	Annotated[str | Code, BeforeValidator] | None	in-progress | completed | entered-in-error | unknown	None
actuality	Annotated[str | Code, BeforeValidator] | None	actual | potential	None
category	List[CodeableConcept] | None	wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site	None
code	CodeableConcept | None	Event or incident that occurred or was averted	None
subject	Reference | None	Subject impacted by event	None
encounter	Reference | None	The Encounter associated with the start of the AdverseEvent	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the event occurred	None
occurrencePeriod	Period | None	When the event occurred	None
occurrenceTiming	Timing | None	When the event occurred	None
detected	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the event was detected	None
recordedDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the event was recorded	None
resultingEffect	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 or gravity of the event	None
outcome	List[CodeableConcept] | None	Type of outcome from the adverse event	None
recorder	Reference | None	Who recorded the adverse event	None
participant	List[AdverseEventParticipant] | None	Who was involved in the adverse event or the potential adverse event and what they did	None
study	List[Reference] | None	Research study that the subject is enrolled in	None
expectedInResearchStudy	Annotated[bool | Boolean, BeforeValidator] | None	Considered likely or probable or anticipated in the research study	None
suspectEntity	List[AdverseEventSuspectEntity] | None	The suspected agent causing the adverse event	None
contributingFactor	List[AdverseEventContributingFactor] | None	Contributing factors suspected to have increased the probability or severity of the adverse event	None
preventiveAction	List[AdverseEventPreventiveAction] | None	Preventive actions that contributed to avoiding the adverse event	None
mitigatingAction	List[AdverseEventMitigatingAction] | None	Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm	None
supportingInfo	List[AdverseEventSupportingInfo] | None	Supporting information relevant to the event	None
note	List[Annotation] | None	Comment on adverse event	None

AdverseEventContributingFactor

Path: fhircraft.fhir.resources.datatypes.R5.core.adverse_event.AdverseEventContributingFactor

Bases: BackboneElement

The contributing factors suspected to have increased the probability or severity of the adverse event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Item suspected to have increased the probability or severity of the adverse event	None
itemCodeableConcept	CodeableConcept | None	Item suspected to have increased the probability or severity of the adverse event	None

AdverseEventMitigatingAction

Path: fhircraft.fhir.resources.datatypes.R5.core.adverse_event.AdverseEventMitigatingAction

Bases: BackboneElement

The ameliorating action taken after the adverse event occured in order to reduce the extent of harm.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Ameliorating action taken after the adverse event occured in order to reduce the extent of harm	None
itemCodeableConcept	CodeableConcept | None	Ameliorating action taken after the adverse event occured in order to reduce the extent of harm	None

AdverseEventParticipant

Path: fhircraft.fhir.resources.datatypes.R5.core.adverse_event.AdverseEventParticipant

Bases: BackboneElement

Indicates who or what participated in the adverse event and how they were involved.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 involvement	None
actor	Reference | None	Who was involved in the adverse event or the potential adverse event	None

AdverseEventPreventiveAction

Path: fhircraft.fhir.resources.datatypes.R5.core.adverse_event.AdverseEventPreventiveAction

Bases: BackboneElement

Preventive actions that contributed to avoiding the adverse event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Action that contributed to avoiding the adverse event	None
itemCodeableConcept	CodeableConcept | None	Action that contributed to avoiding the adverse event	None

AdverseEventSupportingInfo

Path: fhircraft.fhir.resources.datatypes.R5.core.adverse_event.AdverseEventSupportingInfo

Bases: BackboneElement

Supporting information relevant to the event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Subject medical history or document relevant to this adverse event	None
itemCodeableConcept	CodeableConcept | None	Subject medical history or document relevant to this adverse event	None

AdverseEventSuspectEntity

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

Bases: BackboneElement

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

Parameters:

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

AdverseEventSuspectEntityCausality

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

Bases: BackboneElement

Information on the possible cause of the event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
assessmentMethod	CodeableConcept | None	Method of evaluating the relatedness of the suspected entity to the event	None
entityRelatedness	CodeableConcept | None	Result of the assessment regarding the relatedness of the suspected entity to the event	None
author	Reference | None	Author of the information on the possible cause of the event	None

AllergyIntolerance

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 | presumed | confirmed | refuted | entered-in-error	None
type	CodeableConcept | None	allergy | intolerance - Underlying mechanism (if known)	None
category	List[Annotated[str | Code, BeforeValidator]] | None	food | medication | environment | biologic	None
criticality	Annotated[str | Code, BeforeValidator] | None	low | high | unable-to-assess	None
code	CodeableConcept | None	code that identifies the allergy or intolerance	None
patient	Reference | None	Who the allergy or intolerance is for	None
encounter	Reference | None	Encounter when the allergy or intolerance was asserted	None
onsetDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When allergy or intolerance was identified	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	Annotated[str | String, BeforeValidator] | None	When allergy or intolerance was identified	None
recordedDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date allergy or intolerance was first recorded	None
participant	List[AllergyIntoleranceParticipant] | None	Who or what participated in the activities related to the allergy or intolerance and how they were involved	None
lastOccurrence	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date(/time) of last known occurrence of a reaction	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

AllergyIntoleranceParticipant

Path: fhircraft.fhir.resources.datatypes.R5.core.allergy_intolerance.AllergyIntoleranceParticipant

Bases: BackboneElement

Indicates who or what participated in the activities related to the allergy or intolerance and how they were involved.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 involvement	None
actor	Reference | None	Who or what participated in the activities related to the allergy or intolerance	None

AllergyIntoleranceReaction

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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[CodeableReference] | None	Clinical symptoms/signs associated with the Event	None
description	Annotated[str | String, BeforeValidator] | None	Description of the event as a whole	None
onset	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date(/time) when manifestations showed	None
severity	Annotated[str | Code, BeforeValidator] | None	mild | moderate | severe (of event as a whole)	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist	None
cancellationReason	CodeableConcept | None	The coded reason for the appointment being cancelled	None
class_	List[CodeableConcept] | None	Classification when becoming an encounter	None
serviceCategory	List[CodeableConcept] | None	A broad categorization of the service that is to be performed during this appointment	None
serviceType	List[CodeableReference] | 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
reason	List[CodeableReference] | None	Reason this appointment is scheduled	None
priority	CodeableConcept | None	Used to make informed decisions if needing to re-prioritize	None
description	Annotated[str | String, BeforeValidator] | None	Shown on a subject line in a meeting request, or appointment list	None
replaces	List[Reference] | None	Appointment replaced by this Appointment	None
virtualService	List[VirtualServiceDetail] | None	Connection details of a virtual service (e.g. conference call)	None
supportingInformation	List[Reference] | None	Additional information to support the appointment	None
previousAppointment	Reference | None	The previous appointment in a series	None
originatingAppointment	Reference | None	The originating appointment in a recurring set of appointments	None
start	Annotated[datetime | Instant, BeforeValidator] | None	When appointment is to take place	None
end	Annotated[datetime | Instant, BeforeValidator] | None	When appointment is to conclude	None
minutesDuration	Annotated[int | PositiveInt, BeforeValidator] | None	Can be less than start/end (e.g. estimate)	None
requestedPeriod	List[Period] | None	Potential date/time interval(s) requested to allocate the appointment within	None
slot	List[Reference] | None	The slots that this appointment is filling	None
account	List[Reference] | None	The set of accounts that may be used for billing for this Appointment	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date that this appointment was initially created	None
cancellationDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the appointment was cancelled	None
note	List[Annotation] | None	Additional comments	None
patientInstruction	List[CodeableReference] | None	Detailed information and instructions for the patient	None
basedOn	List[Reference] | None	The request this appointment is allocated to assess	None
subject	Reference | None	The patient or group associated with the appointment	None
participant	List[AppointmentParticipant] | None	Participants involved in appointment	None
recurrenceId	Annotated[int | PositiveInt, BeforeValidator] | None	The sequence number in the recurrence	None
occurrenceChanged	Annotated[bool | Boolean, BeforeValidator] | None	Indicates that this appointment varies from a recurrence pattern	None
recurrenceTemplate	List[AppointmentRecurrenceTemplate] | None	Details of the recurrence pattern/template used to generate occurrences	None

AppointmentParticipant

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

Bases: BackboneElement

List of participants involved in the appointment.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
period	Period | None	Participation period of the actor	None
actor	Reference | None	The individual, device, location, or service participating in the appointment	None
required	Annotated[bool | Boolean, BeforeValidator] | None	The participant is required to attend (optional when false)	None
status	Annotated[str | Code, BeforeValidator] | None	accepted | declined | tentative | needs-action	None

AppointmentRecurrenceTemplate

Path: fhircraft.fhir.resources.datatypes.R5.core.appointment.AppointmentRecurrenceTemplate

Bases: BackboneElement

The details of the recurrence pattern or template that is used to generate recurring appointments.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
timezone	CodeableConcept | None	The timezone of the occurrences	None
recurrenceType	CodeableConcept | None	The frequency of the recurrence	None
lastOccurrenceDate	Annotated[date | str | Date, BeforeValidator] | None	The date when the recurrence should end	None
occurrenceCount	Annotated[int | PositiveInt, BeforeValidator] | None	The number of planned occurrences	None
occurrenceDate	List[Annotated[date | str | Date, BeforeValidator]] | None	Specific dates for a recurring set of appointments (no template)	None
weeklyTemplate	AppointmentRecurrenceTemplateWeeklyTemplate | None	Information about weekly recurring appointments	None
monthlyTemplate	AppointmentRecurrenceTemplateMonthlyTemplate | None	Information about monthly recurring appointments	None
yearlyTemplate	AppointmentRecurrenceTemplateYearlyTemplate | None	Information about yearly recurring appointments	None
excludingDate	List[Annotated[date | str | Date, BeforeValidator]] | None	Any dates that should be excluded from the series	None
excludingRecurrenceId	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Any recurrence IDs that should be excluded from the recurrence	None

AppointmentRecurrenceTemplateMonthlyTemplate

Path: fhircraft.fhir.resources.datatypes.R5.core.appointment.AppointmentRecurrenceTemplateMonthlyTemplate

Bases: BackboneElement

Information about monthly recurring appointments.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
dayOfMonth	Annotated[int | PositiveInt, BeforeValidator] | None	Recurs on a specific day of the month	None
nthWeekOfMonth	Coding | None	Indicates which week of the month the appointment should occur	None
dayOfWeek	Coding | None	Indicates which day of the week the appointment should occur	None
monthInterval	Annotated[int | PositiveInt, BeforeValidator] | None	Recurs every nth month	None

AppointmentRecurrenceTemplateWeeklyTemplate

Path: fhircraft.fhir.resources.datatypes.R5.core.appointment.AppointmentRecurrenceTemplateWeeklyTemplate

Bases: BackboneElement

Information about weekly recurring appointments.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
monday	Annotated[bool | Boolean, BeforeValidator] | None	Recurs on Mondays	None
tuesday	Annotated[bool | Boolean, BeforeValidator] | None	Recurs on Tuesday	None
wednesday	Annotated[bool | Boolean, BeforeValidator] | None	Recurs on Wednesday	None
thursday	Annotated[bool | Boolean, BeforeValidator] | None	Recurs on Thursday	None
friday	Annotated[bool | Boolean, BeforeValidator] | None	Recurs on Friday	None
saturday	Annotated[bool | Boolean, BeforeValidator] | None	Recurs on Saturday	None
sunday	Annotated[bool | Boolean, BeforeValidator] | None	Recurs on Sunday	None
weekInterval	Annotated[int | PositiveInt, BeforeValidator] | None	Recurs every nth week	None

AppointmentRecurrenceTemplateYearlyTemplate

Path: fhircraft.fhir.resources.datatypes.R5.core.appointment.AppointmentRecurrenceTemplateYearlyTemplate

Bases: BackboneElement

Information about yearly recurring appointments.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
yearInterval	Annotated[int | PositiveInt, BeforeValidator] | None	Recurs every nth year	None

AppointmentResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
proposedNewTime	Annotated[bool | Boolean, BeforeValidator] | None	Indicator for a counter proposal	None
start	Annotated[datetime | Instant, BeforeValidator] | None	time from appointment, or requested new start time	None
end	Annotated[datetime | Instant, BeforeValidator] | None	time from appointment, or requested new end time	None
participantType	List[CodeableConcept] | None	Role of participant in the appointment	None
actor	Reference | None	Person(s), Location, HealthcareService, or Device	None
participantStatus	Annotated[str | Code, BeforeValidator] | None	accepted | declined | tentative | needs-action | entered-in-error	None
comment	Annotated[str | Markdown, BeforeValidator] | None	Additional comments	None
recurring	Annotated[bool | Boolean, BeforeValidator] | None	This response is for all occurrences in a recurring request	None
occurrenceDate	Annotated[date | str | Date, BeforeValidator] | None	Original date within a recurring request	None
recurrenceId	Annotated[int | PositiveInt, BeforeValidator] | None	The recurrence ID of the specific recurring request	None

ArtifactAssessment

Path: fhircraft.fhir.resources.datatypes.R5.core.artifact_assessment.ArtifactAssessment

Bases: DomainResource

This Resource provides one or more comments, classifiers or ratings about a Resource and supports attribution and rights management metadata for the added content.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 artifact assessment	None
title	Annotated[str | String, BeforeValidator] | None	A short title for the assessment for use in displaying and selecting	None
citeAsReference	Reference | None	How to cite the comment or rating	None
citeAsMarkdown	Annotated[str | Markdown, BeforeValidator] | None	How to cite the comment or rating	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the artifact assessment was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the artifact assessment was last reviewed by the publisher	None
artifactReference	Reference | None	The artifact assessed, commented upon or rated	None
artifactCanonical	Annotated[str | Canonical, BeforeValidator] | None	The artifact assessed, commented upon or rated	None
artifactUri	Annotated[str | Uri, BeforeValidator] | None	The artifact assessed, commented upon or rated	None
content	List[ArtifactAssessmentContent] | None	Comment, classifier, or rating content	None
workflowStatus	Annotated[str | Code, BeforeValidator] | None	submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error	None
disposition	Annotated[str | Code, BeforeValidator] | None	unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification	None

ArtifactAssessmentContent

Path: fhircraft.fhir.resources.datatypes.R5.core.artifact_assessment.ArtifactAssessmentContent

Bases: BackboneElement

A component comment, classifier, or rating of the artifact.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
informationType	Annotated[str | Code, BeforeValidator] | None	comment | classifier | rating | container | response | change-request	None
summary	Annotated[str | Markdown, BeforeValidator] | None	Brief summary of the content	None
type	CodeableConcept | None	What type of content	None
classifier	List[CodeableConcept] | None	Rating, classifier, or assessment	None
quantity	Quantity | None	Quantitative rating	None
author	Reference | None	Who authored the content	None
path	List[Annotated[str | Uri, BeforeValidator]] | None	What the comment is directed to	None
relatedArtifact	List[RelatedArtifact] | None	Additional information	None
freeToShare	Annotated[bool | Boolean, BeforeValidator] | None	Acceptable to publicly share the resource content	None
component	List[ArtifactAssessmentContent] | None	Contained content	None

AuditEvent

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

Bases: DomainResource

A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Type/identifier of event	None
code	CodeableConcept | None	Specific type of event	None
action	Annotated[str | Code, BeforeValidator] | None	Type of action performed during the event	None
severity	Annotated[str | Code, BeforeValidator] | None	emergency | alert | critical | error | warning | notice | informational | debug	None
occurredPeriod	Period | None	When the activity occurred	None
occurredDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the activity occurred	None
recorded	Annotated[datetime | Instant, BeforeValidator] | None	time when the event was recorded	None
outcome	AuditEventOutcome | None	Whether the event succeeded or failed	None
authorization	List[CodeableConcept] | None	Authorization related to the event	None
basedOn	List[Reference] | None	Workflow authorization within which this event occurred	None
patient	Reference | None	The patient is the subject of the data used/created/updated/deleted during the activity	None
encounter	Reference | None	Encounter within which this event occurred or which the event is tightly associated	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

AuditEventAgent

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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
requestor	Annotated[bool | Boolean, BeforeValidator] | None	Whether user is initiator	None
location	Reference | None	The agent location when the event occurred	None
policy	List[Annotated[str | Uri, BeforeValidator]] | None	Policy that authorized the agent participation in the event	None
networkReference	Reference | None	This agent network location for the activity	None
networkUri	Annotated[str | Uri, BeforeValidator] | None	This agent network location for the activity	None
networkString	Annotated[str | String, BeforeValidator] | None	This agent network location for the activity	None
authorization	List[CodeableConcept] | None	Allowable authorization for this agent	None

AuditEventEntity

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

Bases: BackboneElement

Specific instances of data or objects that have been accessed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
role	CodeableConcept | None	What role the entity played	None
securityLabel	List[CodeableConcept] | None	Security labels on the entity	None
query	Annotated[str | Base64Binary, BeforeValidator] | None	Query parameters	None
detail	List[AuditEventEntityDetail] | None	Additional Information about the entity	None
agent	List[AuditEventEntityAgent] | None	Entity is attributed to this agent	None

AuditEventEntityAgent

Path: fhircraft.fhir.resources.datatypes.R5.core.audit_event.AuditEventEntityAgent

Bases: BackboneElement

The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
requestor	Annotated[bool | Boolean, BeforeValidator] | None	Whether user is initiator	None
location	Reference | None	The agent location when the event occurred	None
policy	List[Annotated[str | Uri, BeforeValidator]] | None	Policy that authorized the agent participation in the event	None
networkReference	Reference | None	This agent network location for the activity	None
networkUri	Annotated[str | Uri, BeforeValidator] | None	This agent network location for the activity	None
networkString	Annotated[str | String, BeforeValidator] | None	This agent network location for the activity	None
authorization	List[CodeableConcept] | None	Allowable authorization for this agent	None

AuditEventEntityDetail

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

Bases: BackboneElement

Tagged value pairs for conveying additional information about the entity.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Name of the property	None
valueQuantity	Quantity | None	Property value	None
valueCodeableConcept	CodeableConcept | None	Property value	None
valueString	Annotated[str | String, BeforeValidator] | None	Property value	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Property value	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Property value	None
valueRange	Range | None	Property value	None
valueRatio	Ratio | None	Property value	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Property value	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Property value	None
valuePeriod	Period | None	Property value	None
valueBase64Binary	Annotated[str | Base64Binary, BeforeValidator] | None	Property value	None

AuditEventOutcome

Path: fhircraft.fhir.resources.datatypes.R5.core.audit_event.AuditEventOutcome

Bases: BackboneElement

Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Coding | None	Whether the event succeeded or failed	None
detail	List[CodeableConcept] | None	Additional outcome detail	None

AuditEventSource

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

Bases: BackboneElement

The actor that is reporting the event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Reference | None	Logical source location within the enterprise	None
observer	Reference | None	The identity of source detecting the event	None
type	List[CodeableConcept] | None	The type of source where event originated	None

Basic

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When created	None
author	Reference | None	Who created	None

Binary

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	None
contentType	Annotated[str | Code, BeforeValidator] | None	MimeType of the binary content	None
securityContext	Reference | None	Identifies another resource to use as proxy when enforcing access control	None
data	Annotated[str | Base64Binary, BeforeValidator] | None	The actual content	None

BiologicallyDerivedProduct

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

Bases: DomainResource

A biological material originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
productCategory	Coding | None	organ | tissue | fluid | cells | biologicalAgent	None
productCode	CodeableConcept | None	A code that identifies the kind of this biologically derived product	None
parent	List[Reference] | None	The parent biologically-derived product	None
request	List[Reference] | None	Request to obtain and/or infuse this product	None
identifier	List[Identifier] | None	Instance identifier	None
biologicalSourceEvent	Identifier | None	An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled	None
processingFacility	List[Reference] | None	Processing facilities responsible for the labeling and distribution of this biologically derived product	None
division	Annotated[str | String, BeforeValidator] | None	A unique identifier for an aliquot of a product	None
productStatus	Coding | None	available | unavailable	None
expirationDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date, and where relevant time, of expiration	None
collection	BiologicallyDerivedProductCollection | None	How this product was collected	None
storageTempRequirements	Range | None	Product storage temperature requirements	None
property_	List[BiologicallyDerivedProductProperty] | None	A property that is specific to this BiologicallyDerviedProduct instance	None

BiologicallyDerivedProductCollection

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

Bases: BackboneElement

How this product was collected.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The patient who underwent the medical procedure to collect the product or the organization that facilitated the collection	None
collectedDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	time of product collection	None
collectedPeriod	Period | None	time of product collection	None

BiologicallyDerivedProductProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.biologically_derived_product.BiologicallyDerivedProductProperty

Bases: BackboneElement

A property that is specific to this BiologicallyDerviedProduct instance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Property values	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Property values	None
valueCodeableConcept	CodeableConcept | None	Property values	None
valuePeriod	Period | None	Property values	None
valueQuantity	Quantity | None	Property values	None
valueRange	Range | None	Property values	None
valueRatio	Ratio | None	Property values	None
valueString	Annotated[str | String, BeforeValidator] | None	Property values	None
valueAttachment	Attachment | None	Property values	None

BiologicallyDerivedProductDispense

Path: fhircraft.fhir.resources.datatypes.R5.core.biologically_derived_product_dispense.BiologicallyDerivedProductDispense

Bases: DomainResource

A record of dispensation of a biologically derived product.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 dispense	None
basedOn	List[Reference] | None	The order or request that this dispense is fulfilling	None
partOf	List[Reference] | None	Short description	None
status	Annotated[str | Code, BeforeValidator] | None	preparation | in-progress | allocated | issued | unfulfilled | returned | entered-in-error | unknown	None
originRelationshipType	CodeableConcept | None	Relationship between the donor and intended recipient	None
product	Reference | None	The BiologicallyDerivedProduct that is dispensed	None
patient	Reference | None	The intended recipient of the dispensed product	None
matchStatus	CodeableConcept | None	Indicates the type of matching associated with the dispense	None
performer	List[BiologicallyDerivedProductDispensePerformer] | None	Indicates who or what performed an action	None
location	Reference | None	Where the dispense occurred	None
quantity	Quantity | None	Amount dispensed	None
preparedDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When product was selected/matched	None
whenHandedOver	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the product was dispatched	None
destination	Reference | None	Where the product was dispatched to	None
note	List[Annotation] | None	Additional notes	None
usageInstruction	Annotated[str | String, BeforeValidator] | None	Specific instructions for use	None

BiologicallyDerivedProductDispensePerformer

Path: fhircraft.fhir.resources.datatypes.R5.core.biologically_derived_product_dispense.BiologicallyDerivedProductDispensePerformer

Bases: BackboneElement

Indicates who or what performed an action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Identifies the function of the performer during the dispense	None
actor	Reference | None	Who performed the action	None

BodyStructure

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this record is in active use	None
morphology	CodeableConcept | None	Kind of Structure	None
includedStructure	List[BodyStructureIncludedStructure] | None	Included anatomic location(s)	None
excludedStructure	List[BodyStructureExcludedStructure] | None	Excluded anatomic locations(s)	None
description	Annotated[str | Markdown, BeforeValidator] | None	Text description	None
image	List[Attachment] | None	Attached images	None
patient	Reference | None	Who this is about	None

BodyStructureExcludedStructure

Path: fhircraft.fhir.resources.datatypes.R5.core.body_structure.BodyStructureExcludedStructure

Bases: BackboneElement

The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
structure	CodeableConcept | None	code that represents the included structure	None
laterality	CodeableConcept | None	code that represents the included structure laterality	None
bodyLandmarkOrientation	List[BodyStructureIncludedStructureBodyLandmarkOrientation] | None	Landmark relative location	None
spatialReference	List[Reference] | None	Cartesian reference for structure	None
qualifier	List[CodeableConcept] | None	code that represents the included structure qualifier	None

BodyStructureIncludedStructure

Path: fhircraft.fhir.resources.datatypes.R5.core.body_structure.BodyStructureIncludedStructure

Bases: BackboneElement

The anatomical location(s) or region(s) of the specimen, lesion, or body structure.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
structure	CodeableConcept | None	code that represents the included structure	None
laterality	CodeableConcept | None	code that represents the included structure laterality	None
bodyLandmarkOrientation	List[BodyStructureIncludedStructureBodyLandmarkOrientation] | None	Landmark relative location	None
spatialReference	List[Reference] | None	Cartesian reference for structure	None
qualifier	List[CodeableConcept] | None	code that represents the included structure qualifier	None

BodyStructureIncludedStructureBodyLandmarkOrientation

Path: fhircraft.fhir.resources.datatypes.R5.core.body_structure.BodyStructureIncludedStructureBodyLandmarkOrientation

Bases: BackboneElement

Body locations in relation to a specific body landmark (tatoo, scar, other body structure).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
landmarkDescription	List[CodeableConcept] | None	Body ]andmark description	None
clockFacePosition	List[CodeableConcept] | None	Clockface orientation	None
distanceFromLandmark	List[BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark] | None	Landmark relative location	None
surfaceOrientation	List[CodeableConcept] | None	Relative landmark surface orientation	None

BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark

Path: fhircraft.fhir.resources.datatypes.R5.core.body_structure.BodyStructureIncludedStructureBodyLandmarkOrientationDistanceFromLandmark

Bases: BackboneElement

The distance in centimeters a certain observation is made from a body landmark.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
device	List[CodeableReference] | None	Measurement device	None
value	List[Quantity] | None	Measured distance from body landmark	None

Bundle

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

Bases: Resource

A container for a collection of resources.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	None
identifier	Identifier | None	Persistent identifier for the bundle	None
type	Annotated[str | Code, BeforeValidator] | None	document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification	None
timestamp	Annotated[datetime | Instant, BeforeValidator] | None	When the bundle was assembled	None
total	Annotated[int | UnsignedInt, BeforeValidator] | None	If search, the total number of matches	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
issues	Resource | None	Issues with the Bundle	None

BundleEntry

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)	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.R5.core.bundle.BundleEntryLink

Bases: BackboneElement

A series of links that provide context to this entry.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1	None
url	Annotated[str | Uri, BeforeValidator] | None	Reference details for the link	None

BundleEntryRequest

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	GET | HEAD | POST | PUT | DELETE | PATCH	None
url	Annotated[str | Uri, BeforeValidator] | None	URL for HTTP equivalent of this entry	None
ifNoneMatch	Annotated[str | String, BeforeValidator] | None	For managing cache validation	None
ifModifiedSince	Annotated[datetime | Instant, BeforeValidator] | None	For managing cache currency	None
ifMatch	Annotated[str | String, BeforeValidator] | None	For managing update contention	None
ifNoneExist	Annotated[str | String, BeforeValidator] | None	For conditional creates	None

BundleEntryResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Status response code (text optional)	None
location	Annotated[str | Uri, BeforeValidator] | None	The location (if the operation returns a location)	None
etag	Annotated[str | String, BeforeValidator] | None	The Etag for the resource (if relevant)	None
lastModified	Annotated[datetime | Instant, BeforeValidator] | None	Server's date time modified	None
outcome	Resource | None	OperationOutcome with hints and warnings (for batch/transaction)	None

BundleEntrySearch

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	match | include - why this is in the result set	None
score	Annotated[float | Decimal, BeforeValidator] | None	Search ranking (between 0 and 1)	None

BundleLink

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

Bases: BackboneElement

A series of links that provide context to this bundle.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1	None
url	Annotated[str | Uri, BeforeValidator] | None	Reference details for the link	None

CanonicalResource

Path: fhircraft.fhir.resources.datatypes.R5.core.canonical_resource.CanonicalResource

Bases: Resource

Common Interface declaration for conformance and knowledge artifact resources.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this {{title}}, represented as an absolute URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the {{title}}	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the {{title}}	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this {{title}} (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this {{title}} (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the {{title}}	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for {{title}} (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this {{title}} is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None

CapabilityStatement

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

Bases: DomainResource

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client 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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this capability statement, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the CapabilityStatement (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the capability statement	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this capability statement (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this capability statement (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the capability statement	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	Annotated[str | Markdown, BeforeValidator] | None	Why this capability statement is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
kind	Annotated[str | Code, BeforeValidator] | None	instance | capability | requirements	None
instantiates	List[Annotated[str | Canonical, BeforeValidator]] | None	canonical URL of another capability statement this implements	None
imports	List[Annotated[str | Canonical, BeforeValidator]] | None	canonical URL of another capability statement this adds to	None
software	CapabilityStatementSoftware | None	Software that is covered by this capability statement	None
implementation	CapabilityStatementImplementation | None	If this describes a specific instance	None
fhirVersion	Annotated[str | Code, BeforeValidator] | None	FHIR Version the system supports	None
format	List[Annotated[str | Code, BeforeValidator]] | None	formats supported (xml | json | ttl | mime type)	None
patchFormat	List[Annotated[str | Code, BeforeValidator]] | None	Patch formats supported	None
acceptLanguage	List[Annotated[str | Code, BeforeValidator]] | None	Languages supported	None
implementationGuide	List[Annotated[str | Canonical, BeforeValidator]] | None	Implementation guides supported	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

CapabilityStatementDocument

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

Bases: BackboneElement

A document definition.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	producer | consumer	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Description of document support	None
profile	Annotated[str | Canonical, BeforeValidator] | None	Constraint on the resources used in the document	None

CapabilityStatementImplementation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Describes this specific instance	None
url	Annotated[str | Url, BeforeValidator] | None	Base URL for the installation	None
custodian	Reference | None	Organization that manages the data	None

CapabilityStatementMessaging

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

Bases: BackboneElement

A description of the messaging capabilities of the solution.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | UnsignedInt, BeforeValidator] | None	Reliable Message Cache Length (min)	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Messaging interface behavior details	None
supportedMessage	List[CapabilityStatementMessagingSupportedMessage] | None	Messages supported by this system	None

CapabilityStatementMessagingEndpoint

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Url, BeforeValidator] | None	Network address or identifier of the end-point	None

CapabilityStatementMessagingSupportedMessage

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	sender | receiver	None
definition	Annotated[str | Canonical, BeforeValidator] | None	Message supported by this system	None

CapabilityStatementRest

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	client | server	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	General description of implementation	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[Annotated[str | Canonical, BeforeValidator]] | None	Compartments served/used by system	None

CapabilityStatementRestInteraction

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

Bases: BackboneElement

A specification of restful operations supported by the system.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	transaction | batch | search-system | history-system	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Anything special about operation behavior	None

CapabilityStatementRestOperation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name by which the operation/query is invoked	None
definition	Annotated[str | Canonical, BeforeValidator] | None	The defined operation/query	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Specific details about operation behavior	None

CapabilityStatementRestResource

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	A resource type that is supported	None
profile	Annotated[str | Canonical, BeforeValidator] | None	System-wide profile	None
supportedProfile	List[Annotated[str | Canonical, BeforeValidator]] | None	Use-case specific profiles	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Additional information about the use of the resource type	None
interaction	List[CapabilityStatementRestResourceInteraction] | None	What operations are supported?	None
versioning	Annotated[str | Code, BeforeValidator] | None	no-version | versioned | versioned-update	None
readHistory	Annotated[bool | Boolean, BeforeValidator] | None	Whether vRead can return past versions	None
updateCreate	Annotated[bool | Boolean, BeforeValidator] | None	If update can commit to a new identity	None
conditionalCreate	Annotated[bool | Boolean, BeforeValidator] | None	If allows/uses conditional create	None
conditionalRead	Annotated[str | Code, BeforeValidator] | None	not-supported | modified-since | not-match | full-support	None
conditionalUpdate	Annotated[bool | Boolean, BeforeValidator] | None	If allows/uses conditional update	None
conditionalPatch	Annotated[bool | Boolean, BeforeValidator] | None	If allows/uses conditional patch	None
conditionalDelete	Annotated[str | Code, BeforeValidator] | None	not-supported | single | multiple - how conditional delete is supported	None
referencePolicy	List[Annotated[str | Code, BeforeValidator]] | None	literal | logical | resolves | enforced | local	None
searchInclude	List[Annotated[str | String, BeforeValidator]] | None	_include values supported by the server	None
searchRevInclude	List[Annotated[str | String, BeforeValidator]] | None	_revinclude values supported by the server	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.R5.core.capability_statement.CapabilityStatementRestResourceInteraction

Bases: BackboneElement

Identifies a restful operation supported by the solution.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	read | vread | update | patch | delete | history-instance | history-type | create | search-type	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Anything special about operation behavior	None

CapabilityStatementRestResourceOperation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name by which the operation/query is invoked	None
definition	Annotated[str | Canonical, BeforeValidator] | None	The defined operation/query	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Specific details about operation behavior	None

CapabilityStatementRestResourceSearchParam

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name for parameter in search url	None
definition	Annotated[str | Canonical, BeforeValidator] | None	Source of definition for parameter	None
type	Annotated[str | Code, BeforeValidator] | None	number | date | string | token | reference | composite | quantity | uri | special	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Server-specific usage	None

CapabilityStatementRestSearchParam

Path: fhircraft.fhir.resources.datatypes.R5.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. This is only for searches executed against the system-level endpoint.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name for parameter in search url	None
definition	Annotated[str | Canonical, BeforeValidator] | None	Source of definition for parameter	None
type	Annotated[str | Code, BeforeValidator] | None	number | date | string | token | reference | composite | quantity | uri | special	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Server-specific usage	None

CapabilityStatementRestSecurity

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Adds CORS Headers (http://enable-cors.org/)	None
service	List[CodeableConcept] | None	OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates	None
description	Annotated[str | Markdown, BeforeValidator] | None	General description of how security works	None

CapabilityStatementSoftware

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	A name the software is known by	None
version	Annotated[str | String, BeforeValidator] | None	Version covered by this statement	None
releaseDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date this version was released	None

CarePlan

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	None
basedOn	List[Reference] | None	Fulfills plan, proposal or order	None
replaces	List[Reference] | None	CarePlan replaced by this CarePlan	None
partOf	List[Reference] | None	Part of referenced CarePlan	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | order | option | directive	None
category	List[CodeableConcept] | None	Type of plan	None
title	Annotated[str | String, BeforeValidator] | None	Human-friendly name for the care plan	None
description	Annotated[str | String, BeforeValidator] | None	Summary of nature of plan	None
subject	Reference | None	Who the care plan is for	None
encounter	Reference | None	The Encounter during which this CarePlan was created	None
period	Period | None	time period plan covers	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date record was first recorded	None
custodian	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[CodeableReference] | 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 or has occurred as part of plan	None
note	List[Annotation] | None	Comments about the plan	None

CarePlanActivity

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
performedActivity	List[CodeableReference] | None	Results of the activity (concept, or Appointment, Encounter, Procedure, etc.)	None
progress	List[Annotation] | None	Comments about the activity status/progress	None
plannedActivityReference	Reference | None	Activity that is intended to be part of the care plan	None

CareTeam

Path: fhircraft.fhir.resources.datatypes.R5.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.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	proposed | active | suspended | inactive | entered-in-error	None
category	List[CodeableConcept] | None	Type of team	None
name	Annotated[str | String, BeforeValidator] | None	Name of the team, such as crisis assessment team	None
subject	Reference | None	Who care team is for	None
period	Period | None	time period team covers	None
participant	List[CareTeamParticipant] | None	Members of the team	None
reason	List[CodeableReference] | 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

CareTeamParticipant

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	None
member	Reference | None	Who is involved	None
onBehalfOf	Reference | None	Organization of the practitioner	None
coveragePeriod	Period | None	When the member is generally available within this care team	None
coverageTiming	Timing | None	When the member is generally available within this care team	None

ChargeItem

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Uri, BeforeValidator]] | None	Defining information about the code of this charge item	None
definitionCanonical	List[Annotated[str | Canonical, BeforeValidator]] | None	Resource defining the code of this ChargeItem	None
status	Annotated[str | Code, BeforeValidator] | None	planned | billable | not-billable | aborted | billed | entered-in-error | unknown	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
encounter	Reference | None	Encounter associated with this ChargeItem	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the charged service was applied	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
unitPriceComponent	MonetaryComponent | None	Unit price overriding the associated rules	None
totalPriceComponent	MonetaryComponent | None	Total price overriding the associated rules	None
overrideReason	CodeableConcept | None	Reason for overriding the list price/factor	None
enterer	Reference | None	Individual who was entering	None
enteredDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date the charge item was entered	None
reason	List[CodeableConcept] | None	Why was the charged service rendered?	None
service	List[CodeableReference] | None	Which rendered service is being charged?	None
product	List[CodeableReference] | 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

ChargeItemPerformer

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this charge item definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the charge item definition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the charge item definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this charge item definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this charge item definition (human friendly)	None
derivedFromUri	List[Annotated[str | Uri, BeforeValidator]] | None	Underlying externally-defined charge item definition	None
partOf	List[Annotated[str | Canonical, BeforeValidator]] | None	A larger definition of which this particular definition is a component or step	None
replaces	List[Annotated[str | Canonical, BeforeValidator]] | None	Completed or terminated request(s) whose function is taken by this new request	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the charge item definition	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
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this charge item definition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the charge item definition was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the charge item definition was last reviewed by the publisher	None
code	CodeableConcept | None	Billing code or product type 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

ChargeItemDefinitionApplicability

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

Bases: BackboneElement

Expressions that describe applicability criteria for the billing code.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Expression | None	boolean-valued expression	None
effectivePeriod	Period | None	When the charge item definition is expected to be used	None
relatedArtifact	RelatedArtifact | None	Reference to / quotation of the external source of the group of properties	None

ChargeItemDefinitionPropertyGroup

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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[MonetaryComponent] | None	Components of total line item price	None

ChargeItemDefinitionPropertyGroupApplicability

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

Bases: BackboneElement

Expressions that describe applicability criteria for the priceComponent.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Expression | None	boolean-valued expression	None
effectivePeriod	Period | None	When the charge item definition is expected to be used	None
relatedArtifact	RelatedArtifact | None	Reference to / quotation of the external source of the group of properties	None

Citation

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.Citation

Bases: DomainResource

The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this citation record, represented as a globally unique URI	None
identifier	List[Identifier] | None	Identifier for the citation record itself	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the citation record	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this citation record (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this citation record (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	The publisher of the citation record, not the publisher of the article or artifact being cited	None
contact	List[ContactDetail] | None	Contact details for the publisher of the citation record	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the citation	None
useContext	List[UsageContext] | None	The context that the citation record content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for citation record (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this citation is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions for the citation record, not for the cited artifact	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s) for the ciation record, not for the cited artifact	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the citation record was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the citation record was last reviewed by the publisher	None
effectivePeriod	Period | None	When the citation record is expected to be used	None
author	List[ContactDetail] | None	Who authored the citation record	None
editor	List[ContactDetail] | None	Who edited the citation record	None
reviewer	List[ContactDetail] | None	Who reviewed the citation record	None
endorser	List[ContactDetail] | None	Who endorsed the citation record	None
summary	List[CitationSummary] | None	A human-readable display of key concepts to represent the citation	None
classification	List[CitationClassification] | None	The assignment to an organizing scheme	None
note	List[Annotation] | None	Used for general notes and annotations not coded elsewhere	None
currentState	List[CodeableConcept] | None	The status of the citation record	None
statusDate	List[CitationStatusDate] | None	An effective date or period for a status of the citation record	None
relatedArtifact	List[RelatedArtifact] | None	Artifact related to the citation record	None
citedArtifact	CitationCitedArtifact | None	The article or artifact being described	None

CitationCitedArtifact

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifact

Bases: BackboneElement

The article or artifact being described.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Unique identifier. May include DOI, PMID, PMCID, etc	None
relatedIdentifier	List[Identifier] | None	Identifier not unique to the cited artifact. May include trial registry identifiers	None
dateAccessed	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the cited artifact was accessed	None
version	CitationCitedArtifactVersion | None	The defined version of the cited artifact	None
currentState	List[CodeableConcept] | None	The status of the cited artifact	None
statusDate	List[CitationCitedArtifactStatusDate] | None	An effective date or period for a status of the cited artifact	None
title	List[CitationCitedArtifactTitle] | None	The title details of the article or artifact	None
abstract	List[CitationCitedArtifactAbstract] | None	Summary of the article or artifact	None
part	CitationCitedArtifactPart | None	The component of the article or artifact	None
relatesTo	List[CitationCitedArtifactRelatesTo] | None	The artifact related to the cited artifact	None
publicationForm	List[CitationCitedArtifactPublicationForm] | None	If multiple, used to represent alternative forms of the article that are not separate citations	None
webLocation	List[CitationCitedArtifactWebLocation] | None	Used for any URL for the article or artifact cited	None
classification	List[CitationCitedArtifactClassification] | None	The assignment to an organizing scheme	None
contributorship	CitationCitedArtifactContributorship | None	Attribution of authors and other contributors	None
note	List[Annotation] | None	Any additional information or content for the article or artifact	None

CitationCitedArtifactAbstract

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactAbstract

Bases: BackboneElement

The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summaries.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 kind of abstract	None
language	CodeableConcept | None	Used to express the specific language	None
text	Annotated[str | Markdown, BeforeValidator] | None	Abstract content	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Copyright notice for the abstract	None

CitationCitedArtifactClassification

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactClassification

Bases: BackboneElement

The assignment to an organizing scheme.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 kind of classifier (e.g. publication type, keyword)	None
classifier	List[CodeableConcept] | None	The specific classification value	None
artifactAssessment	List[Reference] | None	Complex or externally created classification	None

CitationCitedArtifactContributorship

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactContributorship

Bases: BackboneElement

This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
complete	Annotated[bool | Boolean, BeforeValidator] | None	Indicates if the list includes all authors and/or contributors	None
entry	List[CitationCitedArtifactContributorshipEntry] | None	An individual entity named as a contributor	None
summary	List[CitationCitedArtifactContributorshipSummary] | None	Used to record a display of the author/contributor list without separate data element for each list member	None

CitationCitedArtifactContributorshipEntry

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactContributorshipEntry

Bases: BackboneElement

An individual entity named as a contributor, for example in the author list or contributor list.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
contributor	Reference | None	The identity of the individual contributor	None
forenameInitials	Annotated[str | String, BeforeValidator] | None	For citation styles that use initials	None
affiliation	List[Reference] | None	Organizational affiliation	None
contributionType	List[CodeableConcept] | None	The specific contribution	None
role	CodeableConcept | None	The role of the contributor (e.g. author, editor, reviewer, funder)	None
contributionInstance	List[CitationCitedArtifactContributorshipEntryContributionInstance] | None	Contributions with accounting for time or number	None
correspondingContact	Annotated[bool | Boolean, BeforeValidator] | None	Whether the contributor is the corresponding contributor for the role	None
rankingOrder	Annotated[int | PositiveInt, BeforeValidator] | None	Ranked order of contribution	None

CitationCitedArtifactContributorshipEntryContributionInstance

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactContributorshipEntryContributionInstance

Bases: BackboneElement

Contributions with accounting for time or number.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 specific contribution	None
time	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The time that the contribution was made	None

CitationCitedArtifactContributorshipSummary

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactContributorshipSummary

Bases: BackboneElement

Used to record a display of the author/contributor list without separate data element for each list member.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement	None
style	CodeableConcept | None	The format for the display string	None
source	CodeableConcept | None	Used to code the producer or rule for creating the display string	None
value	Annotated[str | Markdown, BeforeValidator] | None	The display string for the author list, contributor list, or contributorship statement	None

CitationCitedArtifactPart

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactPart

Bases: BackboneElement

The component of the article or artifact.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 kind of component	None
value	Annotated[str | String, BeforeValidator] | None	The specification of the component	None
baseCitation	Reference | None	The citation for the full article or artifact	None

CitationCitedArtifactPublicationForm

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactPublicationForm

Bases: BackboneElement

If multiple, used to represent alternative forms of the article that are not separate citations.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
publishedIn	CitationCitedArtifactPublicationFormPublishedIn | None	The collection the cited article or artifact is published in	None
citedMedium	CodeableConcept | None	Internet or Print	None
volume	Annotated[str | String, BeforeValidator] | None	Volume number of journal or other collection in which the article is published	None
issue	Annotated[str | String, BeforeValidator] | None	Issue, part or supplement of journal or other collection in which the article is published	None
articleDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date the article was added to the database, or the date the article was released	None
publicationDateText	Annotated[str | String, BeforeValidator] | None	Text representation of the date on which the issue of the cited artifact was published	None
publicationDateSeason	Annotated[str | String, BeforeValidator] | None	Season in which the cited artifact was published	None
lastRevisionDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date the article was last revised or updated in the database	None
language	List[CodeableConcept] | None	Language(s) in which this form of the article is published	None
accessionNumber	Annotated[str | String, BeforeValidator] | None	Entry number or identifier for inclusion in a database	None
pageString	Annotated[str | String, BeforeValidator] | None	Used for full display of pagination	None
firstPage	Annotated[str | String, BeforeValidator] | None	Used for isolated representation of first page	None
lastPage	Annotated[str | String, BeforeValidator] | None	Used for isolated representation of last page	None
pageCount	Annotated[str | String, BeforeValidator] | None	Number of pages or screens	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Copyright notice for the full article or artifact	None

CitationCitedArtifactPublicationFormPublishedIn

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactPublicationFormPublishedIn

Bases: BackboneElement

The collection the cited article or artifact is published in.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Kind of container (e.g. Periodical, database, or book)	None
identifier	List[Identifier] | None	Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN	None
title	Annotated[str | String, BeforeValidator] | None	Name of the database or title of the book or journal	None
publisher	Reference | None	Name of or resource describing the publisher	None
publisherLocation	Annotated[str | String, BeforeValidator] | None	Geographic location of the publisher	None

CitationCitedArtifactRelatesTo

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactRelatesTo

Bases: BackboneElement

The artifact related to the cited artifact.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of	None
classifier	List[CodeableConcept] | None	Additional classifiers	None
label	Annotated[str | String, BeforeValidator] | None	Short label	None
display	Annotated[str | String, BeforeValidator] | None	Brief description of the related artifact	None
citation	Annotated[str | Markdown, BeforeValidator] | None	Bibliographic citation for the artifact	None
document	Attachment | None	What document is being referenced	None
resource	Annotated[str | Canonical, BeforeValidator] | None	What artifact is being referenced	None
resourceReference	Reference | None	What artifact, if not a conformance resource	None

CitationCitedArtifactStatusDate

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactStatusDate

Bases: BackboneElement

An effective date or period, historical or future, actual or expected, for a status of the cited artifact.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
activity	CodeableConcept | None	Classification of the status	None
actual	Annotated[bool | Boolean, BeforeValidator] | None	Either occurred or expected	None
period	Period | None	When the status started and/or ended	None

CitationCitedArtifactTitle

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactTitle

Bases: BackboneElement

The title details of the article or artifact.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The kind of title	None
language	CodeableConcept | None	Used to express the specific language	None
text	Annotated[str | Markdown, BeforeValidator] | None	The title of the article or artifact	None

CitationCitedArtifactVersion

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactVersion

Bases: BackboneElement

The defined version of the cited artifact.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The version number or other version identifier	None
baseCitation	Reference | None	Citation for the main version of the cited artifact	None

CitationCitedArtifactWebLocation

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationCitedArtifactWebLocation

Bases: BackboneElement

Used for any URL for the article or artifact cited.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
classifier	List[CodeableConcept] | None	code the reason for different URLs, e.g. abstract and full-text	None
url	Annotated[str | Uri, BeforeValidator] | None	The specific URL	None

CitationClassification

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationClassification

Bases: BackboneElement

The assignment to an organizing scheme.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 kind of classifier (e.g. publication type, keyword)	None
classifier	List[CodeableConcept] | None	The specific classification value	None

CitationStatusDate

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationStatusDate

Bases: BackboneElement

The state or status of the citation record paired with an effective date or period for that state.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
activity	CodeableConcept | None	Classification of the status	None
actual	Annotated[bool | Boolean, BeforeValidator] | None	Either occurred or expected	None
period	Period | None	When the status started and/or ended	None

CitationSummary

Path: fhircraft.fhir.resources.datatypes.R5.core.citation.CitationSummary

Bases: BackboneElement

A human-readable display of key concepts to represent the citation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
style	CodeableConcept | None	Format for display of the citation summary	None
text	Annotated[str | Markdown, BeforeValidator] | None	The human-readable display of the citation summary	None

Claim

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
traceNumber	List[Identifier] | None	Number for tracking	None
status	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
type	CodeableConcept | None	Category or discipline	None
subType	CodeableConcept | None	More granular claim type	None
use	Annotated[str | Code, BeforeValidator] | None	claim | preauthorization | predetermination	None
patient	Reference | None	The recipient of the products and services	None
billablePeriod	Period | None	Relevant time frame for the claim	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Resource creation date	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 urgency	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
encounter	List[Reference] | None	Encounters associated with the listed treatments	None
facility	Reference | None	Servicing facility	None
diagnosisRelatedGroup	CodeableConcept | None	Package billing code	None
event	List[ClaimEvent] | None	Event information	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
patientPaid	Money | None	Paid by the patient	None
item	List[ClaimItem] | None	Product or service provided	None
total	Money | None	Total claim cost	None

ClaimAccident

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[date | str | Date, BeforeValidator] | None	When the incident occurred	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.R5.core.claim.ClaimCareTeam

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Order of care team	None
provider	Reference | None	Practitioner or organization	None
responsible	Annotated[bool | Boolean, BeforeValidator] | None	Indicator of the lead practitioner	None
role	CodeableConcept | None	Function within the team	None
specialty	CodeableConcept | None	Practitioner or provider specialization	None

ClaimDiagnosis

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

Bases: BackboneElement

Information about diagnoses relevant to the claim items.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Diagnosis instance identifier	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

ClaimEvent

Path: fhircraft.fhir.resources.datatypes.R5.core.claim.ClaimEvent

Bases: BackboneElement

Information code for an event with a corresponding date or period.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Specific event	None
whenDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Occurance date or period	None
whenPeriod	Period | None	Occurance date or period	None

ClaimInsurance

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Insurance instance identifier	None
focal	Annotated[bool | Boolean, BeforeValidator] | None	Coverage to be used for adjudication	None
identifier	Identifier | None	Pre-assigned Claim number	None
coverage	Reference | None	Insurance information	None
businessArrangement	Annotated[str | String, BeforeValidator] | None	Additional provider contract number	None
preAuthRef	List[Annotated[str | String, BeforeValidator]] | None	Prior authorization reference number	None
claimResponse	Reference | None	Adjudication results	None

ClaimItem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Item instance identifier	None
traceNumber	List[Identifier] | None	Number for tracking	None
careTeamSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable careTeam members	None
diagnosisSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable diagnoses	None
procedureSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable procedures	None
informationSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable exception and supporting information	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
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
request	List[Reference] | None	Request or Referral for Service	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	Annotated[date | str | Date, BeforeValidator] | None	Date or dates of service or product delivery	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
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
bodySite	List[ClaimItemBodySite] | None	Anatomical location	None
encounter	List[Reference] | None	Encounters associated with the listed treatments	None
detail	List[ClaimItemDetail] | None	Product or service provided	None

ClaimItemBodySite

Path: fhircraft.fhir.resources.datatypes.R5.core.claim.ClaimItemBodySite

Bases: BackboneElement

Physical location where the service is performed or applies.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[CodeableReference] | None	Location	None
subSite	List[CodeableConcept] | None	Sub-location	None

ClaimItemDetail

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Item instance identifier	None
traceNumber	List[Identifier] | None	Number for tracking	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
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Item instance identifier	None
traceNumber	List[Identifier] | None	Number for tracking	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
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None

ClaimPayee

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.claim.ClaimProcedure

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Procedure instance identifier	None
type	List[CodeableConcept] | None	Category of Procedure	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the procedure was performed	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.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Information instance identifier	None
category	CodeableConcept | None	Classification of the supplied information	None
code	CodeableConcept | None	Type of information	None
timingDate	Annotated[date | str | Date, BeforeValidator] | None	When it occurred	None
timingPeriod	Period | None	When it occurred	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Data to be provided	None
valueString	Annotated[str | String, BeforeValidator] | None	Data to be provided	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
valueIdentifier	Identifier | None	Data to be provided	None
reason	CodeableConcept | None	Explanation for the information	None

ClaimResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
traceNumber	List[Identifier] | None	Number for tracking	None
status	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
type	CodeableConcept | None	More granular claim type	None
subType	CodeableConcept | None	More granular claim type	None
use	Annotated[str | Code, BeforeValidator] | None	claim | preauthorization | predetermination	None
patient	Reference | None	The recipient of the products and services	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Response creation date	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	Annotated[str | Code, BeforeValidator] | None	queued | complete | error | partial	None
decision	CodeableConcept | None	Result of the adjudication	None
disposition	Annotated[str | String, BeforeValidator] | None	Disposition Message	None
preAuthRef	Annotated[str | String, BeforeValidator] | None	Preauthorization reference	None
preAuthPeriod	Period | None	Preauthorization reference effective period	None
event	List[ClaimResponseEvent] | None	Event information	None
payeeType	CodeableConcept | None	Party to be paid any benefits payable	None
encounter	List[Reference] | None	Encounters associated with the listed treatments	None
diagnosisRelatedGroup	CodeableConcept | None	Package billing code	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

ClaimResponseAddItem

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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[Annotated[int | PositiveInt, BeforeValidator]] | None	Item sequence number	None
detailSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Detail sequence number	None
subdetailSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Subdetail sequence number	None
traceNumber	List[Identifier] | None	Number for tracking	None
provider	List[Reference] | None	Authorized providers	None
revenue	CodeableConcept | None	Revenue or cost center code	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
request	List[Reference] | None	Request or Referral for Service	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
servicedDate	Annotated[date | str | Date, BeforeValidator] | None	Date or dates of service or product delivery	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	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
bodySite	List[ClaimResponseAddItemBodySite] | None	Anatomical location	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ClaimResponseItemReviewOutcome | None	Added items adjudication results	None
adjudication	List[ClaimResponseItemAdjudication] | None	Added items adjudication	None
detail	List[ClaimResponseAddItemDetail] | None	Insurer added line details	None

ClaimResponseAddItemBodySite

Path: fhircraft.fhir.resources.datatypes.R5.core.claim_response.ClaimResponseAddItemBodySite

Bases: BackboneElement

Physical location where the service is performed or applies.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[CodeableReference] | None	Location	None
subSite	List[CodeableConcept] | None	Sub-location	None

ClaimResponseAddItemDetail

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

Bases: BackboneElement

The second-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
traceNumber	List[Identifier] | None	Number for tracking	None
revenue	CodeableConcept | None	Revenue or cost center code	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
productOrServiceEnd	CodeableConcept | None	End of a range of codes	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	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ClaimResponseItemReviewOutcome | None	Added items detail level adjudication results	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.R5.core.claim_response.ClaimResponseAddItemDetailSubDetail

Bases: BackboneElement

The third-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
traceNumber	List[Identifier] | None	Number for tracking	None
revenue	CodeableConcept | None	Revenue or cost center code	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
productOrServiceEnd	CodeableConcept | None	End of a range of codes	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	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ClaimResponseItemReviewOutcome | None	Added items subdetail level adjudication results	None
adjudication	List[ClaimResponseItemAdjudication] | None	Added items subdetail adjudication	None

ClaimResponseError

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

Bases: BackboneElement

Errors encountered during the processing of the adjudication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Item sequence number	None
detailSequence	Annotated[int | PositiveInt, BeforeValidator] | None	Detail sequence number	None
subDetailSequence	Annotated[int | PositiveInt, BeforeValidator] | None	Subdetail sequence number	None
code	CodeableConcept | None	Error code detailing processing issues	None
expression	List[Annotated[str | String, BeforeValidator]] | None	FHIRPath of element(s) related to issue	None

ClaimResponseEvent

Path: fhircraft.fhir.resources.datatypes.R5.core.claim_response.ClaimResponseEvent

Bases: BackboneElement

Information code for an event with a corresponding date or period.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Specific event	None
whenDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Occurance date or period	None
whenPeriod	Period | None	Occurance date or period	None

ClaimResponseInsurance

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Insurance instance identifier	None
focal	Annotated[bool | Boolean, BeforeValidator] | None	Coverage to be used for adjudication	None
coverage	Reference | None	Insurance information	None
businessArrangement	Annotated[str | String, BeforeValidator] | None	Additional provider contract number	None
claimResponse	Reference | None	Adjudication results	None

ClaimResponseItem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Claim item instance identifier	None
traceNumber	List[Identifier] | None	Number for tracking	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ClaimResponseItemReviewOutcome | None	Adjudication results	None
adjudication	List[ClaimResponseItemAdjudication] | None	Adjudication details	None
detail	List[ClaimResponseItemDetail] | None	Adjudication for claim details	None

ClaimResponseItemAdjudication

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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
quantity	Quantity | None	Non-monetary value	None

ClaimResponseItemDetail

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Claim detail instance identifier	None
traceNumber	List[Identifier] | None	Number for tracking	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ClaimResponseItemDetailReviewOutcome | None	Detail level adjudication results	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.R5.core.claim_response.ClaimResponseItemDetailAdjudication

Bases: BackboneElement

The adjudication results.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
quantity	Quantity | None	Non-monetary value	None

ClaimResponseItemDetailReviewOutcome

Path: fhircraft.fhir.resources.datatypes.R5.core.claim_response.ClaimResponseItemDetailReviewOutcome

Bases: BackboneElement

The high-level results of the adjudication if adjudication has been performed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
decision	CodeableConcept | None	Result of the adjudication	None
reason	List[CodeableConcept] | None	Reason for result of the adjudication	None
preAuthRef	Annotated[str | String, BeforeValidator] | None	Preauthorization reference	None
preAuthPeriod	Period | None	Preauthorization reference effective period	None

ClaimResponseItemDetailSubDetail

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Claim sub-detail instance identifier	None
traceNumber	List[Identifier] | None	Number for tracking	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ClaimResponseItemReviewOutcome | None	Subdetail level adjudication results	None
adjudication	List[ClaimResponseItemAdjudication] | None	Subdetail level adjudication details	None

ClaimResponseItemReviewOutcome

Path: fhircraft.fhir.resources.datatypes.R5.core.claim_response.ClaimResponseItemReviewOutcome

Bases: BackboneElement

The high-level results of the adjudication if adjudication has been performed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
decision	CodeableConcept | None	Result of the adjudication	None
reason	List[CodeableConcept] | None	Reason for result of the adjudication	None
preAuthRef	Annotated[str | String, BeforeValidator] | None	Preauthorization reference	None
preAuthPeriod	Period | None	Preauthorization reference effective period	None

ClaimResponsePayment

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

Bases: BackboneElement

Payment details for the adjudication of the claim.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[date | str | Date, BeforeValidator] | None	Expected date of payment	None
amount	Money | None	Payable amount after adjustment	None
identifier	Identifier | None	Business identifier for the payment	None

ClaimResponseProcessNote

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Note instance identifier	None
type	CodeableConcept | None	Note purpose	None
text	Annotated[str | String, BeforeValidator] | None	Note explanatory text	None
language	CodeableConcept | None	Language of the text	None

ClaimResponseTotal

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

Bases: BackboneElement

Categorized monetary totals for the adjudication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown	None
statusReason	CodeableConcept | None	Reason for current status	None
description	Annotated[str | String, BeforeValidator] | None	Why/how the assessment was performed	None
subject	Reference | None	Patient or group assessed	None
encounter	Reference | None	The Encounter during which this ClinicalImpression was created	None
effectiveDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	time of assessment	None
effectivePeriod	Period | None	time of assessment	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the assessment was documented	None
performer	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
changePattern	CodeableConcept | None	Change in the status/pattern of a subject's condition since previously assessed, such as worsening, improving, or no change	None
protocol	List[Annotated[str | Uri, BeforeValidator]] | None	Clinical Protocol followed	None
summary	Annotated[str | String, BeforeValidator] | None	Summary of the assessment	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

ClinicalImpressionFinding

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
item	CodeableReference | None	What was found	None
basis	Annotated[str | String, BeforeValidator] | None	Which investigations support finding	None

ClinicalUseDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinition

Bases: DomainResource

A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 issue	None
type	Annotated[str | Code, BeforeValidator] | None	indication | contraindication | interaction | undesirable-effect | warning	None
category	List[CodeableConcept] | None	A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose"	None
subject	List[Reference] | None	The medication, product, substance, device, procedure etc. for which this is an indication	None
status	CodeableConcept | None	Whether this is a current issue or one that has been retired etc	None
contraindication	ClinicalUseDefinitionContraindication | None	Specifics for when this is a contraindication	None
indication	ClinicalUseDefinitionIndication | None	Specifics for when this is an indication	None
interaction	ClinicalUseDefinitionInteraction | None	Specifics for when this is an interaction	None
population	List[Reference] | None	The population group to which this applies	None
library	List[Annotated[str | Canonical, BeforeValidator]] | None	Logic used by the clinical use definition	None
undesirableEffect	ClinicalUseDefinitionUndesirableEffect | None	A possible negative outcome from the use of this treatment	None
warning	ClinicalUseDefinitionWarning | None	Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'	None

ClinicalUseDefinitionContraindication

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionContraindication

Bases: BackboneElement

Specifics for when this is a contraindication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
diseaseSymptomProcedure	CodeableReference | None	The situation that is being documented as contraindicating against this item	None
diseaseStatus	CodeableReference | None	The status of the disease or symptom for the contraindication	None
comorbidity	List[CodeableReference] | None	A comorbidity (concurrent condition) or coinfection	None
indication	List[Reference] | None	The indication which this is a contraidication for	None
applicability	Expression | None	An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements	None
otherTherapy	List[ClinicalUseDefinitionContraindicationOtherTherapy] | None	Information about use of the product in relation to other therapies described as part of the contraindication	None

ClinicalUseDefinitionContraindicationOtherTherapy

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionContraindicationOtherTherapy

Bases: BackboneElement

Information about the use of the medicinal product in relation to other therapies described as part of the contraindication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
relationshipType	CodeableConcept | None	The type of relationship between the product indication/contraindication and another therapy	None
treatment	CodeableReference | None	Reference to a specific medication, substance etc. as part of an indication or contraindication	None

ClinicalUseDefinitionIndication

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionIndication

Bases: BackboneElement

Specifics for when this is an indication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
diseaseSymptomProcedure	CodeableReference | None	The situation that is being documented as an indicaton for this item	None
diseaseStatus	CodeableReference | None	The status of the disease or symptom for the indication	None
comorbidity	List[CodeableReference] | None	A comorbidity or coinfection as part of the indication	None
intendedEffect	CodeableReference | None	The intended effect, aim or strategy to be achieved	None
durationRange	Range | None	Timing or duration information	None
durationString	Annotated[str | String, BeforeValidator] | None	Timing or duration information	None
undesirableEffect	List[Reference] | None	An unwanted side effect or negative outcome of the subject of this resource when being used for this indication	None
applicability	Expression | None	An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements	None
otherTherapy	List[ClinicalUseDefinitionIndicationOtherTherapy] | None	The use of the medicinal product in relation to other therapies described as part of the indication	None

ClinicalUseDefinitionIndicationOtherTherapy

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionIndicationOtherTherapy

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	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
relationshipType	CodeableConcept | None	The type of relationship between the product indication/contraindication and another therapy	None
treatment	CodeableReference | None	Reference to a specific medication, substance etc. as part of an indication or contraindication	None

ClinicalUseDefinitionInteraction

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionInteraction

Bases: BackboneElement

Specifics for when this is an interaction.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
interactant	List[ClinicalUseDefinitionInteractionInteractant] | None	The specific medication, product, food etc. or laboratory test that interacts	None
type	CodeableConcept | None	The type of the interaction e.g. drug-drug interaction, drug-lab test interaction	None
effect	CodeableReference | 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	List[CodeableConcept] | None	Actions for managing the interaction	None

ClinicalUseDefinitionInteractionInteractant

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionInteractionInteractant

Bases: BackboneElement

The specific medication, product, food, substance etc. or laboratory test that interacts.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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, product, food etc. or laboratory test that interacts	None
itemCodeableConcept	CodeableConcept | None	The specific medication, product, food etc. or laboratory test that interacts	None

ClinicalUseDefinitionUndesirableEffect

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionUndesirableEffect

Bases: BackboneElement

Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
symptomConditionEffect	CodeableReference | None	The situation in which the undesirable effect may manifest	None
classification	CodeableConcept | None	High level classification of the effect	None
frequencyOfOccurrence	CodeableConcept | None	How often the effect is seen	None

ClinicalUseDefinitionWarning

Path: fhircraft.fhir.resources.datatypes.R5.core.clinical_use_definition.ClinicalUseDefinitionWarning

Bases: BackboneElement

A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	A textual definition of this warning, with formatting	None
code	CodeableConcept | None	A coded or unformatted textual definition of this warning	None

CodeSystem

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)	None
identifier	List[Identifier] | None	Additional identifier for the code system (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the code system (Coding.version)	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this code system (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this code system (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the code system	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	Annotated[str | Markdown, BeforeValidator] | None	Why this code system is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the CodeSystem was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the CodeSystem was last reviewed by the publisher	None
effectivePeriod	Period | None	When the CodeSystem is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc	None
author	List[ContactDetail] | None	Who authored the CodeSystem	None
editor	List[ContactDetail] | None	Who edited the CodeSystem	None
reviewer	List[ContactDetail] | None	Who reviewed the CodeSystem	None
endorser	List[ContactDetail] | None	Who endorsed the CodeSystem	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc	None
caseSensitive	Annotated[bool | Boolean, BeforeValidator] | None	If code comparison is case sensitive	None
valueSet	Annotated[str | Canonical, BeforeValidator] | None	canonical reference to the value set with entire code system	None
hierarchyMeaning	Annotated[str | Code, BeforeValidator] | None	grouped-by | is-a | part-of | classified-with	None
compositional	Annotated[bool | Boolean, BeforeValidator] | None	If code system defines a compositional grammar	None
versionNeeded	Annotated[bool | Boolean, BeforeValidator] | None	If definitions are not stable	None
content	Annotated[str | Code, BeforeValidator] | None	not-present | example | fragment | complete | supplement	None
supplements	Annotated[str | Canonical, BeforeValidator] | None	canonical URL of code System this adds designations and properties to	None
count	Annotated[int | UnsignedInt, BeforeValidator] | None	Total concepts in the code system	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

CodeSystemConcept

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	code that identifies concept	None
display	Annotated[str | String, BeforeValidator] | None	Text to display to the user	None
definition	Annotated[str | String, BeforeValidator] | None	Formal definition	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Human language of the designation	None
use	Coding | None	Details how this designation would be used	None
additionalUse	List[Coding] | None	Additional ways how this designation would be used	None
value	Annotated[str | String, BeforeValidator] | None	The text value for this designation	None

CodeSystemConceptProperty

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

Bases: BackboneElement

A property value for this concept.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Reference to CodeSystem.property.code	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Value of the property for this concept	None
valueCoding	Coding | None	Value of the property for this concept	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the property for this concept	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Value of the property for this concept	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the property for this concept	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Value of the property for this concept	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Value of the property for this concept	None

CodeSystemFilter

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	code that identifies the filter	None
description	Annotated[str | String, BeforeValidator] | None	How or why the filter is used	None
operator	List[Annotated[str | Code, BeforeValidator]] | None	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists	None
value	Annotated[str | String, BeforeValidator] | None	What to use for the value	None

CodeSystemProperty

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Identifies the property on the concepts, and when referred to in operations	None
uri	Annotated[str | Uri, BeforeValidator] | None	Formal identifier for the property	None
description	Annotated[str | String, BeforeValidator] | None	Why the property is defined, and/or what it conveys	None
type	Annotated[str | Code, BeforeValidator] | None	code | Coding | string | integer | boolean | dateTime | decimal	None

Communication

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

Bases: DomainResource

A clinical or business level record of information being transmitted or shared; e.g. an alert that was sent to a responsible provider, a public health agency communication to a provider/reporter in response to a case report for a reportable condition.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	None
basedOn	List[Reference] | None	Request fulfilled by this communication	None
partOf	List[Reference] | None	Part of referenced event (e.g. Communication, Procedure)	None
inResponseTo	List[Reference] | None	Reply to	None
status	Annotated[str | Code, BeforeValidator] | None	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown	None
statusReason	CodeableConcept | None	Reason for current status	None
category	List[CodeableConcept] | None	Message category	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	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	The Encounter during which this Communication was created	None
sent	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When sent	None
received	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When received	None
recipient	List[Reference] | None	Who the information is shared with	None
sender	Reference | None	Who shares the information	None
reason	List[CodeableReference] | None	Indication for message	None
payload	List[CommunicationPayload] | None	Message payload	None
note	List[Annotation] | None	Comments made about the communication	None

CommunicationPayload

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Message part content	None
contentReference	Reference | None	Message part content	None
contentCodeableConcept	CodeableConcept | None	Message part content	None

CommunicationRequest

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
statusReason	CodeableConcept | None	Reason for current status	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
category	List[CodeableConcept] | None	Message category	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
doNotPerform	Annotated[bool | Boolean, BeforeValidator] | None	True if request is prohibiting action	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	The Encounter during which this CommunicationRequest was created	None
payload	List[CommunicationRequestPayload] | None	Message payload	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When scheduled	None
occurrencePeriod	Period | None	When scheduled	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When request transitioned to being actionable	None
requester	Reference | None	Who asks for the information to be shared	None
recipient	List[Reference] | None	Who to share the information with	None
informationProvider	List[Reference] | None	Who should share the information	None
reason	List[CodeableReference] | None	Why is communication needed?	None
note	List[Annotation] | None	Comments made about communication request	None

CommunicationRequestPayload

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Message part content	None
contentReference	Reference | None	Message part content	None
contentCodeableConcept	CodeableConcept | None	Message part content	None

CompartmentDefinition

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

Bases: DomainResource

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

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this compartment definition, represented as a URI (globally unique)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the compartment definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this compartment definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this compartment definition (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the compartment definition	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this compartment definition is defined	None
code	Annotated[str | Code, BeforeValidator] | None	Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare	None
search	Annotated[bool | Boolean, BeforeValidator] | None	Whether the search syntax is supported	None
resource	List[CompartmentDefinitionResource] | None	How a resource is related to the compartment	None

CompartmentDefinitionResource

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

Bases: BackboneElement

Information about how a resource is related to the compartment.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Name of resource type	None
param	List[Annotated[str | String, BeforeValidator]] | None	Search Parameter Name, or chained parameters	None
documentation	Annotated[str | String, BeforeValidator] | None	Additional documentation about the resource and compartment	None
startParam	Annotated[str | Uri, BeforeValidator] | None	Search Param for interpreting $everything.start	None
endParam	Annotated[str | Uri, BeforeValidator] | None	Search Param for interpreting $everything.end	None

Composition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this Composition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Version-independent identifier for the Composition	None
version	Annotated[str | String, BeforeValidator] | None	An explicitly assigned identifer of a variation of the content in the Composition	None
status	Annotated[str | Code, BeforeValidator] | None	registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown	None
type	CodeableConcept | None	Kind of composition (LOINC if possible)	None
category	List[CodeableConcept] | None	Categorization of Composition	None
subject	List[Reference] | None	Who and/or what the composition is about	None
encounter	Reference | None	Context of the Composition	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Composition editing time	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
author	List[Reference] | None	Who and/or what authored the composition	None
name	Annotated[str | String, BeforeValidator] | None	Name for this Composition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Human Readable name/title	None
note	List[Annotation] | None	For any additional notes	None
attester	List[CompositionAttester] | None	Attests to accuracy of composition	None
custodian	Reference | None	Organization which maintains the composition	None
relatesTo	List[RelatedArtifact] | 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

CompositionAttester

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableConcept | None	personal | professional | legal | official	None
time	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the composition was attested	None
party	Reference | None	Who attested the composition	None

CompositionEvent

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
period	Period | None	The period covered by the documentation	None
detail	List[CodeableReference] | None	The event(s) being documented, as code(s), reference(s), or both	None

CompositionSection

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

Bases: BackboneElement

The root of the sections that make up the composition.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Label for section (e.g. for ToC)	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
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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this concept map, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the concept map	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the concept map	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this concept map (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this concept map (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the concept map	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	Annotated[str | Markdown, BeforeValidator] | None	Why this concept map is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the ConceptMap was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the ConceptMap was last reviewed by the publisher	None
effectivePeriod	Period | None	When the ConceptMap is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc	None
author	List[ContactDetail] | None	Who authored the ConceptMap	None
editor	List[ContactDetail] | None	Who edited the ConceptMap	None
reviewer	List[ContactDetail] | None	Who reviewed the ConceptMap	None
endorser	List[ContactDetail] | None	Who endorsed the ConceptMap	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc	None
property_	List[ConceptMapProperty] | None	Additional properties of the mapping	None
additionalAttribute	List[ConceptMapAdditionalAttribute] | None	Definition of an additional attribute to act as a data source or target	None
sourceScopeUri	Annotated[str | Uri, BeforeValidator] | None	The source value set that contains the concepts that are being mapped	None
sourceScopeCanonical	Annotated[str | Canonical, BeforeValidator] | None	The source value set that contains the concepts that are being mapped	None
targetScopeUri	Annotated[str | Uri, BeforeValidator] | None	The target value set which provides context for the mappings	None
targetScopeCanonical	Annotated[str | Canonical, BeforeValidator] | None	The target value set which provides context for the mappings	None
group	List[ConceptMapGroup] | None	Same source and target systems	None

ConceptMapAdditionalAttribute

Path: fhircraft.fhir.resources.datatypes.R5.core.concept_map.ConceptMapAdditionalAttribute

Bases: BackboneElement

An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Identifies this additional attribute through this resource	None
uri	Annotated[str | Uri, BeforeValidator] | None	Formal identifier for the data element referred to in this attribte	None
description	Annotated[str | String, BeforeValidator] | None	Why the additional attribute is defined, and/or what the data element it refers to is	None
type	Annotated[str | Code, BeforeValidator] | None	code | Coding | string | boolean | Quantity	None

ConceptMapGroup

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Canonical, BeforeValidator] | None	Source system where concepts to be mapped are defined	None
target	Annotated[str | Canonical, BeforeValidator] | None	Target system that the concepts are to be mapped to	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 target for the source concept and ConceptMap.group.element.noMap is not true	None

ConceptMapGroupElement

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Identifies element being mapped	None
display	Annotated[str | String, BeforeValidator] | None	Display for the code	None
valueSet	Annotated[str | Canonical, BeforeValidator] | None	Identifies the set of concepts being mapped	None
noMap	Annotated[bool | Boolean, BeforeValidator] | None	No mapping to a target concept for this source concept	None
target	List[ConceptMapGroupElementTarget] | None	Concept in target system for element	None

ConceptMapGroupElementTarget

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	code that identifies the target element	None
display	Annotated[str | String, BeforeValidator] | None	Display for the code	None
valueSet	Annotated[str | Canonical, BeforeValidator] | None	Identifies the set of target concepts	None
relationship	Annotated[str | Code, BeforeValidator] | None	related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to	None
comment	Annotated[str | String, BeforeValidator] | None	Description of status/issues in mapping	None
property_	List[ConceptMapGroupElementTargetProperty] | None	Property value for the source -> target mapping	None
dependsOn	List[ConceptMapGroupElementTargetDependsOn] | None	Other properties required for this mapping	None
product	List[ConceptMapGroupElementTargetProduct] | None	Other data elements that this mapping also produces	None

ConceptMapGroupElementTargetDependsOn

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
attribute	Annotated[str | Code, BeforeValidator] | None	A reference to a mapping attribute defined in ConceptMap.additionalAttribute	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Value of the referenced data element	None
valueCoding	Coding | None	Value of the referenced data element	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the referenced data element	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the referenced data element	None
valueQuantity	Quantity | None	Value of the referenced data element	None
valueSet	Annotated[str | Canonical, BeforeValidator] | None	The mapping depends on a data element with a value from this value set	None

ConceptMapGroupElementTargetProduct

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

Bases: BackboneElement

Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
attribute	Annotated[str | Code, BeforeValidator] | None	A reference to a mapping attribute defined in ConceptMap.additionalAttribute	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Value of the referenced data element	None
valueCoding	Coding | None	Value of the referenced data element	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the referenced data element	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the referenced data element	None
valueQuantity	Quantity | None	Value of the referenced data element	None
valueSet	Annotated[str | Canonical, BeforeValidator] | None	The mapping depends on a data element with a value from this value set	None

ConceptMapGroupElementTargetProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.concept_map.ConceptMapGroupElementTargetProperty

Bases: BackboneElement

A property value for this source -> target mapping.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Reference to ConceptMap.property.code	None
valueCoding	Coding | None	Value of the property for this concept	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the property for this concept	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Value of the property for this concept	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the property for this concept	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Value of the property for this concept	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Value of the property for this concept	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Value of the property for this concept	None

ConceptMapGroupUnmapped

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

Bases: BackboneElement

What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	use-source-code | fixed | other-map	None
code	Annotated[str | Code, BeforeValidator] | None	Fixed code when mode = fixed	None
display	Annotated[str | String, BeforeValidator] | None	Display for the code	None
valueSet	Annotated[str | Canonical, BeforeValidator] | None	Fixed code set when mode = fixed	None
relationship	Annotated[str | Code, BeforeValidator] | None	related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to	None
otherMap	Annotated[str | Canonical, BeforeValidator] | None	canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped	None

ConceptMapProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.concept_map.ConceptMapProperty

Bases: BackboneElement

A property defines a slot through which additional information can be provided about a map from source -> target.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Identifies the property on the mappings, and when referred to in the $translate operation	None
uri	Annotated[str | Uri, BeforeValidator] | None	Formal identifier for the property	None
description	Annotated[str | String, BeforeValidator] | None	Why the property is defined, and/or what it conveys	None
type	Annotated[str | Code, BeforeValidator] | None	Coding | string | integer | boolean | dateTime | decimal | code	None
system	Annotated[str | Canonical, BeforeValidator] | None	The CodeSystem from which code values come	None

Condition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 | unknown	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	The Encounter during which this Condition was created	None
onsetDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Estimated or actual date, date-time, or age	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	Annotated[str | String, BeforeValidator] | None	Estimated or actual date, date-time, or age	None
abatementDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When in resolution/remission	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	Annotated[str | String, BeforeValidator] | None	When in resolution/remission	None
recordedDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date condition was first recorded	None
participant	List[ConditionParticipant] | None	Who or what participated in the activities related to the condition and how they were involved	None
stage	List[ConditionStage] | None	Stage/grade, usually assessed formally	None
evidence	List[CodeableReference] | None	Supporting evidence for the verification status	None
note	List[Annotation] | None	Additional information about the Condition	None

ConditionParticipant

Path: fhircraft.fhir.resources.datatypes.R5.core.condition.ConditionParticipant

Bases: BackboneElement

Indicates who or what participated in the activities related to the condition and how they were involved.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 involvement	None
actor	Reference | None	Who or what participated in the activities related to the condition	None

ConditionStage

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

Bases: BackboneElement

A simple summary of the stage such as "Stage 3" or "Early Onset". The determination of the stage is disease-specific, such as cancer, retinopathy of prematurity, kidney diseases, Alzheimer's, or Parkinson disease.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

ConditionDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.condition_definition.ConditionDefinition

Bases: DomainResource

A definition of a condition and information relevant to managing it.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this condition definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the condition definition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the condition definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this condition definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this condition definition (human friendly)	None
subtitle	Annotated[str | String, BeforeValidator] | None	Subordinate title of the event definition	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the condition definition	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for condition definition (if applicable)	None
code	CodeableConcept | None	Identification of the condition, problem or diagnosis	None
severity	CodeableConcept | None	Subjective severity of condition	None
bodySite	CodeableConcept | None	Anatomical location, if relevant	None
stage	CodeableConcept | None	Stage/grade, usually assessed formally	None
hasSeverity	Annotated[bool | Boolean, BeforeValidator] | None	Whether Severity is appropriate	None
hasBodySite	Annotated[bool | Boolean, BeforeValidator] | None	Whether bodySite is appropriate	None
hasStage	Annotated[bool | Boolean, BeforeValidator] | None	Whether stage is appropriate	None
definition	List[Annotated[str | Uri, BeforeValidator]] | None	Formal Definition for the condition	None
observation	List[ConditionDefinitionObservation] | None	Observations particularly relevant to this condition	None
medication	List[ConditionDefinitionMedication] | None	Medications particularly relevant for this condition	None
precondition	List[ConditionDefinitionPrecondition] | None	Observation that suggets this condition	None
team	List[Reference] | None	Appropriate team for this condition	None
questionnaire	List[ConditionDefinitionQuestionnaire] | None	Questionnaire for this condition	None
plan	List[ConditionDefinitionPlan] | None	Plan that is appropriate	None

ConditionDefinitionMedication

Path: fhircraft.fhir.resources.datatypes.R5.core.condition_definition.ConditionDefinitionMedication

Bases: BackboneElement

Medications particularly relevant for this condition.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Category that is relevant	None
code	CodeableConcept | None	code for relevant Medication	None

ConditionDefinitionObservation

Path: fhircraft.fhir.resources.datatypes.R5.core.condition_definition.ConditionDefinitionObservation

Bases: BackboneElement

Observations particularly relevant to this condition.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Category that is relevant	None
code	CodeableConcept | None	code for relevant Observation	None

ConditionDefinitionPlan

Path: fhircraft.fhir.resources.datatypes.R5.core.condition_definition.ConditionDefinitionPlan

Bases: BackboneElement

Plan that is appropriate.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Use for the plan	None
reference	Reference | None	The actual plan	None

ConditionDefinitionPrecondition

Path: fhircraft.fhir.resources.datatypes.R5.core.condition_definition.ConditionDefinitionPrecondition

Bases: BackboneElement

An observation that suggests that this condition applies.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	sensitive | specific	None
code	CodeableConcept | None	code for relevant Observation	None
valueCodeableConcept	CodeableConcept | None	Value of Observation	None
valueQuantity	Quantity | None	Value of Observation	None

ConditionDefinitionQuestionnaire

Path: fhircraft.fhir.resources.datatypes.R5.core.condition_definition.ConditionDefinitionQuestionnaire

Bases: BackboneElement

Questionnaire for this condition.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	preadmit | diff-diagnosis | outcome	None
reference	Reference | None	Specific Questionnaire	None

Consent

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

Bases: DomainResource

A record of a healthcare consumer’s choices or choices made on their behalf by a third party, 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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	draft | active | inactive | not-done | entered-in-error | unknown	None
category	List[CodeableConcept] | None	Classification of the consent statement - for indexing/retrieval	None
subject	Reference | None	Who the consent applies to	None
date	Annotated[date | str | Date, BeforeValidator] | None	Fully executed date of the consent	None
period	Period | None	Effective period for this Consent	None
grantor	List[Reference] | None	Who is granting rights according to the policy and rules	None
grantee	List[Reference] | None	Who is agreeing to the policy and rules	None
manager	List[Reference] | None	Consent workflow management	None
controller	List[Reference] | None	Consent Enforcer	None
sourceAttachment	List[Attachment] | None	Source from which this consent is taken	None
sourceReference	List[Reference] | None	Source from which this consent is taken	None
regulatoryBasis	List[CodeableConcept] | None	Regulations establishing base Consent	None
policyBasis	ConsentPolicyBasis | None	Computable version of the backing policy	None
policyText	List[Reference] | None	Human Readable Policy	None
verification	List[ConsentVerification] | None	Consent Verified by patient or family	None
decision	Annotated[str | Code, BeforeValidator] | None	deny | permit	None
provision	List[ConsentProvision] | None	Constraints to the base Consent.policyRule/Consent.policy	None

ConsentPolicyBasis

Path: fhircraft.fhir.resources.datatypes.R5.core.consent.ConsentPolicyBasis

Bases: BackboneElement

A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent. This Reference or URL should be specific to the version of the policy and should be dereferencable to a computable policy of some form.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Reference backing policy resource	None
url	Annotated[str | Url, BeforeValidator] | None	URL to a computable backing policy	None

ConsentProvision

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
period	Period | None	Timeframe for this provision	None
actor	List[ConsentProvisionActor] | None	Who|what controlled by this provision (or group, by role)	None
action	List[CodeableConcept] | None	Actions controlled by this provision	None
securityLabel	List[Coding] | None	Security Labels that define affected resources	None
purpose	List[Coding] | None	Context of activities covered by this provision	None
documentType	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 provision	None
data	List[ConsentProvisionData] | None	Data controlled by this provision	None
expression	Expression | None	A computable expression of the consent	None
provision	List[ConsentProvision] | None	Nested Exception Provisions	None

ConsentProvisionActor

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.consent.ConsentProvisionData

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	instance | related | dependents | authoredby	None
reference	Reference | None	The actual data reference	None

ConsentVerification

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Has been verified	None
verificationType	CodeableConcept | None	Business case of verification	None
verifiedBy	Reference | None	Person conducting verification	None
verifiedWith	Reference | None	Person who verified	None
verificationDate	List[Annotated[datetime | date | str | DateTime, BeforeValidator]] | None	When consent verified	None

Contract

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	Basal definition	None
version	Annotated[str | String, BeforeValidator] | None	Business edition	None
status	Annotated[str | Code, BeforeValidator] | None	amended | appended | cancelled | disputed | entered-in-error | executable +	None
legalState	CodeableConcept | None	Negotiation status	None
instantiatesCanonical	Reference | None	Source Contract Definition	None
instantiatesUri	Annotated[str | Uri, BeforeValidator] | None	External Contract Definition	None
contentDerivative	CodeableConcept | None	Content derived from the basal information	None
issued	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When this Contract was issued	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	Annotated[str | String, BeforeValidator] | None	Computer friendly designation	None
title	Annotated[str | String, BeforeValidator] | None	Human Friendly name	None
subtitle	Annotated[str | String, BeforeValidator] | None	Subordinate Friendly name	None
alias	List[Annotated[str | String, BeforeValidator]] | None	Acronym or short name	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

ContractContentDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When published	None
publicationStatus	Annotated[str | Code, BeforeValidator] | None	amended | appended | cancelled | disputed | entered-in-error | executable +	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Publication Ownership	None

ContractFriendly

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.contract.ContractLegal

Bases: BackboneElement

List of Legal expressions or representations of this Contract.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.contract.ContractRule

Bases: BackboneElement

List of Computable Policy Rule Language Representations of this Contract.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Contract Term Issue date time	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	Annotated[str | String, BeforeValidator] | None	Term Statement	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	True if the term prohibits the action	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[Annotated[str | String, BeforeValidator]] | None	Pointer to specific item	None
status	CodeableConcept | None	State of the action	None
context	Reference | None	Episode associated with action	None
contextLinkId	List[Annotated[str | String, BeforeValidator]] | None	Pointer to specific item	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When action happens	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[Annotated[str | String, BeforeValidator]] | None	Pointer to specific item	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[Annotated[str | String, BeforeValidator]] | None	Pointer to specific item	None
reason	List[CodeableReference] | None	Why is action (not) needed?	None
reasonLinkId	List[Annotated[str | String, BeforeValidator]] | None	Pointer to specific item	None
note	List[Annotation] | None	Comments about the action	None
securityLabelNumber	List[Annotated[int | UnsignedInt, BeforeValidator]] | None	Action restriction numbers	None

ContractTermActionSubject

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

Bases: BackboneElement

Entity of the action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.contract.ContractTermAsset

Bases: BackboneElement

Contract Term Asset List.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Quality desctiption of asset	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	Annotated[str | String, BeforeValidator] | None	Asset clause or question text	None
linkId	List[Annotated[str | String, BeforeValidator]] | None	Pointer to asset text	None
answer	List[ContractTermAssetAnswer] | None	Response to assets	None
securityLabelNumber	List[Annotated[int | UnsignedInt, BeforeValidator]] | None	Asset restriction numbers	None
valuedItem	List[ContractTermAssetValuedItem] | None	Contract Valued Item List	None

ContractTermAssetAnswer

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

Bases: BackboneElement

Response to assets.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	The actual answer response	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	The actual answer response	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	The actual answer response	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	The actual answer response	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The actual answer response	None
valueTime	Annotated[time | Time, BeforeValidator] | None	The actual answer response	None
valueString	Annotated[str | String, BeforeValidator] | None	The actual answer response	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	The actual answer response	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.R5.core.contract.ContractTermAssetContext

Bases: BackboneElement

Circumstance of the asset.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Context description	None

ContractTermAssetValuedItem

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

Bases: BackboneElement

Contract Valued Item List.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Contract Valued Item Effective Tiem	None
quantity	Quantity | None	Count of Contract Valued Items	None
unitPrice	Money | None	Contract Valued Item fee, charge, or cost	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Contract Valued Item Price Scaling Factor	None
points	Annotated[float | Decimal, BeforeValidator] | None	Contract Valued Item Difficulty Scaling Factor	None
net	Money | None	Total Contract Valued Item Value	None
payment	Annotated[str | String, BeforeValidator] | None	Terms of valuation	None
paymentDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When payment is due	None
responsible	Reference | None	Who will make payment	None
recipient	Reference | None	Who will receive payment	None
linkId	List[Annotated[str | String, BeforeValidator]] | None	Pointer to specific item	None
securityLabelNumber	List[Annotated[int | UnsignedInt, BeforeValidator]] | None	Security Labels that define affected terms	None

ContractTermOffer

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Human readable offer text	None
linkId	List[Annotated[str | String, BeforeValidator]] | None	Pointer to text	None
securityLabelNumber	List[Annotated[int | UnsignedInt, BeforeValidator]] | None	Offer restriction numbers	None

ContractTermOfferAnswer

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

Bases: BackboneElement

Response to offer text.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	The actual answer response	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	The actual answer response	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	The actual answer response	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	The actual answer response	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The actual answer response	None
valueTime	Annotated[time | Time, BeforeValidator] | None	The actual answer response	None
valueString	Annotated[str | String, BeforeValidator] | None	The actual answer response	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	The actual answer response	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.R5.core.contract.ContractTermOfferParty

Bases: BackboneElement

Offer Recipient.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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[Annotated[int | UnsignedInt, BeforeValidator]] | None	Link to Security Labels	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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) for this coverage	None
status	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
kind	Annotated[str | Code, BeforeValidator] | None	insurance | self-pay | other	None
paymentBy	List[CoveragePaymentBy] | None	Self-pay parties and responsibility	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	List[Identifier] | None	ID assigned to the subscriber	None
beneficiary	Reference | None	Plan beneficiary	None
dependent	Annotated[str | String, BeforeValidator] | None	Dependent number	None
relationship	CodeableConcept | None	Beneficiary relationship to the subscriber	None
period	Period | None	Coverage start and end dates	None
insurer	Reference | None	Issuer of the policy	None
class_	List[CoverageClass] | None	Additional coverage classifications	None
order	Annotated[int | PositiveInt, BeforeValidator] | None	Relative order of the coverage	None
network	Annotated[str | String, BeforeValidator] | None	Insurer network	None
costToBeneficiary	List[CoverageCostToBeneficiary] | None	Patient payments for services/products	None
subrogation	Annotated[bool | Boolean, BeforeValidator] | None	Reimbursement to insurer	None
contract	List[Reference] | None	Contract details	None
insurancePlan	Reference | None	Insurance plan details	None

CoverageClass

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

Bases: BackboneElement

A suite of underwriter specific classifiers.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Identifier | None	Value associated with the type	None
name	Annotated[str | String, BeforeValidator] | None	Human readable description of the type and value	None

CoverageCostToBeneficiary

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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
category	CodeableConcept | None	Benefit classification	None
network	CodeableConcept | None	In or out of network	None
unit	CodeableConcept | None	Individual or family	None
term	CodeableConcept | None	Annual or lifetime	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.R5.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	str | None	Unique id for inter-element referencing	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

CoveragePaymentBy

Path: fhircraft.fhir.resources.datatypes.R5.core.coverage.CoveragePaymentBy

Bases: BackboneElement

Link to the paying party and optionally what specifically they will be responsible to pay.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Parties performing self-payment	None
responsibility	Annotated[str | String, BeforeValidator] | None	Party's responsibility	None

CoverageEligibilityRequest

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
priority	CodeableConcept | None	Desired processing priority	None
purpose	List[Annotated[str | Code, BeforeValidator]] | None	auth-requirements | benefits | discovery | validation	None
patient	Reference | None	Intended recipient of products and services	None
event	List[CoverageEligibilityRequestEvent] | None	Event information	None
servicedDate	Annotated[date | str | Date, BeforeValidator] | None	Estimated date or dates of service	None
servicedPeriod	Period | None	Estimated date or dates of service	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Creation date	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

CoverageEligibilityRequestEvent

Path: fhircraft.fhir.resources.datatypes.R5.core.coverage_eligibility_request.CoverageEligibilityRequestEvent

Bases: BackboneElement

Information code for an event with a corresponding date or period.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Specific event	None
whenDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Occurance date or period	None
whenPeriod	Period | None	Occurance date or period	None

CoverageEligibilityRequestInsurance

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Applicable coverage	None
coverage	Reference | None	Insurance information	None
businessArrangement	Annotated[str | String, BeforeValidator] | None	Additional provider contract number	None

CoverageEligibilityRequestItem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable exception or supporting information	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.R5.core.coverage_eligibility_request.CoverageEligibilityRequestItemDiagnosis

Bases: BackboneElement

Patient diagnosis for which care is sought.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Information instance identifier	None
information	Reference | None	Data to be provided	None
appliesToAll	Annotated[bool | Boolean, BeforeValidator] | None	Applies to all items	None

CoverageEligibilityResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
purpose	List[Annotated[str | Code, BeforeValidator]] | None	auth-requirements | benefits | discovery | validation	None
patient	Reference | None	Intended recipient of products and services	None
event	List[CoverageEligibilityResponseEvent] | None	Event information	None
servicedDate	Annotated[date | str | Date, BeforeValidator] | None	Estimated date or dates of service	None
servicedPeriod	Period | None	Estimated date or dates of service	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Response creation date	None
requestor	Reference | None	Party responsible for the request	None
request	Reference | None	Eligibility request reference	None
outcome	Annotated[str | Code, BeforeValidator] | None	queued | complete | error | partial	None
disposition	Annotated[str | String, BeforeValidator] | None	Disposition Message	None
insurer	Reference | None	Coverage issuer	None
insurance	List[CoverageEligibilityResponseInsurance] | None	Patient insurance information	None
preAuthRef	Annotated[str | String, BeforeValidator] | None	Preauthorization reference	None
form	CodeableConcept | None	Printed form identifier	None
error	List[CoverageEligibilityResponseError] | None	Processing errors	None

CoverageEligibilityResponseError

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

Bases: BackboneElement

Errors encountered during the processing of the request.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
expression	List[Annotated[str | String, BeforeValidator]] | None	FHIRPath of element(s) related to issue	None

CoverageEligibilityResponseEvent

Path: fhircraft.fhir.resources.datatypes.R5.core.coverage_eligibility_response.CoverageEligibilityResponseEvent

Bases: BackboneElement

Information code for an event with a corresponding date or period.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Specific event	None
whenDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Occurance date or period	None
whenPeriod	Period | None	Occurance date or period	None

CoverageEligibilityResponseInsurance

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Coverage inforce indicator	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Excluded from the plan	None
name	Annotated[str | String, BeforeValidator] | None	Short name for the benefit	None
description	Annotated[str | String, BeforeValidator] | None	Description of the benefit or services covered	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	Annotated[bool | Boolean, BeforeValidator] | None	Authorization required flag	None
authorizationSupporting	List[CodeableConcept] | None	Type of required supporting materials	None
authorizationUrl	Annotated[str | Uri, BeforeValidator] | None	Preauthorization requirements endpoint	None

CoverageEligibilityResponseInsuranceItemBenefit

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

Bases: BackboneElement

Benefits used to date.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | UnsignedInt, BeforeValidator] | None	Benefits allowed	None
allowedString	Annotated[str | String, BeforeValidator] | None	Benefits allowed	None
allowedMoney	Money | None	Benefits allowed	None
usedUnsignedInt	Annotated[int | UnsignedInt, BeforeValidator] | None	Benefits used	None
usedString	Annotated[str | String, BeforeValidator] | None	Benefits used	None
usedMoney	Money | None	Benefits used	None

DetectedIssue

Path: fhircraft.fhir.resources.datatypes.R5.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, gaps in care, etc.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	preliminary | final | entered-in-error | mitigated	None
category	List[CodeableConcept] | None	Type of detected issue, e.g. drug-drug, duplicate therapy, etc	None
code	CodeableConcept | None	Specific type of detected issue, e.g. drug-drug, duplicate therapy, etc	None
severity	Annotated[str | Code, BeforeValidator] | None	high | moderate | low	None
subject	Reference | None	Associated subject	None
encounter	Reference | None	Encounter detected issue is part of	None
identifiedDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When identified	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	Annotated[str | Markdown, BeforeValidator] | None	Description and context	None
reference	Annotated[str | Uri, BeforeValidator] | None	Authority for issue	None
mitigation	List[DetectedIssueMitigation] | None	Step taken to address	None

DetectedIssueEvidence

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date committed	None
author	Reference | None	Who is committing?	None
note	List[Annotation] | None	Additional notes about the mitigation	None

Device

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

Bases: DomainResource

This resource describes the properties (regulated, has real time clock, etc.), adminstrative (manufacturer name, model number, serial number, firmware, etc.), and type (knee replacement, blood pressure cuff, MRI, etc.) of a physical unit (these values do not change much within a given module, for example the serail number, manufacturer name, and model number). An actual unit may consist of several modules in a distinct hierarchy and these are represented by multiple Device resources and bound through the 'parent' element.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
displayName	Annotated[str | String, BeforeValidator] | None	The name used to display by default when the device is referenced	None
definition	CodeableReference | None	The reference to the definition for the device	None
udiCarrier	List[DeviceUdiCarrier] | None	Unique Device Identifier (UDI) Barcode string	None
status	Annotated[str | Code, BeforeValidator] | None	active | inactive | entered-in-error	None
availabilityStatus	CodeableConcept | None	lost | damaged | destroyed | available	None
biologicalSourceEvent	Identifier | None	An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled	None
manufacturer	Annotated[str | String, BeforeValidator] | None	Name of device manufacturer	None
manufactureDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date when the device was made	None
expirationDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date and time of expiry of this device (if applicable)	None
lotNumber	Annotated[str | String, BeforeValidator] | None	Lot number of manufacture	None
serialNumber	Annotated[str | String, BeforeValidator] | None	Serial number assigned by the manufacturer	None
name	List[DeviceName] | None	The name or names of the device as known to the manufacturer and/or patient	None
modelNumber	Annotated[str | String, BeforeValidator] | None	The manufacturer's model number for the device	None
partNumber	Annotated[str | String, BeforeValidator] | None	The part number or catalog number of the device	None
category	List[CodeableConcept] | None	Indicates a high-level grouping of the device	None
type	List[CodeableConcept] | None	The kind or type of device	None
version	List[DeviceVersion] | None	The actual design of the device or software version running on the device	None
conformsTo	List[DeviceConformsTo] | None	Identifies the standards, specifications, or formal guidances for the capabilities supported by the device	None
property_	List[DeviceProperty] | None	Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.	None
mode	CodeableConcept | None	The designated condition for performing a task	None
cycle	Count | None	The series of occurrences that repeats during the operation of the device	None
duration	Duration | None	A measurement of time during the device's operation (e.g., days, hours, mins, etc.)	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	Annotated[str | Uri, BeforeValidator] | None	Network address to contact device	None
endpoint	List[Reference] | None	Technical endpoints providing access to electronic services provided by the device	None
gateway	List[CodeableReference] | None	Linked device acting as a communication/data collector, translator or controller	None
note	List[Annotation] | None	Device notes and comments	None
safety	List[CodeableConcept] | None	Safety Characteristics of Device	None
parent	Reference | None	The higher level or encompassing device that this device is a logical part of	None

DeviceConformsTo

Path: fhircraft.fhir.resources.datatypes.R5.core.device.DeviceConformsTo

Bases: BackboneElement

Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement	None
specification	CodeableConcept | None	Identifies the standard, specification, or formal guidance that the device adheres to	None
version	Annotated[str | String, BeforeValidator] | None	Specific form or variant of the standard	None

DeviceName

Path: fhircraft.fhir.resources.datatypes.R5.core.device.DeviceName

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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The term that names the device	None
type	Annotated[str | Code, BeforeValidator] | None	registered-name | user-friendly-name | patient-reported-name	None
display	Annotated[bool | Boolean, BeforeValidator] | None	The preferred device name	None

DeviceProperty

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

Bases: BackboneElement

Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 being represented	None
valueQuantity	Quantity | None	Value of the property	None
valueCodeableConcept	CodeableConcept | None	Value of the property	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the property	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the property	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Value of the property	None
valueRange	Range | None	Value of the property	None
valueAttachment	Attachment | None	Value of the property	None

DeviceUdiCarrier

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Mandatory fixed portion of UDI	None
issuer	Annotated[str | Uri, BeforeValidator] | None	UDI Issuing Organization	None
jurisdiction	Annotated[str | Uri, BeforeValidator] | None	Regional UDI authority	None
carrierAIDC	Annotated[str | Base64Binary, BeforeValidator] | None	UDI Machine Readable Barcode string	None
carrierHRF	Annotated[str | String, BeforeValidator] | None	UDI Human Readable Barcode string	None
entryType	Annotated[str | Code, BeforeValidator] | None	barcode | rfid | manual | card | self-reported | electronic-transmission | unknown	None

DeviceVersion

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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, e.g. manufacturer, approved, internal	None
component	Identifier | None	The hardware or software module of the device to which the version applies	None
installDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date the version was installed on the device	None
value	Annotated[str | String, BeforeValidator] | None	The version text	None

DeviceAssociation

Path: fhircraft.fhir.resources.datatypes.R5.core.device_association.DeviceAssociation

Bases: DomainResource

A record of association of a device.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
device	Reference | None	Reference to the devices associated with the patient or group	None
category	List[CodeableConcept] | None	Describes the relationship between the device and subject	None
status	CodeableConcept | None	implanted | explanted | attached | entered-in-error | unknown	None
statusReason	List[CodeableConcept] | None	The reasons given for the current association status	None
subject	Reference | None	The individual, group of individuals or device that the device is on or associated with	None
bodyStructure	Reference | None	Current anatomical location of the device in/on subject	None
period	Period | None	Begin and end dates and times for the device association	None
operation	List[DeviceAssociationOperation] | None	The details about the device when it is in use to describe its operation	None

DeviceAssociationOperation

Path: fhircraft.fhir.resources.datatypes.R5.core.device_association.DeviceAssociationOperation

Bases: BackboneElement

The details about the device when it is in use to describe its operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableConcept | None	Device operational condition	None
operator	List[Reference] | None	The individual performing the action enabled by the device	None
period	Period | None	Begin and end dates and times for the device's operation	None

DeviceDefinition

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

Bases: DomainResource

This is a specialized resource that defines the characteristics and capabilities of a device.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
description	Annotated[str | Markdown, BeforeValidator] | None	Additional information to describe the device	None
identifier	List[Identifier] | None	Instance identifier	None
udiDeviceIdentifier	List[DeviceDefinitionUdiDeviceIdentifier] | None	Unique Device Identifier (UDI) Barcode string	None
regulatoryIdentifier	List[DeviceDefinitionRegulatoryIdentifier] | None	Regulatory identifier(s) associated with this device	None
partNumber	Annotated[str | String, BeforeValidator] | None	The part number or catalog number of the device	None
manufacturer	Reference | None	Name of device manufacturer	None
deviceName	List[DeviceDefinitionDeviceName] | None	The name or names of the device as given by the manufacturer	None
modelNumber	Annotated[str | String, BeforeValidator] | None	The catalog or model number for the device for example as defined by the manufacturer	None
classification	List[DeviceDefinitionClassification] | None	What kind of device or device system this is	None
conformsTo	List[DeviceDefinitionConformsTo] | None	Identifies the standards, specifications, or formal guidances for the capabilities supported by the device	None
hasPart	List[DeviceDefinitionHasPart] | None	A device, part of the current one	None
packaging	List[DeviceDefinitionPackaging] | None	Information about the packaging of the device, i.e. how the device is packaged	None
version	List[DeviceDefinitionVersion] | None	The version of the device or software	None
safety	List[CodeableConcept] | None	Safety characteristics of the device	None
shelfLifeStorage	List[ProductShelfLife] | None	Shelf Life and storage information	None
languageCode	List[CodeableConcept] | None	Language code for the human-readable text strings produced by the device (all supported)	None
property_	List[DeviceDefinitionProperty] | None	Inherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc	None
owner	Reference | None	Organization responsible for device	None
contact	List[ContactPoint] | None	Details for human/organization for support	None
link	List[DeviceDefinitionLink] | None	An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device	None
note	List[Annotation] | None	Device notes and comments	None
material	List[DeviceDefinitionMaterial] | None	A substance used to create the material(s) of which the device is made	None
productionIdentifierInUDI	List[Annotated[str | Code, BeforeValidator]] | None	lot-number | manufactured-date | serial-number | expiration-date | biological-source | software-version	None
guideline	DeviceDefinitionGuideline | None	Information aimed at providing directions for the usage of this model of device	None
correctiveAction	DeviceDefinitionCorrectiveAction | None	Tracking of latest field safety corrective action	None
chargeItem	List[DeviceDefinitionChargeItem] | None	Billing code or reference associated with the device	None

DeviceDefinitionChargeItem

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionChargeItem

Bases: BackboneElement

Billing code or reference associated with the device.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
chargeItemCode	CodeableReference | None	The code or reference for the charge item	None
count	Quantity | None	Coefficient applicable to the billing code	None
effectivePeriod	Period | None	A specific time period in which this charge item applies	None
useContext	List[UsageContext] | None	The context to which this charge item applies	None

DeviceDefinitionClassification

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionClassification

Bases: BackboneElement

What kind of device or device system this is.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 classification or risk class of the device model	None
justification	List[RelatedArtifact] | None	Further information qualifying this classification of the device model	None

DeviceDefinitionConformsTo

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionConformsTo

Bases: BackboneElement

Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Describes the common type of the standard, specification, or formal guidance	None
specification	CodeableConcept | None	Identifies the standard, specification, or formal guidance that the device adheres to the Device Specification type	None
version	List[Annotated[str | String, BeforeValidator]] | None	The specific form or variant of the standard, specification or formal guidance	None
source	List[RelatedArtifact] | None	Standard, regulation, certification, or guidance website, document, or other publication, or similar, supporting the conformance	None

DeviceDefinitionCorrectiveAction

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionCorrectiveAction

Bases: BackboneElement

Tracking of latest field safety corrective action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
recall	Annotated[bool | Boolean, BeforeValidator] | None	Whether the corrective action was a recall	None
scope	Annotated[str | Code, BeforeValidator] | None	model | lot-numbers | serial-numbers	None
period	Period | None	Start and end dates of the corrective action	None

DeviceDefinitionDeviceName

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

Bases: BackboneElement

The name or names of the device as given by the manufacturer.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	A name that is used to refer to the device	None
type	Annotated[str | Code, BeforeValidator] | None	registered-name | user-friendly-name | patient-reported-name	None

DeviceDefinitionGuideline

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionGuideline

Bases: BackboneElement

Information aimed at providing directions for the usage of this model of device.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
useContext	List[UsageContext] | None	The circumstances that form the setting for using the device	None
usageInstruction	Annotated[str | Markdown, BeforeValidator] | None	Detailed written and visual directions for the user on how to use the device	None
relatedArtifact	List[RelatedArtifact] | None	A source of information or reference for this guideline	None
indication	List[CodeableConcept] | None	A clinical condition for which the device was designed to be used	None
contraindication	List[CodeableConcept] | None	A specific situation when a device should not be used because it may cause harm	None
warning	List[CodeableConcept] | None	Specific hazard alert information that a user needs to know before using the device	None
intendedUse	Annotated[str | String, BeforeValidator] | None	A description of the general purpose or medical use of the device or its function	None

DeviceDefinitionHasPart

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionHasPart

Bases: BackboneElement

A device that is part (for example a component) of the present device.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Reference to the part	None
count	Annotated[int | Integer, BeforeValidator] | None	Number of occurrences of the part	None

DeviceDefinitionLink

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionLink

Bases: BackboneElement

An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Coding | None	The type indicates the relationship of the related device to the device instance	None
relatedDevice	CodeableReference | None	A reference to the linked device	None

DeviceDefinitionMaterial

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	A relevant substance that the device contains, may contain, or is made of	None
alternate	Annotated[bool | Boolean, BeforeValidator] | None	Indicates an alternative material of the device	None
allergenicIndicator	Annotated[bool | Boolean, BeforeValidator] | None	Whether the substance is a known or suspected allergen	None

DeviceDefinitionPackaging

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionPackaging

Bases: BackboneElement

Information about the packaging of the device, i.e. how the device is packaged.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 packaged medication	None
type	CodeableConcept | None	A code that defines the specific type of packaging	None
count	Annotated[int | Integer, BeforeValidator] | None	The number of items contained in the package (devices or sub-packages)	None
distributor	List[DeviceDefinitionPackagingDistributor] | None	An organization that distributes the packaged device	None
udiDeviceIdentifier	List[DeviceDefinitionPackagingUdiDeviceIdentifier] | None	Unique Device Identifier (UDI) Barcode string on the packaging	None
packaging	List[DeviceDefinitionPackaging] | None	Allows packages within packages	None

DeviceDefinitionPackagingDistributor

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionPackagingDistributor

Bases: BackboneElement

An organization that distributes the packaged device.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Distributor's human-readable name	None
organizationReference	List[Reference] | None	Distributor as an Organization resource	None

DeviceDefinitionPackagingUdiDeviceIdentifier

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionPackagingUdiDeviceIdentifier

Bases: BackboneElement

Unique Device Identifier (UDI) Barcode string on the packaging.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier	None
issuer	Annotated[str | Uri, BeforeValidator] | None	The organization that assigns the identifier algorithm	None
jurisdiction	Annotated[str | Uri, BeforeValidator] | None	The jurisdiction to which the deviceIdentifier applies	None
marketDistribution	List[DeviceDefinitionUdiDeviceIdentifierMarketDistribution] | None	Indicates whether and when the device is available on the market	None

DeviceDefinitionProperty

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

Bases: BackboneElement

Static or essentially fixed characteristics or features of this kind of device that are otherwise not captured in more specific attributes, e.g., time or timing attributes, resolution, accuracy, and physical attributes.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 being represented	None
valueQuantity	Quantity | None	Value of the property	None
valueCodeableConcept	CodeableConcept | None	Value of the property	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the property	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the property	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Value of the property	None
valueRange	Range | None	Value of the property	None
valueAttachment	Attachment | None	Value of the property	None

DeviceDefinitionRegulatoryIdentifier

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionRegulatoryIdentifier

Bases: BackboneElement

Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	basic | master | license	None
deviceIdentifier	Annotated[str | String, BeforeValidator] | None	The identifier itself	None
issuer	Annotated[str | Uri, BeforeValidator] | None	The organization that issued this identifier	None
jurisdiction	Annotated[str | Uri, BeforeValidator] | None	The jurisdiction to which the deviceIdentifier applies	None

DeviceDefinitionUdiDeviceIdentifier

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdiction provided in the DeviceDefinition.udiDeviceIdentifier	None
issuer	Annotated[str | Uri, BeforeValidator] | None	The organization that assigns the identifier algorithm	None
jurisdiction	Annotated[str | Uri, BeforeValidator] | None	The jurisdiction to which the deviceIdentifier applies	None
marketDistribution	List[DeviceDefinitionUdiDeviceIdentifierMarketDistribution] | None	Indicates whether and when the device is available on the market	None

DeviceDefinitionUdiDeviceIdentifierMarketDistribution

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionUdiDeviceIdentifierMarketDistribution

Bases: BackboneElement

Indicates where and when the device is available on the market.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
marketPeriod	Period | None	Begin and end dates for the commercial distribution of the device	None
subJurisdiction	Annotated[str | Uri, BeforeValidator] | None	National state or territory where the device is commercialized	None

DeviceDefinitionVersion

Path: fhircraft.fhir.resources.datatypes.R5.core.device_definition.DeviceDefinitionVersion

Bases: BackboneElement

The version of the device or software.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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, e.g. manufacturer, approved, internal	None
component	Identifier | None	The hardware or software module of the device to which the version applies	None
value	Annotated[str | String, BeforeValidator] | None	The version text	None

DeviceDispense

Path: fhircraft.fhir.resources.datatypes.R5.core.device_dispense.DeviceDispense

Bases: DomainResource

Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 dispensation	None
basedOn	List[Reference] | None	The order or request that this dispense is fulfilling	None
partOf	List[Reference] | None	The bigger event that this dispense is a part of	None
status	Annotated[str | Code, BeforeValidator] | None	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown	None
statusReason	CodeableReference | None	Why a dispense was or was not performed	None
category	List[CodeableConcept] | None	Type of device dispense	None
device	CodeableReference | None	What device was supplied	None
subject	Reference | None	Who the dispense is for	None
receiver	Reference | None	Who collected the device or where the medication was delivered	None
encounter	Reference | None	Encounter associated with event	None
supportingInformation	List[Reference] | None	Information that supports the dispensing of the device	None
performer	List[DeviceDispensePerformer] | None	Who performed event	None
location	Reference | None	Where the dispense occurred	None
type	CodeableConcept | None	Trial fill, partial fill, emergency fill, etc	None
quantity	Quantity | None	Amount dispensed	None
preparedDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When product was packaged and reviewed	None
whenHandedOver	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When product was given out	None
destination	Reference | None	Where the device was sent or should be sent	None
note	List[Annotation] | None	Information about the dispense	None
usageInstruction	Annotated[str | Markdown, BeforeValidator] | None	Full representation of the usage instructions	None
eventHistory	List[Reference] | None	A list of relevant lifecycle events	None

DeviceDispensePerformer

Path: fhircraft.fhir.resources.datatypes.R5.core.device_dispense.DeviceDispensePerformer

Bases: BackboneElement

Indicates who or what performed the event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

DeviceMetric

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

Bases: DomainResource

Describes a measurement, calculation or setting capability of a device. The DeviceMetric resource is derived from the ISO/IEEE 11073-10201 Domain Information Model standard, but is more widely applicable.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
device	Reference | None	Describes the link to the Device	None
operationalStatus	Annotated[str | Code, BeforeValidator] | None	on | off | standby | entered-in-error	None
color	Annotated[str | Code, BeforeValidator] | None	Color name (from CSS4) or #RRGGBB code	None
category	Annotated[str | Code, BeforeValidator] | None	measurement | setting | calculation | unspecified	None
measurementFrequency	Quantity | None	Indicates how often the metric is taken or recorded	None
calibration	List[DeviceMetricCalibration] | None	Describes the calibrations that have been performed or that are required to be performed	None

DeviceMetricCalibration

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	unspecified | offset | gain | two-point	None
state	Annotated[str | Code, BeforeValidator] | None	not-calibrated | calibration-required | calibrated | unspecified	None
time	Annotated[datetime | Instant, BeforeValidator] | None	Describes the time last calibration has been performed	None

DeviceRequest

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

Bases: DomainResource

Represents a request a device to be provided to a specific patient. The device may be an implantable device to be subsequently implanted, or an external assistive device, such as a walker, to be delivered and subsequently be used.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	None
basedOn	List[Reference] | None	What request fulfills	None
replaces	List[Reference] | None	What request replaces	None
groupIdentifier	Identifier | None	Identifier of composite request	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
doNotPerform	Annotated[bool | Boolean, BeforeValidator] | None	True if the request is to stop or not to start using the device	None
code	CodeableReference | None	Device requested	None
quantity	Annotated[int | Integer, BeforeValidator] | None	Quantity of devices to supply	None
parameter	List[DeviceRequestParameter] | None	Device details	None
subject	Reference | None	Focus of request	None
encounter	Reference | None	Encounter motivating request	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Desired time or schedule for use	None
occurrencePeriod	Period | None	Desired time or schedule for use	None
occurrenceTiming	Timing | None	Desired time or schedule for use	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When recorded	None
requester	Reference | None	Who/what submitted the device request	None
performer	CodeableReference | None	Requested Filler	None
reason	List[CodeableReference] | None	Coded/Linked Reason for request	None
asNeeded	Annotated[bool | Boolean, BeforeValidator] | None	PRN status of request	None
asNeededFor	CodeableConcept | None	Device usage reason	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

DeviceRequestParameter

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Value of detail	None

DeviceUsage

Path: fhircraft.fhir.resources.datatypes.R5.core.device_usage.DeviceUsage

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 a clinician.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | completed | not-done | entered-in-error +	None
category	List[CodeableConcept] | None	The category of the statement - classifying how the statement is made	None
patient	Reference | None	Patient using device	None
derivedFrom	List[Reference] | None	Supporting information	None
context	Reference | None	The encounter or episode of care that establishes the context for this device use statement	None
timingTiming	Timing | None	How often the device was used	None
timingPeriod	Period | None	How often the device was used	None
timingDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	How often the device was used	None
dateAsserted	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the statement was made (and recorded)	None
usageStatus	CodeableConcept | None	The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement	None
usageReason	List[CodeableConcept] | None	The reason for asserting the usage status - for example forgot, lost, stolen, broken	None
adherence	DeviceUsageAdherence | None	How device is being used	None
informationSource	Reference | None	Who made the statement	None
device	CodeableReference | None	code or Reference to device used	None
reason	List[CodeableReference] | None	Why device was used	None
bodySite	CodeableReference | None	Target body site	None
note	List[Annotation] | None	Addition details (comments, instructions)	None

DeviceUsageAdherence

Path: fhircraft.fhir.resources.datatypes.R5.core.device_usage.DeviceUsageAdherence

Bases: BackboneElement

This indicates how or if the device is being used.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	always | never | sometimes	None
reason	List[CodeableConcept] | None	lost | stolen | prescribed | broken | burned | forgot	None

DiagnosticReport

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

Bases: DomainResource

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

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Clinically relevant time/time-period for report	None
effectivePeriod	Period | None	Clinically relevant time/time-period for report	None
issued	Annotated[datetime | Instant, BeforeValidator] | None	DateTime this version was made	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
note	List[Annotation] | None	Comments about the diagnostic report	None
study	List[Reference] | None	Reference to full details of an analysis associated with the diagnostic report	None
supportingInfo	List[DiagnosticReportSupportingInfo] | None	Additional information supporting the diagnostic report	None
media	List[DiagnosticReportMedia] | None	Key images or data associated with this report	None
composition	Reference | None	Reference to a Composition resource for the DiagnosticReport structure	None
conclusion	Annotated[str | Markdown, BeforeValidator] | None	Clinical conclusion (interpretation) of test results	None
conclusionCode	List[CodeableConcept] | None	Codes for the clinical conclusion of test results	None
presentedForm	List[Attachment] | None	Entire report as issued	None

DiagnosticReportMedia

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

Bases: BackboneElement

A list of key images or data associated with this report. The images or data 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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Comment about the image or data (e.g. explanation)	None
link	Reference | None	Reference to the image or data source	None

DiagnosticReportSupportingInfo

Path: fhircraft.fhir.resources.datatypes.R5.core.diagnostic_report.DiagnosticReportSupportingInfo

Bases: BackboneElement

This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Supporting information role code	None
reference	Reference | None	Supporting information reference	None

DocumentReference

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

Bases: DomainResource

A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this “document” encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 for the document	None
version	Annotated[str | String, BeforeValidator] | None	An explicitly assigned identifer of a variation of the content in the DocumentReference	None
basedOn	List[Reference] | None	Procedure that caused this media to be created	None
status	Annotated[str | Code, BeforeValidator] | None	current | superseded | entered-in-error	None
docStatus	Annotated[str | Code, BeforeValidator] | None	registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown	None
modality	List[CodeableConcept] | None	Imaging modality used	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
context	List[Reference] | None	Context of the document content	None
event	List[CodeableReference] | None	Main clinical acts documented	None
bodySite	List[CodeableReference] | None	Body part included	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
period	Period | None	time of service that is being documented	None
date	Annotated[datetime | Instant, BeforeValidator] | None	When this document reference was created	None
author	List[Reference] | None	Who and/or what authored the document	None
attester	List[DocumentReferenceAttester] | None	Attests to accuracy of the document	None
custodian	Reference | None	Organization which maintains the document	None
relatesTo	List[DocumentReferenceRelatesTo] | None	Relationships to other documents	None
description	Annotated[str | Markdown, BeforeValidator] | None	Human-readable description	None
securityLabel	List[CodeableConcept] | None	Document security-tags	None
content	List[DocumentReferenceContent] | None	Document referenced	None

DocumentReferenceAttester

Path: fhircraft.fhir.resources.datatypes.R5.core.document_reference.DocumentReferenceAttester

Bases: BackboneElement

A participant who has authenticated the accuracy of the document.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableConcept | None	personal | professional | legal | official	None
time	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the document was attested	None
party	Reference | None	Who attested the document	None

DocumentReferenceContent

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

Bases: BackboneElement

The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
profile	List[DocumentReferenceContentProfile] | None	Content profile rules for the document	None

DocumentReferenceContentProfile

Path: fhircraft.fhir.resources.datatypes.R5.core.document_reference.DocumentReferenceContentProfile

Bases: BackboneElement

An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueCoding	Coding | None	code|uri|canonical	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	code|uri|canonical	None
valueCanonical	Annotated[str | Canonical, BeforeValidator] | None	code|uri|canonical	None

DocumentReferenceRelatesTo

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 relationship type with another document	None
target	Reference | None	Target of the relationship	None

DomainResource

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

Bases: Resource

A resource with narrative, extensions, and contained resources

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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

Encounter

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

Bases: DomainResource

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

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown	None
class_	List[CodeableConcept] | None	Classification of patient encounter context - e.g. Inpatient, outpatient	None
priority	CodeableConcept | None	Indicates the urgency of the encounter	None
type	List[CodeableConcept] | None	Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...)	None
serviceType	List[CodeableReference] | None	Specific type of service	None
subject	Reference | None	The patient or group related to this encounter	None
subjectStatus	CodeableConcept | None	The current status of the subject in relation to the Encounter	None
episodeOfCare	List[Reference] | None	Episode(s) of care that this encounter should be recorded against	None
basedOn	List[Reference] | None	The request that initiated this encounter	None
careTeam	List[Reference] | None	The group(s) that are allocated to participate in this encounter	None
partOf	Reference | None	Another Encounter this encounter is part of	None
serviceProvider	Reference | None	The organization (facility) responsible for 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
virtualService	List[VirtualServiceDetail] | None	Connection details of a virtual service (e.g. conference call)	None
actualPeriod	Period | None	The actual start and end time of the encounter	None
plannedStartDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The planned start date/time (or admission date) of the encounter	None
plannedEndDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The planned end date/time (or discharge date) of the encounter	None
length	Duration | None	Actual quantity of time the encounter lasted (less time absent)	None
reason	List[EncounterReason] | None	The list of medical reasons that are expected to be addressed during the episode of care	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
dietPreference	List[CodeableConcept] | None	Diet preferences reported by the patient	None
specialArrangement	List[CodeableConcept] | None	Wheelchair, translator, stretcher, etc	None
specialCourtesy	List[CodeableConcept] | None	Special courtesies (VIP, board member)	None
admission	EncounterAdmission | None	Details about the admission to a healthcare service	None
location	List[EncounterLocation] | None	List of locations where the patient has been	None

EncounterAdmission

Path: fhircraft.fhir.resources.datatypes.R5.core.encounter.EncounterAdmission

Bases: BackboneElement

Details about the stay during which a healthcare service is provided.

This does not describe the event of admitting the patient, but rather any information that is relevant from the time of admittance until the time of discharge.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Indicates that the patient is being re-admitted	None
destination	Reference | None	Location/organization to which the patient is discharged	None
dischargeDisposition	CodeableConcept | None	Category or kind of location after discharge	None

EncounterDiagnosis

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

Bases: BackboneElement

The list of diagnosis relevant to this encounter.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[CodeableReference] | None	The diagnosis relevant to the encounter	None
use	List[CodeableConcept] | None	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)	None

EncounterLocation

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	planned | active | reserved | completed	None
form	CodeableConcept | None	The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)	None
period	Period | None	time period during which the patient was present at the location	None

EncounterParticipant

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

Bases: BackboneElement

The list of people responsible for providing the service.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
actor	Reference | None	The individual, device, or service participating in the encounter	None

EncounterReason

Path: fhircraft.fhir.resources.datatypes.R5.core.encounter.EncounterReason

Bases: BackboneElement

The list of medical reasons that are expected to be addressed during the episode of care.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[CodeableConcept] | None	What the reason value should be used for/as	None
value	List[CodeableReference] | None	Reason the encounter takes place (core or reference)	None

EncounterHistory

Path: fhircraft.fhir.resources.datatypes.R5.core.encounter_history.EncounterHistory

Bases: DomainResource

A record of significant events/milestones key data throughout the history of an Encounter

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
encounter	Reference | None	The Encounter associated with this set of historic values	None
identifier	List[Identifier] | None	Identifier(s) by which this encounter is known	None
status	Annotated[str | Code, BeforeValidator] | None	planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown	None
class_	CodeableConcept | None	Classification of patient encounter	None
type	List[CodeableConcept] | None	Specific type of encounter	None
serviceType	List[CodeableReference] | None	Specific type of service	None
subject	Reference | None	The patient or group related to this encounter	None
subjectStatus	CodeableConcept | None	The current status of the subject in relation to the Encounter	None
actualPeriod	Period | None	The actual start and end time associated with this set of values associated with the encounter	None
plannedStartDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The planned start date/time (or admission date) of the encounter	None
plannedEndDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The planned end date/time (or discharge date) of the encounter	None
length	Duration | None	Actual quantity of time the encounter lasted (less time absent)	None
location	List[EncounterHistoryLocation] | None	Location of the patient at this point in the encounter	None

EncounterHistoryLocation

Path: fhircraft.fhir.resources.datatypes.R5.core.encounter_history.EncounterHistoryLocation

Bases: BackboneElement

The location of the patient at this point in the encounter, the multiple cardinality permits de-normalizing the levels of the location hierarchy, such as site/ward/room/bed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
form	CodeableConcept | None	The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.)	None

Endpoint

Path: fhircraft.fhir.resources.datatypes.R5.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, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | suspended | error | off | entered-in-error | test	None
connectionType	List[CodeableConcept] | None	Protocol/Profile/Standard to be used with this endpoint connection	None
name	Annotated[str | String, BeforeValidator] | None	A name that this endpoint can be identified by	None
description	Annotated[str | String, BeforeValidator] | None	Additional details about the endpoint that could be displayed as further information to identify the description beyond its name	None
environmentType	List[CodeableConcept] | None	The type of environment(s) exposed at this endpoint	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
payload	List[EndpointPayload] | None	Set of payloads that are provided by this endpoint	None
address	Annotated[str | Url, BeforeValidator] | None	The technical base address for connecting to this endpoint	None
header	List[Annotated[str | String, BeforeValidator]] | None	Usage depends on the channel type	None

EndpointPayload

Path: fhircraft.fhir.resources.datatypes.R5.core.endpoint.EndpointPayload

Bases: BackboneElement

The set of payloads that are provided/available at this endpoint.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)	None
mimeType	List[Annotated[str | Code, BeforeValidator]] | None	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)	None

EnrollmentRequest

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Creation date	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

EnrollmentResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
request	Reference | None	Claim reference	None
outcome	Annotated[str | Code, BeforeValidator] | None	queued | complete | error | partial	None
disposition	Annotated[str | String, BeforeValidator] | None	Disposition Message	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Creation date	None
organization	Reference | None	Insurer	None
requestProvider	Reference | None	Responsible practitioner	None

EpisodeOfCare

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	planned | waitlist | active | onhold | finished | cancelled | entered-in-error	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
reason	List[EpisodeOfCareReason] | None	The list of medical reasons that are expected to be addressed during the episode of care	None
diagnosis	List[EpisodeOfCareDiagnosis] | None	The list of medical conditions that were addressed during the 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 responsibility for care coordination	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
careTeam	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

EpisodeOfCareDiagnosis

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

Bases: BackboneElement

The list of medical conditions that were addressed during the episode of care.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[CodeableReference] | None	The medical condition that was addressed during the episode of care	None
use	CodeableConcept | None	Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)	None

EpisodeOfCareReason

Path: fhircraft.fhir.resources.datatypes.R5.core.episode_of_care.EpisodeOfCareReason

Bases: BackboneElement

The list of medical reasons that are expected to be addressed during the episode of care.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableConcept | None	What the reason value should be used for/as	None
value	List[CodeableReference] | None	Medical reason to be addressed	None

EpisodeOfCareStatusHistory

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	planned | waitlist | active | onhold | finished | cancelled | entered-in-error	None
period	Period | None	Duration the EpisodeOfCare was in the specified status	None

EventDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this event definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the event definition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the event definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this event definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this event definition (human friendly)	None
subtitle	Annotated[str | String, BeforeValidator] | None	Subordinate title of the event definition	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the event definition	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	Annotated[str | Markdown, BeforeValidator] | None	Why this event definition is defined	None
usage	Annotated[str | Markdown, BeforeValidator] | None	Describes the clinical usage of the event definition	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the event definition was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the event definition was last reviewed by the publisher	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

Evidence

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

Bases: DomainResource

The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (e.g., population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this evidence, represented as a globally unique URI	None
identifier	List[Identifier] | None	Additional identifier for the summary	None
version	Annotated[str | String, BeforeValidator] | None	Business version of this summary	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this summary (machine friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this summary (human friendly)	None
citeAsReference	Reference | None	Citation for this evidence	None
citeAsMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Citation for this evidence	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the summary was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the summary was last reviewed by the publisher	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	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
useContext	List[UsageContext] | None	The context that the content is intended to support	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this Evidence is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
relatedArtifact	List[RelatedArtifact] | None	Link or citation to artifact associated with the summary	None
description	Annotated[str | Markdown, BeforeValidator] | None	Description of the particular summary	None
assertion	Annotated[str | Markdown, BeforeValidator] | None	Declarative description of the Evidence	None
note	List[Annotation] | None	Footnotes and/or explanatory notes	None
variableDefinition	List[EvidenceVariableDefinition] | None	Evidence variable such as population, exposure, or outcome	None
synthesisType	CodeableConcept | None	The method to combine studies	None
studyDesign	List[CodeableConcept] | None	The design of the study that produced this evidence	None
statistic	List[EvidenceStatistic] | None	Values and parameters for a single statistic	None
certainty	List[EvidenceCertainty] | None	Certainty or quality of the evidence	None

EvidenceCertainty

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceCertainty

Bases: BackboneElement

Assessment of certainty, confidence in the estimates, or quality of the evidence.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Textual description of certainty	None
note	List[Annotation] | None	Footnotes and/or explanatory notes	None
type	CodeableConcept | None	Aspect of certainty being rated	None
rating	CodeableConcept | None	Assessment or judgement of the aspect	None
rater	Annotated[str | String, BeforeValidator] | None	Individual or group who did the rating	None
subcomponent	List[EvidenceCertainty] | None	A domain or subdomain of certainty	None

EvidenceStatistic

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceStatistic

Bases: BackboneElement

Values and parameters for a single statistic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Description of content	None
note	List[Annotation] | None	Footnotes and/or explanatory notes	None
statisticType	CodeableConcept | None	Type of statistic, e.g., relative risk	None
category	CodeableConcept | None	Associated category for categorical variable	None
quantity	Quantity | None	Statistic value	None
numberOfEvents	Annotated[int | UnsignedInt, BeforeValidator] | None	The number of events associated with the statistic	None
numberAffected	Annotated[int | UnsignedInt, BeforeValidator] | None	The number of participants affected	None
sampleSize	EvidenceStatisticSampleSize | None	Number of samples in the statistic	None
attributeEstimate	List[EvidenceStatisticAttributeEstimate] | None	An attribute of the Statistic	None
modelCharacteristic	List[EvidenceStatisticModelCharacteristic] | None	An aspect of the statistical model	None

EvidenceStatisticAttributeEstimate

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceStatisticAttributeEstimate

Bases: BackboneElement

A statistical attribute of the statistic such as a measure of heterogeneity.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Textual description of the attribute estimate	None
note	List[Annotation] | None	Footnote or explanatory note about the estimate	None
type	CodeableConcept | None	The type of attribute estimate, e.g., confidence interval or p value	None
quantity	Quantity | None	The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure	None
level	Annotated[float | Decimal, BeforeValidator] | None	Level of confidence interval, e.g., 0.95 for 95% confidence interval	None
range	Range | None	Lower and upper bound values of the attribute estimate	None
attributeEstimate	List[EvidenceStatisticAttributeEstimate] | None	A nested attribute estimate; which is the attribute estimate of an attribute estimate	None

EvidenceStatisticModelCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceStatisticModelCharacteristic

Bases: BackboneElement

A component of the method to generate the statistic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Model specification	None
value	Quantity | None	Numerical value to complete model specification	None
variable	List[EvidenceStatisticModelCharacteristicVariable] | None	A variable adjusted for in the adjusted analysis	None
attributeEstimate	List[EvidenceStatisticModelCharacteristicAttributeEstimate] | None	An attribute of the statistic used as a model characteristic	None

EvidenceStatisticModelCharacteristicAttributeEstimate

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceStatisticModelCharacteristicAttributeEstimate

Bases: BackboneElement

An attribute of the statistic used as a model characteristic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Textual description of the attribute estimate	None
note	List[Annotation] | None	Footnote or explanatory note about the estimate	None
type	CodeableConcept | None	The type of attribute estimate, e.g., confidence interval or p value	None
quantity	Quantity | None	The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure	None
level	Annotated[float | Decimal, BeforeValidator] | None	Level of confidence interval, e.g., 0.95 for 95% confidence interval	None
range	Range | None	Lower and upper bound values of the attribute estimate	None
attributeEstimate	List[EvidenceStatisticAttributeEstimate] | None	A nested attribute estimate; which is the attribute estimate of an attribute estimate	None

EvidenceStatisticModelCharacteristicVariable

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceStatisticModelCharacteristicVariable

Bases: BackboneElement

A variable adjusted for in the adjusted analysis.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
variableDefinition	Reference | None	Description of the variable	None
handling	Annotated[str | Code, BeforeValidator] | None	continuous | dichotomous | ordinal | polychotomous	None
valueCategory	List[CodeableConcept] | None	Description for grouping of ordinal or polychotomous variables	None
valueQuantity	List[Quantity] | None	Discrete value for grouping of ordinal or polychotomous variables	None
valueRange	List[Range] | None	Range of values for grouping of ordinal or polychotomous variables	None

EvidenceStatisticSampleSize

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceStatisticSampleSize

Bases: BackboneElement

Number of samples in the statistic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Textual description of sample size for statistic	None
note	List[Annotation] | None	Footnote or explanatory note about the sample size	None
numberOfStudies	Annotated[int | UnsignedInt, BeforeValidator] | None	Number of contributing studies	None
numberOfParticipants	Annotated[int | UnsignedInt, BeforeValidator] | None	Cumulative number of participants	None
knownDataCount	Annotated[int | UnsignedInt, BeforeValidator] | None	Number of participants with known results for measured variables	None

EvidenceVariableDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence.EvidenceVariableDefinition

Bases: BackboneElement

Evidence variable such as population, exposure, or outcome.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	A text description or summary of the variable	None
note	List[Annotation] | None	Footnotes and/or explanatory notes	None
variableRole	CodeableConcept | None	population | subpopulation | exposure | referenceExposure | measuredVariable | confounder	None
observed	Reference | None	Definition of the actual variable related to the statistic(s)	None
intended	Reference | None	Definition of the intended variable related to the Evidence	None
directnessMatch	CodeableConcept | None	low | moderate | high | exact	None

EvidenceReport

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_report.EvidenceReport

Bases: DomainResource

The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this EvidenceReport, represented as a globally unique URI	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
identifier	List[Identifier] | None	Unique identifier for the evidence report	None
relatedIdentifier	List[Identifier] | None	Identifiers for articles that may relate to more than one evidence report	None
citeAsReference	Reference | None	Citation for this report	None
citeAsMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Citation for this report	None
type	CodeableConcept | None	Kind of report	None
note	List[Annotation] | None	Used for footnotes and annotations	None
relatedArtifact	List[RelatedArtifact] | None	Link, description or reference to artifact associated with the report	None
subject	EvidenceReportSubject | None	Focus of the report	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	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
relatesTo	List[EvidenceReportRelatesTo] | None	Relationships to other compositions/documents	None
section	List[EvidenceReportSection] | None	Composition is broken into sections	None

EvidenceReportRelatesTo

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_report.EvidenceReportRelatesTo

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	replaces | amends | appends | transforms | replacedWith | amendedWith | appendedWith | transformedWith	None
target	EvidenceReportRelatesToTarget | None	Target of the relationship	None

EvidenceReportRelatesToTarget

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_report.EvidenceReportRelatesToTarget

Bases: BackboneElement

The target composition/document of this relationship.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	Target of the relationship URL	None
identifier	Identifier | None	Target of the relationship Identifier	None
display	Annotated[str | Markdown, BeforeValidator] | None	Target of the relationship Display	None
resource	Reference | None	Target of the relationship Resource reference	None

EvidenceReportSection

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_report.EvidenceReportSection

Bases: BackboneElement

The root of the sections that make up the composition.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Label for section (e.g. for ToC)	None
focus	CodeableConcept | None	Classification of section (recommended)	None
focusReference	Reference | None	Classification of section by Resource	None
author	List[Reference] | None	Who and/or what authored the section	None
text	Narrative | None	Text summary of the section, for human interpretation	None
mode	Annotated[str | Code, BeforeValidator] | None	working | snapshot | changes	None
orderedBy	CodeableConcept | None	Order of section entries	None
entryClassifier	List[CodeableConcept] | None	Extensible classifiers as content	None
entryReference	List[Reference] | None	Reference to resources as content	None
entryQuantity	List[Quantity] | None	Quantity as content	None
emptyReason	CodeableConcept | None	Why the section is empty	None
section	List[EvidenceReportSection] | None	Nested Section	None

EvidenceReportSubject

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_report.EvidenceReportSubject

Bases: BackboneElement

Specifies the subject or focus of the report. Answers "What is this report about?".

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
characteristic	List[EvidenceReportSubjectCharacteristic] | None	Characteristic	None
note	List[Annotation] | None	Footnotes and/or explanatory notes	None

EvidenceReportSubjectCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_report.EvidenceReportSubjectCharacteristic

Bases: BackboneElement

Characteristic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Characteristic code	None
valueReference	Reference | None	Characteristic value	None
valueCodeableConcept	CodeableConcept | None	Characteristic value	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Characteristic value	None
valueQuantity	Quantity | None	Characteristic value	None
valueRange	Range | None	Characteristic value	None
exclude	Annotated[bool | Boolean, BeforeValidator] | None	Is used to express not the characteristic	None
period	Period | None	Timeframe for the characteristic	None

EvidenceVariable

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

Bases: DomainResource

The EvidenceVariable resource describes an element that knowledge (Evidence) is about.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this evidence variable, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the evidence variable	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the evidence variable	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this evidence variable (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this evidence variable (human friendly)	None
shortTitle	Annotated[str | String, BeforeValidator] | None	Title for use in informal contexts	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the evidence variable	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
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this EvidenceVariable is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the resource was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the resource was last reviewed by the publisher	None
effectivePeriod	Period | None	When the resource is expected to be used	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
actual	Annotated[bool | Boolean, BeforeValidator] | None	Actual or conceptual	None
characteristic	List[EvidenceVariableCharacteristic] | None	A defining factor of the EvidenceVariable	None
handling	Annotated[str | Code, BeforeValidator] | None	continuous | dichotomous | ordinal | polychotomous	None
category	List[EvidenceVariableCategory] | None	A grouping for ordinal or polychotomous variables	None

EvidenceVariableCategory

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_variable.EvidenceVariableCategory

Bases: BackboneElement

A grouping for ordinal or polychotomous variables.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Description of the grouping	None
valueCodeableConcept	CodeableConcept | None	Definition of the grouping	None
valueQuantity	Quantity | None	Definition of the grouping	None
valueRange	Range | None	Definition of the grouping	None

EvidenceVariableCharacteristic

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

Bases: BackboneElement

A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semantics.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Label for internal linking	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the characteristic	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
exclude	Annotated[bool | Boolean, BeforeValidator] | None	Whether the characteristic is an inclusion criterion or exclusion criterion	None
definitionReference	Reference | None	Defines the characteristic (without using type and value) by a Reference	None
definitionCanonical	Annotated[str | Canonical, BeforeValidator] | None	Defines the characteristic (without using type and value) by a canonical	None
definitionCodeableConcept	CodeableConcept | None	Defines the characteristic (without using type and value) by a CodeableConcept	None
definitionExpression	Expression | None	Defines the characteristic (without using type and value) by an expression	None
definitionId	Annotated[str | Id, BeforeValidator] | None	Defines the characteristic (without using type and value) by an id	None
definitionByTypeAndValue	EvidenceVariableCharacteristicDefinitionByTypeAndValue | None	Defines the characteristic using type and value	None
definitionByCombination	EvidenceVariableCharacteristicDefinitionByCombination | None	Used to specify how two or more characteristics are combined	None
instancesQuantity	Quantity | None	Number of occurrences meeting the characteristic	None
instancesRange	Range | None	Number of occurrences meeting the characteristic	None
durationQuantity	Quantity | None	Length of time in which the characteristic is met	None
durationRange	Range | None	Length of time in which the characteristic is met	None
timeFromEvent	List[EvidenceVariableCharacteristicTimeFromEvent] | None	Timing in which the characteristic is determined	None

EvidenceVariableCharacteristicDefinitionByCombination

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_variable.EvidenceVariableCharacteristicDefinitionByCombination

Bases: BackboneElement

Defines the characteristic as a combination of two or more characteristics.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	all-of | any-of | at-least | at-most | statistical | net-effect | dataset	None
threshold	Annotated[int | PositiveInt, BeforeValidator] | None	Provides the value of "n" when "at-least" or "at-most" codes are used	None
characteristic	List[EvidenceVariableCharacteristic] | None	A defining factor of the characteristic	None

EvidenceVariableCharacteristicDefinitionByTypeAndValue

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_variable.EvidenceVariableCharacteristicDefinitionByTypeAndValue

Bases: BackboneElement

Defines the characteristic using both a type and value[x] elements.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Expresses the type of characteristic	None
method	List[CodeableConcept] | None	Method for how the characteristic value was determined	None
device	Reference | None	Device used for determining characteristic	None
valueCodeableConcept	CodeableConcept | None	Defines the characteristic when coupled with characteristic.type	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Defines the characteristic when coupled with characteristic.type	None
valueQuantity	Quantity | None	Defines the characteristic when coupled with characteristic.type	None
valueRange	Range | None	Defines the characteristic when coupled with characteristic.type	None
valueReference	Reference | None	Defines the characteristic when coupled with characteristic.type	None
valueId	Annotated[str | Id, BeforeValidator] | None	Defines the characteristic when coupled with characteristic.type	None
offset	CodeableConcept | None	Reference point for valueQuantity or valueRange	None

EvidenceVariableCharacteristicTimeFromEvent

Path: fhircraft.fhir.resources.datatypes.R5.core.evidence_variable.EvidenceVariableCharacteristicTimeFromEvent

Bases: BackboneElement

Timing in which the characteristic is determined.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Human readable description	None
note	List[Annotation] | None	Used for footnotes or explanatory notes	None
eventCodeableConcept	CodeableConcept | None	The event used as a base point (reference point) in time	None
eventReference	Reference | None	The event used as a base point (reference point) in time	None
eventDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The event used as a base point (reference point) in time	None
eventId	Annotated[str | Id, BeforeValidator] | None	The event used as a base point (reference point) in time	None
quantity	Quantity | None	Used to express the observation at a defined amount of time before or after the event	None
range	Range | None	Used to express the observation within a period before and/or after the event	None

ExampleScenario

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

Bases: DomainResource

A walkthrough of a workflow showing the interaction between systems and the instances shared, possibly including the evolution of instances over time.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this example scenario, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the example scenario	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the example scenario	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	To be removed?	None
title	Annotated[str | String, BeforeValidator] | None	Name for this example scenario (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the ExampleScenario	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
purpose	Annotated[str | Markdown, BeforeValidator] | None	The purpose of the example, e.g. to illustrate a scenario	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
actor	List[ExampleScenarioActor] | None	Individual involved in exchange	None
instance	List[ExampleScenarioInstance] | None	Data used in the scenario	None
process	List[ExampleScenarioProcess] | None	Major process within scenario	None

ExampleScenarioActor

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

Bases: BackboneElement

A system or person who shares or receives an instance within the scenario.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
key	Annotated[str | String, BeforeValidator] | None	ID or acronym of the actor	None
type	Annotated[str | Code, BeforeValidator] | None	person | system	None
title	Annotated[str | String, BeforeValidator] | None	Label for actor when rendering	None
description	Annotated[str | Markdown, BeforeValidator] | None	Details about actor	None

ExampleScenarioInstance

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

Bases: BackboneElement

A single data collection that is shared as part of the scenario.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
key	Annotated[str | String, BeforeValidator] | None	ID or acronym of the instance	None
structureType	Coding | None	Data structure for example	None
structureVersion	Annotated[str | String, BeforeValidator] | None	E.g. 4.0.1	None
structureProfileCanonical	Annotated[str | Canonical, BeforeValidator] | None	Rules instance adheres to	None
structureProfileUri	Annotated[str | Uri, BeforeValidator] | None	Rules instance adheres to	None
title	Annotated[str | String, BeforeValidator] | None	Label for instance	None
description	Annotated[str | Markdown, BeforeValidator] | None	Human-friendly description of the instance	None
content	Reference | None	Example instance data	None
version	List[ExampleScenarioInstanceVersion] | None	Snapshot of instance that changes	None
containedInstance	List[ExampleScenarioInstanceContainedInstance] | None	Resources contained in the instance	None

ExampleScenarioInstanceContainedInstance

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

Bases: BackboneElement

References to other instances that can be found within this instance (e.g. the observations contained in a bundle).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
instanceReference	Annotated[str | String, BeforeValidator] | None	Key of contained instance	None
versionReference	Annotated[str | String, BeforeValidator] | None	Key of contained instance version	None

ExampleScenarioInstanceVersion

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

Bases: BackboneElement

Represents the instance as it was at a specific time-point.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
key	Annotated[str | String, BeforeValidator] | None	ID or acronym of the version	None
title	Annotated[str | String, BeforeValidator] | None	Label for instance version	None
description	Annotated[str | Markdown, BeforeValidator] | None	Details about version	None
content	Reference | None	Example instance version data	None

ExampleScenarioProcess

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

Bases: BackboneElement

A group of operations that represents a significant step within a scenario.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Label for procss	None
description	Annotated[str | Markdown, BeforeValidator] | None	Human-friendly description of the process	None
preConditions	Annotated[str | Markdown, BeforeValidator] | None	Status before process starts	None
postConditions	Annotated[str | Markdown, BeforeValidator] | None	Status after successful completion	None
step	List[ExampleScenarioProcessStep] | None	Event within of the process	None

ExampleScenarioProcessStep

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

Bases: BackboneElement

A significant action that occurs as part of the process.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Sequential number of the step	None
process	ExampleScenarioProcess | None	Step is nested process	None
workflow	Annotated[str | Canonical, BeforeValidator] | None	Step is nested workflow	None
operation	ExampleScenarioProcessStepOperation | None	Step is simple action	None
alternative	List[ExampleScenarioProcessStepAlternative] | None	Alternate non-typical step action	None
pause	Annotated[bool | Boolean, BeforeValidator] | None	Pause in the flow?	None

ExampleScenarioProcessStepAlternative

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

Bases: BackboneElement

Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Label for alternative	None
description	Annotated[str | Markdown, BeforeValidator] | None	Human-readable description of option	None
step	List[ExampleScenarioProcessStep] | None	Alternative action(s)	None

ExampleScenarioProcessStepOperation

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

Bases: BackboneElement

The step represents a single operation invoked on receiver by sender.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Kind of action	None
title	Annotated[str | String, BeforeValidator] | None	Label for step	None
initiator	Annotated[str | String, BeforeValidator] | None	Who starts the operation	None
receiver	Annotated[str | String, BeforeValidator] | None	Who receives the operation	None
description	Annotated[str | Markdown, BeforeValidator] | None	Human-friendly description of the operation	None
initiatorActive	Annotated[bool | Boolean, BeforeValidator] | None	Initiator stays active?	None
receiverActive	Annotated[bool | Boolean, BeforeValidator] | None	Receiver stays active?	None
request	ExampleScenarioProcessStepOperationRequest | None	Instance transmitted on invocation	None
response	ExampleScenarioInstanceContainedInstance | None	Instance transmitted on invocation response	None

ExampleScenarioProcessStepOperationRequest

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

Bases: BackboneElement

A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
instanceReference	Annotated[str | String, BeforeValidator] | None	Key of contained instance	None
versionReference	Annotated[str | String, BeforeValidator] | None	Key of contained instance version	None

ExplanationOfBenefit

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
traceNumber	List[Identifier] | None	Number for tracking	None
status	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
type	CodeableConcept | None	Category or discipline	None
subType	CodeableConcept | None	More granular claim type	None
use	Annotated[str | Code, BeforeValidator] | None	claim | preauthorization | predetermination	None
patient	Reference | None	The recipient of the products and services	None
billablePeriod	Period | None	Relevant time frame for the claim	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Response creation date	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
event	List[ExplanationOfBenefitEvent] | None	Event information	None
payee	ExplanationOfBenefitPayee | None	Recipient of benefits payable	None
referral	Reference | None	Treatment Referral	None
encounter	List[Reference] | None	Encounters associated with the listed treatments	None
facility	Reference | None	Servicing Facility	None
claim	Reference | None	Claim reference	None
claimResponse	Reference | None	Claim response reference	None
outcome	Annotated[str | Code, BeforeValidator] | None	queued | complete | error | partial	None
decision	CodeableConcept | None	Result of the adjudication	None
disposition	Annotated[str | String, BeforeValidator] | None	Disposition Message	None
preAuthRef	List[Annotated[str | String, BeforeValidator]] | None	Preauthorization reference	None
preAuthRefPeriod	List[Period] | None	Preauthorization in-effect period	None
diagnosisRelatedGroup	CodeableConcept | None	Package billing code	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	Annotated[int | PositiveInt, BeforeValidator] | None	Precedence (primary, secondary, etc.)	None
insurance	List[ExplanationOfBenefitInsurance] | None	Patient insurance information	None
accident	ExplanationOfBenefitAccident | None	Details of the event	None
patientPaid	Money | None	Paid by the patient	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

ExplanationOfBenefitAccident

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[date | str | Date, BeforeValidator] | None	When the incident occurred	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.R5.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	str | None	Unique id for inter-element referencing	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[Annotated[int | PositiveInt, BeforeValidator]] | None	Item sequence number	None
detailSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Detail sequence number	None
subDetailSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Subdetail sequence number	None
traceNumber	List[Identifier] | None	Number for tracking	None
provider	List[Reference] | None	Authorized providers	None
revenue	CodeableConcept | None	Revenue or cost center code	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
request	List[Reference] | None	Request or Referral for Service	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
servicedDate	Annotated[date | str | Date, BeforeValidator] | None	Date or dates of service or product delivery	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
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
bodySite	List[ExplanationOfBenefitAddItemBodySite] | None	Anatomical location	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ExplanationOfBenefitItemReviewOutcome | None	Additem level adjudication results	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Added items adjudication	None
detail	List[ExplanationOfBenefitAddItemDetail] | None	Insurer added line items	None

ExplanationOfBenefitAddItemBodySite

Path: fhircraft.fhir.resources.datatypes.R5.core.explanation_of_benefit.ExplanationOfBenefitAddItemBodySite

Bases: BackboneElement

Physical location where the service is performed or applies.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[CodeableReference] | None	Location	None
subSite	List[CodeableConcept] | None	Sub-location	None

ExplanationOfBenefitAddItemDetail

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

Bases: BackboneElement

The second-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
traceNumber	List[Identifier] | None	Number for tracking	None
revenue	CodeableConcept | None	Revenue or cost center code	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ExplanationOfBenefitItemReviewOutcome | None	Additem detail level adjudication results	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Added items adjudication	None
subDetail	List[ExplanationOfBenefitAddItemDetailSubDetail] | None	Insurer added line items	None

ExplanationOfBenefitAddItemDetailSubDetail

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

Bases: BackboneElement

The third-tier service adjudications for payor added services.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
traceNumber	List[Identifier] | None	Number for tracking	None
revenue	CodeableConcept | None	Revenue or cost center code	None
productOrService	CodeableConcept | None	Billing, service, product, or drug code	None
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ExplanationOfBenefitItemReviewOutcome | None	Additem subdetail level adjudication results	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Added items adjudication	None

ExplanationOfBenefitBenefitBalance

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

Bases: BackboneElement

Balance by Benefit Category.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Excluded from the plan	None
name	Annotated[str | String, BeforeValidator] | None	Short name for the benefit	None
description	Annotated[str | String, BeforeValidator] | None	Description of the benefit or services covered	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.R5.core.explanation_of_benefit.ExplanationOfBenefitBenefitBalanceFinancial

Bases: BackboneElement

Benefits Used to date.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | UnsignedInt, BeforeValidator] | None	Benefits allowed	None
allowedString	Annotated[str | String, BeforeValidator] | None	Benefits allowed	None
allowedMoney	Money | None	Benefits allowed	None
usedUnsignedInt	Annotated[int | UnsignedInt, BeforeValidator] | None	Benefits used	None
usedMoney	Money | None	Benefits used	None

ExplanationOfBenefitCareTeam

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Order of care team	None
provider	Reference | None	Practitioner or organization	None
responsible	Annotated[bool | Boolean, BeforeValidator] | None	Indicator of the lead practitioner	None
role	CodeableConcept | None	Function within the team	None
specialty	CodeableConcept | None	Practitioner or provider specialization	None

ExplanationOfBenefitDiagnosis

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

Bases: BackboneElement

Information about diagnoses relevant to the claim items.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Diagnosis instance identifier	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

ExplanationOfBenefitEvent

Path: fhircraft.fhir.resources.datatypes.R5.core.explanation_of_benefit.ExplanationOfBenefitEvent

Bases: BackboneElement

Information code for an event with a corresponding date or period.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Specific event	None
whenDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Occurance date or period	None
whenPeriod	Period | None	Occurance date or period	None

ExplanationOfBenefitInsurance

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Coverage to be used for adjudication	None
coverage	Reference | None	Insurance information	None
preAuthRef	List[Annotated[str | String, BeforeValidator]] | None	Prior authorization reference number	None

ExplanationOfBenefitItem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Item instance identifier	None
careTeamSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable care team members	None
diagnosisSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable diagnoses	None
procedureSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable procedures	None
informationSequence	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable exception and supporting information	None
traceNumber	List[Identifier] | None	Number for tracking	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
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
request	List[Reference] | None	Request or Referral for Service	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	Annotated[date | str | Date, BeforeValidator] | None	Date or dates of service or product delivery	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
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
bodySite	List[ExplanationOfBenefitItemBodySite] | None	Anatomical location	None
encounter	List[Reference] | None	Encounters associated with the listed treatments	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ExplanationOfBenefitItemReviewOutcome | None	Adjudication results	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Adjudication details	None
detail	List[ExplanationOfBenefitItemDetail] | None	Additional items	None

ExplanationOfBenefitItemAdjudication

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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
quantity	Quantity | None	Non-monitary value	None

ExplanationOfBenefitItemBodySite

Path: fhircraft.fhir.resources.datatypes.R5.core.explanation_of_benefit.ExplanationOfBenefitItemBodySite

Bases: BackboneElement

Physical location where the service is performed or applies.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[CodeableReference] | None	Location	None
subSite	List[CodeableConcept] | None	Sub-location	None

ExplanationOfBenefitItemDetail

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

Bases: BackboneElement

Second-tier of goods and services.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Product or service provided	None
traceNumber	List[Identifier] | None	Number for tracking	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
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ExplanationOfBenefitItemDetailReviewOutcome | None	Detail level adjudication results	None
adjudication	List[ExplanationOfBenefitItemDetailAdjudication] | None	Detail level adjudication details	None
subDetail	List[ExplanationOfBenefitItemDetailSubDetail] | None	Additional items	None

ExplanationOfBenefitItemDetailAdjudication

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

Bases: BackboneElement

The adjudication results.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
quantity	Quantity | None	Non-monitary value	None

ExplanationOfBenefitItemDetailReviewOutcome

Path: fhircraft.fhir.resources.datatypes.R5.core.explanation_of_benefit.ExplanationOfBenefitItemDetailReviewOutcome

Bases: BackboneElement

The high-level results of the adjudication if adjudication has been performed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
decision	CodeableConcept | None	Result of the adjudication	None
reason	List[CodeableConcept] | None	Reason for result of the adjudication	None
preAuthRef	Annotated[str | String, BeforeValidator] | None	Preauthorization reference	None
preAuthPeriod	Period | None	Preauthorization reference effective period	None

ExplanationOfBenefitItemDetailSubDetail

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

Bases: BackboneElement

Third-tier of goods and services.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Product or service provided	None
traceNumber	List[Identifier] | None	Number for tracking	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
productOrServiceEnd	CodeableConcept | None	End of a range of codes	None
modifier	List[CodeableConcept] | None	Service/Product billing modifiers	None
programCode	List[CodeableConcept] | None	Program the product or service is provided under	None
patientPaid	Money | None	Paid by the patient	None
quantity	Quantity | None	Count of products or services	None
unitPrice	Money | None	Fee, charge or cost per item	None
factor	Annotated[float | Decimal, BeforeValidator] | None	Price scaling factor	None
tax	Money | None	Total tax	None
net	Money | None	Total item cost	None
udi	List[Reference] | None	Unique device identifier	None
noteNumber	List[Annotated[int | PositiveInt, BeforeValidator]] | None	Applicable note numbers	None
reviewOutcome	ExplanationOfBenefitItemReviewOutcome | None	Subdetail level adjudication results	None
adjudication	List[ExplanationOfBenefitItemAdjudication] | None	Subdetail level adjudication details	None

ExplanationOfBenefitItemReviewOutcome

Path: fhircraft.fhir.resources.datatypes.R5.core.explanation_of_benefit.ExplanationOfBenefitItemReviewOutcome

Bases: BackboneElement

The high-level results of the adjudication if adjudication has been performed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
decision	CodeableConcept | None	Result of the adjudication	None
reason	List[CodeableConcept] | None	Reason for result of the adjudication	None
preAuthRef	Annotated[str | String, BeforeValidator] | None	Preauthorization reference	None
preAuthPeriod	Period | None	Preauthorization reference effective period	None

ExplanationOfBenefitPayee

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.explanation_of_benefit.ExplanationOfBenefitPayment

Bases: BackboneElement

Payment details for the adjudication of the claim.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[date | str | Date, BeforeValidator] | None	Expected date of payment	None
amount	Money | None	Payable amount after adjustment	None
identifier	Identifier | None	Business identifier for the payment	None

ExplanationOfBenefitProcedure

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Procedure instance identifier	None
type	List[CodeableConcept] | None	Category of Procedure	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the procedure was performed	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Note instance identifier	None
type	CodeableConcept | None	Note purpose	None
text	Annotated[str | String, BeforeValidator] | None	Note explanatory text	None
language	CodeableConcept | None	Language of the text	None

ExplanationOfBenefitRelated

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Information instance identifier	None
category	CodeableConcept | None	Classification of the supplied information	None
code	CodeableConcept | None	Type of information	None
timingDate	Annotated[date | str | Date, BeforeValidator] | None	When it occurred	None
timingPeriod	Period | None	When it occurred	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Data to be provided	None
valueString	Annotated[str | String, BeforeValidator] | None	Data to be provided	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
valueIdentifier	Identifier | None	Data to be provided	None
reason	Coding | None	Explanation for the information	None

ExplanationOfBenefitTotal

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

Bases: BackboneElement

Categorized monetary totals for the adjudication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	None
status	Annotated[str | Code, BeforeValidator] | None	partial | completed | entered-in-error | health-unknown	None
dataAbsentReason	CodeableConcept | None	subject-unknown | withheld | unable-to-obtain | deferred	None
patient	Reference | None	Patient history is about	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When history was recorded or last updated	None
participant	List[FamilyMemberHistoryParticipant] | None	Who or what participated in the activities related to the family member history and how they were involved	None
name	Annotated[str | String, BeforeValidator] | None	The family member described	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	Annotated[date | str | Date, BeforeValidator] | None	(approximate) date of birth	None
bornString	Annotated[str | String, BeforeValidator] | None	(approximate) date of birth	None
ageAge	Age | None	(approximate) age	None
ageRange	Range | None	(approximate) age	None
ageString	Annotated[str | String, BeforeValidator] | None	(approximate) age	None
estimatedAge	Annotated[bool | Boolean, BeforeValidator] | None	Age is estimated?	None
deceasedBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Dead? How old/when?	None
deceasedAge	Age | None	Dead? How old/when?	None
deceasedRange	Range | None	Dead? How old/when?	None
deceasedDate	Annotated[date | str | Date, BeforeValidator] | None	Dead? How old/when?	None
deceasedString	Annotated[str | String, BeforeValidator] | None	Dead? How old/when?	None
reason	List[CodeableReference] | 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
procedure	List[FamilyMemberHistoryProcedure] | None	Procedures that the related person had	None

FamilyMemberHistoryCondition

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether the condition contributed to the cause of death	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	Annotated[str | String, BeforeValidator] | None	When condition first manifested	None
note	List[Annotation] | None	Extra information about condition	None

FamilyMemberHistoryParticipant

Path: fhircraft.fhir.resources.datatypes.R5.core.family_member_history.FamilyMemberHistoryParticipant

Bases: BackboneElement

Indicates who or what participated in the activities related to the family member history and how they were involved.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 involvement	None
actor	Reference | None	Who or what participated in the activities related to the family member history	None

FamilyMemberHistoryProcedure

Path: fhircraft.fhir.resources.datatypes.R5.core.family_member_history.FamilyMemberHistoryProcedure

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Procedures performed on the related person	None
outcome	CodeableConcept | None	What happened following the procedure	None
contributedToDeath	Annotated[bool | Boolean, BeforeValidator] | None	Whether the procedure contributed to the cause of death	None
performedAge	Age | None	When the procedure was performed	None
performedRange	Range | None	When the procedure was performed	None
performedPeriod	Period | None	When the procedure was performed	None
performedString	Annotated[str | String, BeforeValidator] | None	When the procedure was performed	None
performedDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the procedure was performed	None
note	List[Annotation] | None	Extra information about the procedure	None

Flag

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

Bases: DomainResource

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

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | inactive | entered-in-error	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

FormularyItem

Path: fhircraft.fhir.resources.datatypes.R5.core.formulary_item.FormularyItem

Bases: DomainResource

This resource describes a product or service that is available through a program and includes the conditions and constraints of availability. All of the information in this resource is specific to the inclusion of the item in the formulary and is not inherent to the item itself.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 formulary item	None
code	CodeableConcept | None	Codes that identify this formulary item	None
status	Annotated[str | Code, BeforeValidator] | None	active | entered-in-error | inactive	None

GenomicStudy

Path: fhircraft.fhir.resources.datatypes.R5.core.genomic_study.GenomicStudy

Bases: DomainResource

A set of analyses performed to analyze and generate genomic data.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 this genomic study	None
status	Annotated[str | Code, BeforeValidator] | None	registered | available | cancelled | entered-in-error | unknown	None
type	List[CodeableConcept] | None	The type of the study (e.g., Familial variant segregation, Functional variation detection, or Gene expression profiling)	None
subject	Reference | None	The primary subject of the genomic study	None
encounter	Reference | None	The healthcare event with which this genomics study is associated	None
startDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the genomic study was started	None
basedOn	List[Reference] | None	Event resources that the genomic study is based on	None
referrer	Reference | None	Healthcare professional who requested or referred the genomic study	None
interpreter	List[Reference] | None	Healthcare professionals who interpreted the genomic study	None
reason	List[CodeableReference] | None	Why the genomic study was performed	None
instantiatesCanonical	Annotated[str | Canonical, BeforeValidator] | None	The defined protocol that describes the study	None
instantiatesUri	Annotated[str | Uri, BeforeValidator] | None	The URL pointing to an externally maintained protocol that describes the study	None
note	List[Annotation] | None	Comments related to the genomic study	None
description	Annotated[str | Markdown, BeforeValidator] | None	Description of the genomic study	None
analysis	List[GenomicStudyAnalysis] | None	Genomic Analysis Event	None

GenomicStudyAnalysis

Path: fhircraft.fhir.resources.datatypes.R5.core.genomic_study.GenomicStudyAnalysis

Bases: BackboneElement

The details about a specific analysis that was performed in this GenomicStudy.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Identifiers for the analysis event	None
methodType	List[CodeableConcept] | None	Type of the methods used in the analysis (e.g., FISH, Karyotyping, MSI)	None
changeType	List[CodeableConcept] | None	Type of the genomic changes studied in the analysis (e.g., DNA, RNA, or AA change)	None
genomeBuild	CodeableConcept | None	Genome build that is used in this analysis	None
instantiatesCanonical	Annotated[str | Canonical, BeforeValidator] | None	The defined protocol that describes the analysis	None
instantiatesUri	Annotated[str | Uri, BeforeValidator] | None	The URL pointing to an externally maintained protocol that describes the analysis	None
title	Annotated[str | String, BeforeValidator] | None	Name of the analysis event (human friendly)	None
focus	List[Reference] | None	What the genomic analysis is about, when it is not about the subject of record	None
specimen	List[Reference] | None	The specimen used in the analysis event	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date of the analysis event	None
note	List[Annotation] | None	Any notes capture with the analysis event	None
protocolPerformed	Reference | None	The protocol that was performed for the analysis event	None
regionsStudied	List[Reference] | None	The genomic regions to be studied in the analysis (BED file)	None
regionsCalled	List[Reference] | None	Genomic regions actually called in the analysis event (BED file)	None
input	List[GenomicStudyAnalysisInput] | None	Inputs for the analysis event	None
output	List[GenomicStudyAnalysisOutput] | None	Outputs for the analysis event	None
performer	List[GenomicStudyAnalysisPerformer] | None	Performer for the analysis event	None
device	List[GenomicStudyAnalysisDevice] | None	Devices used for the analysis (e.g., instruments, software), with settings and parameters	None

GenomicStudyAnalysisDevice

Path: fhircraft.fhir.resources.datatypes.R5.core.genomic_study.GenomicStudyAnalysisDevice

Bases: BackboneElement

Devices used for the analysis (e.g., instruments, software), with settings and parameters.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
device	Reference | None	Device used for the analysis	None
function	CodeableConcept | None	Specific function for the device used for the analysis	None

GenomicStudyAnalysisInput

Path: fhircraft.fhir.resources.datatypes.R5.core.genomic_study.GenomicStudyAnalysisInput

Bases: BackboneElement

Inputs for the analysis event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
file	Reference | None	File containing input data	None
type	CodeableConcept | None	Type of input data (e.g., BAM, CRAM, or FASTA)	None
generatedByIdentifier	Identifier | None	The analysis event or other GenomicStudy that generated this input file	None
generatedByReference	Reference | None	The analysis event or other GenomicStudy that generated this input file	None

GenomicStudyAnalysisOutput

Path: fhircraft.fhir.resources.datatypes.R5.core.genomic_study.GenomicStudyAnalysisOutput

Bases: BackboneElement

Outputs for the analysis event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
file	Reference | None	File containing output data	None
type	CodeableConcept | None	Type of output data (e.g., VCF, MAF, or BAM)	None

GenomicStudyAnalysisPerformer

Path: fhircraft.fhir.resources.datatypes.R5.core.genomic_study.GenomicStudyAnalysisPerformer

Bases: BackboneElement

Performer for the analysis event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
actor	Reference | None	The organization, healthcare professional, or others who participated in performing this analysis	None
role	CodeableConcept | None	Role of the actor for this analysis	None

Goal

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected	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
continuous	Annotated[bool | Boolean, BeforeValidator] | None	After meeting the goal, ongoing activity is needed to sustain the goal objective	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	Annotated[date | str | Date, BeforeValidator] | None	When goal pursuit begins	None
startCodeableConcept	CodeableConcept | None	When goal pursuit begins	None
target	List[GoalTarget] | None	Target outcome for the goal	None
statusDate	Annotated[date | str | Date, BeforeValidator] | None	When goal status took effect	None
statusReason	Annotated[str | String, BeforeValidator] | None	Reason for current status	None
source	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
outcome	List[CodeableReference] | None	What result was achieved regarding the goal?	None

GoalTarget

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

Bases: BackboneElement

Indicates what should be done by when.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The target value to be achieved	None
detailBoolean	Annotated[bool | Boolean, BeforeValidator] | None	The target value to be achieved	None
detailInteger	Annotated[int | Integer, BeforeValidator] | None	The target value to be achieved	None
detailRatio	Ratio | None	The target value to be achieved	None
dueDate	Annotated[date | str | Date, BeforeValidator] | None	Reach goal on or before	None
dueDuration	Duration | None	Reach goal on or before	None

GraphDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this graph definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the GraphDefinition (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the graph definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this graph definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this graph definition (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the graph definition	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	Annotated[str | Markdown, BeforeValidator] | None	Why this graph definition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
start	Annotated[str | Id, BeforeValidator] | None	Starting Node	None
node	List[GraphDefinitionNode] | None	Potential target for the link	None
link	List[GraphDefinitionLink] | None	Links this graph makes rules about	None

GraphDefinitionLink

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

Bases: BackboneElement

Links this graph makes rules about.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Why this link is specified	None
min	Annotated[int | Integer, BeforeValidator] | None	Minimum occurrences for this link	None
max	Annotated[str | String, BeforeValidator] | None	Maximum occurrences for this link	None
sourceId	Annotated[str | Id, BeforeValidator] | None	Source Node for this link	None
path	Annotated[str | String, BeforeValidator] | None	Path in the resource that contains the link	None
sliceName	Annotated[str | String, BeforeValidator] | None	Which slice (if profiled)	None
targetId	Annotated[str | Id, BeforeValidator] | None	Target Node for this link	None
params	Annotated[str | String, BeforeValidator] | None	Criteria for reverse lookup	None
compartment	List[GraphDefinitionLinkCompartment] | None	Compartment Consistency Rules	None

GraphDefinitionLinkCompartment

Path: fhircraft.fhir.resources.datatypes.R5.core.graph_definition.GraphDefinitionLinkCompartment

Bases: BackboneElement

Compartment Consistency Rules.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	where | requires	None
rule	Annotated[str | Code, BeforeValidator] | None	identical | matching | different | custom	None
code	Annotated[str | Code, BeforeValidator] | None	Patient | Encounter | RelatedPerson | Practitioner | Device | EpisodeOfCare	None
expression	Annotated[str | String, BeforeValidator] | None	Custom rule, as a FHIRPath expression	None
description	Annotated[str | String, BeforeValidator] | None	Documentation for FHIRPath expression	None

GraphDefinitionNode

Path: fhircraft.fhir.resources.datatypes.R5.core.graph_definition.GraphDefinitionNode

Bases: BackboneElement

Potential target for the link.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
nodeId	Annotated[str | Id, BeforeValidator] | None	Internal ID - target for link references	None
description	Annotated[str | String, BeforeValidator] | None	Why this node is specified	None
type	Annotated[str | Code, BeforeValidator] | None	Type of resource this link refers to	None
profile	Annotated[str | Canonical, BeforeValidator] | None	Profile for the target resource	None

Group

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 Group	None
active	Annotated[bool | Boolean, BeforeValidator] | None	Whether this group's record is in active use	None
type	Annotated[str | Code, BeforeValidator] | None	person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen	None
membership	Annotated[str | Code, BeforeValidator] | None	definitional | enumerated	None
code	CodeableConcept | None	Kind of Group members	None
name	Annotated[str | String, BeforeValidator] | None	Label for Group	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the group	None
quantity	Annotated[int | UnsignedInt, BeforeValidator] | None	Number of members	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

GroupCharacteristic

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Value held by characteristic	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	Annotated[bool | Boolean, BeforeValidator] | None	Group includes or excludes	None
period	Period | None	Period over which characteristic is tested	None

GroupMember

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

Bases: BackboneElement

Identifies the resource instances that are members of the group.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	If member is no longer in group	None

GuidanceResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	What guidance was requested	None
moduleCanonical	Annotated[str | Canonical, BeforeValidator] | None	What guidance was requested	None
moduleCodeableConcept	CodeableConcept | None	What guidance was requested	None
status	Annotated[str | Code, BeforeValidator] | None	success | data-requested | data-required | in-progress | failure | entered-in-error	None
subject	Reference | None	Patient the request was performed for	None
encounter	Reference | None	Encounter during which the response was returned	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the guidance response was processed	None
performer	Reference | None	Device returning the guidance	None
reason	List[CodeableReference] | None	Why guidance is needed	None
note	List[Annotation] | None	Additional notes about the response	None
evaluationMessage	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	List[Reference] | None	Proposed actions, if any	None
dataRequirement	List[DataRequirement] | None	Additional required data	None

HealthcareService

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

Bases: DomainResource

The details of a healthcare service available at a location or in a catalog. In the case where there is a hierarchy of services (for example, Lab -> Pathology -> Wound Cultures), this can be represented using a set of linked HealthcareServices.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this HealthcareService record is in active use	None
providedBy	Reference | None	Organization that provides this service	None
offeredIn	List[Reference] | None	The service within which this service is offered	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	Annotated[str | String, BeforeValidator] | None	Description of service as presented to a consumer while searching	None
comment	Annotated[str | Markdown, BeforeValidator] | None	Additional description and/or any specific issues not covered elsewhere	None
extraDetails	Annotated[str | Markdown, BeforeValidator] | None	Extra details about the service that can't be placed in the other fields	None
photo	Attachment | None	Facilitates quick identification of the service	None
contact	List[ExtendedContactDetail] | None	Official contact details for the HealthcareService	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	Annotated[bool | Boolean, BeforeValidator] | None	If an appointment is required for access to this service	None
availability	List[Availability] | None	Times the healthcare service is available (including exceptions)	None
endpoint	List[Reference] | None	Technical endpoints providing access to electronic services operated for the healthcare service	None

HealthcareServiceEligibility

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Describes the eligibility conditions for the service	None

ImagingSelection

Path: fhircraft.fhir.resources.datatypes.R5.core.imaging_selection.ImagingSelection

Bases: DomainResource

A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 Imaging Selection	None
status	Annotated[str | Code, BeforeValidator] | None	available | entered-in-error | unknown	None
subject	Reference | None	Subject of the selected instances	None
issued	Annotated[datetime | Instant, BeforeValidator] | None	Date / time when this imaging selection was created	None
performer	List[ImagingSelectionPerformer] | None	Selector of the instances (human or machine)	None
basedOn	List[Reference] | None	Associated request	None
category	List[CodeableConcept] | None	Classifies the imaging selection	None
code	CodeableConcept | None	Imaging Selection purpose text or code	None
studyUid	Annotated[str | Id, BeforeValidator] | None	DICOM Study Instance UID	None
derivedFrom	List[Reference] | None	The imaging study from which the imaging selection is derived	None
endpoint	List[Reference] | None	The network service providing retrieval for the images referenced in the imaging selection	None
seriesUid	Annotated[str | Id, BeforeValidator] | None	DICOM Series Instance UID	None
seriesNumber	Annotated[int | UnsignedInt, BeforeValidator] | None	DICOM Series Number	None
frameOfReferenceUid	Annotated[str | Id, BeforeValidator] | None	The Frame of Reference UID for the selected images	None
bodySite	CodeableReference | None	Body part examined	None
focus	List[Reference] | None	Related resource that is the focus for the imaging selection	None
instance	List[ImagingSelectionInstance] | None	The selected instances	None

ImagingSelectionInstance

Path: fhircraft.fhir.resources.datatypes.R5.core.imaging_selection.ImagingSelectionInstance

Bases: BackboneElement

Each imaging selection includes one or more selected DICOM SOP instances.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	DICOM SOP Instance UID	None
number	Annotated[int | UnsignedInt, BeforeValidator] | None	DICOM Instance Number	None
sopClass	Coding | None	DICOM SOP Class UID	None
subset	List[Annotated[str | String, BeforeValidator]] | None	The selected subset of the SOP Instance	None
imageRegion2D	List[ImagingSelectionInstanceImageRegion2D] | None	A specific 2D region in a DICOM image / frame	None
imageRegion3D	List[ImagingSelectionInstanceImageRegion3D] | None	A specific 3D region in a DICOM frame of reference	None

ImagingSelectionInstanceImageRegion2D

Path: fhircraft.fhir.resources.datatypes.R5.core.imaging_selection.ImagingSelectionInstanceImageRegion2D

Bases: BackboneElement

Each imaging selection instance or frame list might includes an image region, specified by a region type and a set of 2D coordinates. If the parent imagingSelection.instance contains a subset element of type frame, the image region applies to all frames in the subset list.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
regionType	Annotated[str | Code, BeforeValidator] | None	point | polyline | interpolated | circle | ellipse	None
coordinate	List[Annotated[float | Decimal, BeforeValidator]] | None	Specifies the coordinates that define the image region	None

ImagingSelectionInstanceImageRegion3D

Path: fhircraft.fhir.resources.datatypes.R5.core.imaging_selection.ImagingSelectionInstanceImageRegion3D

Bases: BackboneElement

Each imaging selection might includes a 3D image region, specified by a region type and a set of 3D coordinates.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
regionType	Annotated[str | Code, BeforeValidator] | None	point | multipoint | polyline | polygon | ellipse | ellipsoid	None
coordinate	List[Annotated[float | Decimal, BeforeValidator]] | None	Specifies the coordinates that define the image region	None

ImagingSelectionPerformer

Path: fhircraft.fhir.resources.datatypes.R5.core.imaging_selection.ImagingSelectionPerformer

Bases: BackboneElement

Selector of the instances – human or machine.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 performer	None
actor	Reference | None	Author (human or machine)	None

ImagingStudy

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	registered | available | cancelled | entered-in-error | unknown	None
modality	List[CodeableConcept] | None	All of the distinct values for series' 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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the study was started	None
basedOn	List[Reference] | None	Request fulfilled	None
partOf	List[Reference] | None	Part of referenced event	None
referrer	Reference | None	Referring physician	None
endpoint	List[Reference] | None	Study access endpoint	None
numberOfSeries	Annotated[int | UnsignedInt, BeforeValidator] | None	Number of Study Related Series	None
numberOfInstances	Annotated[int | UnsignedInt, BeforeValidator] | None	Number of Study Related Instances	None
procedure	List[CodeableReference] | None	The performed procedure or code	None
location	Reference | None	Where ImagingStudy occurred	None
reason	List[CodeableReference] | None	Why the study was requested / performed	None
note	List[Annotation] | None	User-defined comments	None
description	Annotated[str | String, BeforeValidator] | None	Institution-generated description	None
series	List[ImagingStudySeries] | None	Each study has one or more series of instances	None

ImagingStudySeries

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	DICOM Series Instance UID for the series	None
number	Annotated[int | UnsignedInt, BeforeValidator] | None	Numeric identifier of this series	None
modality	CodeableConcept | None	The modality used for this series	None
description	Annotated[str | String, BeforeValidator] | None	A short human readable summary of the series	None
numberOfInstances	Annotated[int | UnsignedInt, BeforeValidator] | None	Number of Series Related Instances	None
endpoint	List[Reference] | None	Series access endpoint	None
bodySite	CodeableReference | None	Body part examined	None
laterality	CodeableConcept | None	Body part laterality	None
specimen	List[Reference] | None	Specimen imaged	None
started	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the series started	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	DICOM SOP Instance UID	None
sopClass	Coding | None	DICOM class type	None
number	Annotated[int | UnsignedInt, BeforeValidator] | None	The number of this instance in the series	None
title	Annotated[str | String, BeforeValidator] | None	Description of instance	None

ImagingStudySeriesPerformer

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
basedOn	List[Reference] | None	Authority that the immunization event is based on	None
status	Annotated[str | Code, BeforeValidator] | None	completed | entered-in-error | not-done	None
statusReason	CodeableConcept | None	Reason for current status	None
vaccineCode	CodeableConcept | None	Vaccine administered	None
administeredProduct	CodeableReference | None	Product that was administered	None
manufacturer	CodeableReference | None	Vaccine manufacturer	None
lotNumber	Annotated[str | String, BeforeValidator] | None	Vaccine lot number	None
expirationDate	Annotated[date | str | Date, BeforeValidator] | None	Vaccine expiration date	None
patient	Reference | None	Who was immunized	None
encounter	Reference | None	Encounter immunization was part of	None
supportingInformation	List[Reference] | None	Additional information in support of the immunization	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Vaccine administration date	None
occurrenceString	Annotated[str | String, BeforeValidator] | None	Vaccine administration date	None
primarySource	Annotated[bool | Boolean, BeforeValidator] | None	Indicates context the data was captured in	None
informationSource	CodeableReference | None	Indicates the source of a reported record	None
location	Reference | None	Where immunization occurred	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
reason	List[CodeableReference] | None	Why immunization occurred	None
isSubpotent	Annotated[bool | Boolean, BeforeValidator] | None	Dose potency	None
subpotentReason	List[CodeableConcept] | None	Reason for being subpotent	None
programEligibility	List[ImmunizationProgramEligibility] | None	Patient eligibility for a specific 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

ImmunizationPerformer

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

Bases: BackboneElement

Indicates who performed the immunization event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

ImmunizationProgramEligibility

Path: fhircraft.fhir.resources.datatypes.R5.core.immunization.ImmunizationProgramEligibility

Bases: BackboneElement

Indicates a patient's eligibility for a funding program.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
program	CodeableConcept | None	The program that eligibility is declared for	None
programStatus	CodeableConcept | None	The patient's eligibility status for the program	None

ImmunizationProtocolApplied

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name of vaccine series	None
authority	Reference | None	Who is responsible for publishing the recommendations	None
targetDisease	List[CodeableConcept] | None	Vaccine preventatable disease being targeted	None
doseNumber	Annotated[str | String, BeforeValidator] | None	Dose number within series	None
seriesDoses	Annotated[str | String, BeforeValidator] | None	Recommended number of doses for immunity	None

ImmunizationReaction

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When reaction started	None
manifestation	CodeableReference | None	Additional information on reaction	None
reported	Annotated[bool | Boolean, BeforeValidator] | None	Indicates self-reported reaction	None

ImmunizationEvaluation

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	completed | entered-in-error	None
patient	Reference | None	Who this evaluation is for	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date evaluation was performed	None
authority	Reference | None	Who is responsible for publishing the recommendations	None
targetDisease	CodeableConcept | None	The vaccine preventable disease schedule being evaluated	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 why the doese is considered valid, invalid or some other status	None
description	Annotated[str | Markdown, BeforeValidator] | None	Evaluation notes	None
series	Annotated[str | String, BeforeValidator] | None	Name of vaccine series	None
doseNumber	Annotated[str | String, BeforeValidator] | None	Dose number within series	None
seriesDoses	Annotated[str | String, BeforeValidator] | None	Recommended number of doses for immunity	None

ImmunizationRecommendation

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date recommendation(s) created	None
authority	Reference | None	Who is responsible for protocol	None
recommendation	List[ImmunizationRecommendationRecommendation] | None	Vaccine administration recommendations	None

ImmunizationRecommendationRecommendation

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

Bases: BackboneElement

Vaccine administration recommendations.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[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	Annotated[str | Markdown, BeforeValidator] | None	Protocol details	None
series	Annotated[str | String, BeforeValidator] | None	Name of vaccination series	None
doseNumber	Annotated[str | String, BeforeValidator] | None	Recommended dose number within series	None
seriesDoses	Annotated[str | String, BeforeValidator] | None	Recommended number of doses for immunity	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Recommended date	None

ImplementationGuide

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this implementation guide, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the implementation guide (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the implementation guide	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this implementation guide (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this implementation guide (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the implementation guide	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
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this implementation guide is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
packageId	Annotated[str | Id, BeforeValidator] | None	NPM Package name for IG	None
license	Annotated[str | Code, BeforeValidator] | None	SPDX license code for this IG (or not-open-source)	None
fhirVersion	List[Annotated[str | Code, BeforeValidator]] | None	FHIR Version(s) this Implementation Guide targets	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

ImplementationGuideDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Descriptive name for the package	None
description	Annotated[str | Markdown, BeforeValidator] | None	Human readable text describing the package	None

ImplementationGuideDefinitionPage

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
sourceUrl	Annotated[str | Url, BeforeValidator] | None	Source for page	None
sourceString	Annotated[str | String, BeforeValidator] | None	Source for page	None
sourceMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Source for page	None
name	Annotated[str | Url, BeforeValidator] | None	Name of the page when published	None
title	Annotated[str | String, BeforeValidator] | None	Short title shown for navigational assistance	None
generation	Annotated[str | Code, BeforeValidator] | None	html | markdown | xml | generated	None
page	List[ImplementationGuideDefinitionPage] | None	Nested Pages / Sections	None

ImplementationGuideDefinitionParameter

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

Bases: BackboneElement

A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Coding | None	code that identifies parameter	None
value	Annotated[str | String, BeforeValidator] | None	Value for named type	None

ImplementationGuideDefinitionResource

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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[Annotated[str | Code, BeforeValidator]] | None	Versions this applies to (if different to IG)	None
name	Annotated[str | String, BeforeValidator] | None	Human readable name for the resource	None
description	Annotated[str | Markdown, BeforeValidator] | None	Reason why included in guide	None
isExample	Annotated[bool | Boolean, BeforeValidator] | None	Is this an example	None
profile	List[Annotated[str | Canonical, BeforeValidator]] | None	Profile(s) this is an example of	None
groupingId	Annotated[str | Id, BeforeValidator] | None	Grouping this is part of	None

ImplementationGuideDefinitionTemplate

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

Bases: BackboneElement

A template for building resources.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Type of template specified	None
source	Annotated[str | String, BeforeValidator] | None	The source location for the template	None
scope	Annotated[str | String, BeforeValidator] | None	The scope in which the template applies	None

ImplementationGuideDependsOn

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Canonical, BeforeValidator] | None	Identity of the IG that this depends on	None
packageId	Annotated[str | Id, BeforeValidator] | None	NPM Package name for IG this depends on	None
version	Annotated[str | String, BeforeValidator] | None	Version of the IG	None
reason	Annotated[str | Markdown, BeforeValidator] | None	Why dependency exists	None

ImplementationGuideGlobal

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Type this profile applies to	None
profile	Annotated[str | Canonical, BeforeValidator] | None	Profile that all resources must conform to	None

ImplementationGuideManifest

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

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Url, BeforeValidator] | None	Location of rendered implementation guide	None
resource	List[ImplementationGuideManifestResource] | None	Resource in the implementation guide	None
page	List[ImplementationGuideManifestPage] | None	HTML page within the parent IG	None
image	List[Annotated[str | String, BeforeValidator]] | None	Image within the IG	None
other	List[Annotated[str | String, BeforeValidator]] | None	Additional linkable file in IG	None

ImplementationGuideManifestPage

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

Bases: BackboneElement

Information about a page within the IG.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	HTML page name	None
title	Annotated[str | String, BeforeValidator] | None	Title of the page, for references	None
anchor	List[Annotated[str | String, BeforeValidator]] | None	Anchor available on the page	None

ImplementationGuideManifestResource

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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
isExample	Annotated[bool | Boolean, BeforeValidator] | None	Is this an example	None
profile	List[Annotated[str | Canonical, BeforeValidator]] | None	Profile(s) this is an example of	None
relativePath	Annotated[str | Url, BeforeValidator] | None	Relative path for page in IG	None

Ingredient

Path: fhircraft.fhir.resources.datatypes.R5.core.ingredient.Ingredient

Bases: DomainResource

An ingredient of a manufactured item or pharmaceutical product.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	An identifier or code by which the ingredient can be referenced	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
for_	List[Reference] | None	The product which this ingredient is a constituent part of	None
role	CodeableConcept | None	Purpose of the ingredient within the product, e.g. active, inactive	None
function	List[CodeableConcept] | None	Precise action within the drug product, e.g. antioxidant, alkalizing agent	None
group	CodeableConcept | None	A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink	None
allergenicIndicator	Annotated[bool | Boolean, BeforeValidator] | None	If the ingredient is a known or suspected allergen	None
comment	Annotated[str | Markdown, BeforeValidator] | None	A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying	None
manufacturer	List[IngredientManufacturer] | None	An organization that manufactures this ingredient	None
substance	IngredientSubstance | None	The substance that comprises this ingredient	None

IngredientManufacturer

Path: fhircraft.fhir.resources.datatypes.R5.core.ingredient.IngredientManufacturer

Bases: BackboneElement

The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	allowed | possible | actual	None
manufacturer	Reference | None	An organization that manufactures this ingredient	None

IngredientSubstance

Path: fhircraft.fhir.resources.datatypes.R5.core.ingredient.IngredientSubstance

Bases: BackboneElement

The substance that comprises this ingredient.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableReference | None	A code or full resource that represents the ingredient substance	None
strength	List[IngredientSubstanceStrength] | None	The quantity of substance, per presentation, or per volume or mass, and type of quantity	None

IngredientSubstanceStrength

Path: fhircraft.fhir.resources.datatypes.R5.core.ingredient.IngredientSubstanceStrength

Bases: BackboneElement

The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
presentationRatio	Ratio | None	The quantity of substance in the unit of presentation	None
presentationRatioRange	RatioRange | None	The quantity of substance in the unit of presentation	None
presentationCodeableConcept	CodeableConcept | None	The quantity of substance in the unit of presentation	None
presentationQuantity	Quantity | None	The quantity of substance in the unit of presentation	None
textPresentation	Annotated[str | String, BeforeValidator] | None	Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)	None
concentrationRatio	Ratio | None	The strength per unitary volume (or mass)	None
concentrationRatioRange	RatioRange | None	The strength per unitary volume (or mass)	None
concentrationCodeableConcept	CodeableConcept | None	The strength per unitary volume (or mass)	None
concentrationQuantity	Quantity | None	The strength per unitary volume (or mass)	None
textConcentration	Annotated[str | String, BeforeValidator] | None	Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)	None
basis	CodeableConcept | None	A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt)	None
measurementPoint	Annotated[str | String, BeforeValidator] | None	When strength is measured at a particular point or distance	None
country	List[CodeableConcept] | None	Where the strength range applies	None
referenceStrength	List[IngredientSubstanceStrengthReferenceStrength] | None	Strength expressed in terms of a reference substance	None

IngredientSubstanceStrengthReferenceStrength

Path: fhircraft.fhir.resources.datatypes.R5.core.ingredient.IngredientSubstanceStrengthReferenceStrength

Bases: BackboneElement

Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableReference | None	Relevant reference substance	None
strengthRatio	Ratio | None	Strength expressed in terms of a reference substance	None
strengthRatioRange	RatioRange | None	Strength expressed in terms of a reference substance	None
strengthQuantity	Quantity | None	Strength expressed in terms of a reference substance	None
measurementPoint	Annotated[str | String, BeforeValidator] | None	When strength is measured at a particular point or distance	None
country	List[CodeableConcept] | None	Where the strength range applies	None

InsurancePlan

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

Bases: DomainResource

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

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
type	List[CodeableConcept] | None	Kind of product	None
name	Annotated[str | String, BeforeValidator] | None	Official name	None
alias	List[Annotated[str | String, BeforeValidator]] | None	Alternate names	None
period	Period | None	When the product is available	None
ownedBy	Reference | None	Product issuer	None
administeredBy	Reference | None	Product administrator	None
coverageArea	List[Reference] | None	Where product applies	None
contact	List[ExtendedContactDetail] | None	Official contact details relevant to the health insurance plan/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

InsurancePlanCoverage

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

Bases: BackboneElement

Details about the coverage offered by the insurance product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.insurance_plan.InsurancePlanCoverageBenefit

Bases: BackboneElement

Specific benefits under this type of coverage.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Referral requirements	None
limit	List[InsurancePlanCoverageBenefitLimit] | None	Benefit limits	None

InsurancePlanCoverageBenefitLimit

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

Bases: BackboneElement

The specific limits on the benefit.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.insurance_plan.InsurancePlanPlan

Bases: BackboneElement

Details about an insurance plan.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.insurance_plan.InsurancePlanPlanGeneralCost

Bases: BackboneElement

Overall costs associated with the plan.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Number of enrollees	None
cost	Money | None	Cost value	None
comment	Annotated[str | String, BeforeValidator] | None	Additional cost information	None

InsurancePlanPlanSpecificCost

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

Bases: BackboneElement

Costs associated with the coverage provided by the product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.insurance_plan.InsurancePlanPlanSpecificCostBenefit

Bases: BackboneElement

List of the specific benefits under this category of benefit.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.insurance_plan.InsurancePlanPlanSpecificCostBenefitCost

Bases: BackboneElement

List of the costs associated with a specific benefit.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

InventoryItem

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_item.InventoryItem

Bases: DomainResource

functional description of an inventory item used in inventory and supply-related workflows.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 inventory item	None
status	Annotated[str | Code, BeforeValidator] | None	active | inactive | entered-in-error | unknown	None
category	List[CodeableConcept] | None	Category or class of the item	None
code	List[CodeableConcept] | None	code designating the specific type of item	None
name	List[InventoryItemName] | None	The item name(s) - the brand name, or common name, functional name, generic name or others	None
responsibleOrganization	List[InventoryItemResponsibleOrganization] | None	Organization(s) responsible for the product	None
description	InventoryItemDescription | None	Descriptive characteristics of the item	None
inventoryStatus	List[CodeableConcept] | None	The usage status like recalled, in use, discarded	None
baseUnit	CodeableConcept | None	The base unit of measure - the unit in which the product is used or counted	None
netContent	Quantity | None	Net content or amount present in the item	None
association	List[InventoryItemAssociation] | None	Association with other items or products	None
characteristic	List[InventoryItemCharacteristic] | None	Characteristic of the item	None
instance	InventoryItemInstance | None	Instances or occurrences of the product	None
productReference	Reference | None	Link to a product resource used in clinical workflows	None

InventoryItemAssociation

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_item.InventoryItemAssociation

Bases: BackboneElement

Association with other items or products.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
associationType	CodeableConcept | None	The type of association between the device and the other item	None
relatedItem	Reference | None	The related item or product	None
quantity	Ratio | None	The quantity of the product in this product	None

InventoryItemCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_item.InventoryItemCharacteristic

Bases: BackboneElement

The descriptive or identifying characteristics of the item.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
characteristicType	CodeableConcept | None	The characteristic that is being defined	None
valueString	Annotated[str | String, BeforeValidator] | None	The value of the attribute	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	The value of the attribute	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	The value of the attribute	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	The value of the attribute	None
valueUrl	Annotated[str | Url, BeforeValidator] | None	The value of the attribute	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The value of the attribute	None
valueQuantity	Quantity | None	The value of the attribute	None
valueRange	Range | None	The value of the attribute	None
valueRatio	Ratio | None	The value of the attribute	None
valueAnnotation	Annotation | None	The value of the attribute	None
valueAddress	Address | None	The value of the attribute	None
valueDuration	Duration | None	The value of the attribute	None
valueCodeableConcept	CodeableConcept | None	The value of the attribute	None

InventoryItemDescription

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_item.InventoryItemDescription

Bases: BackboneElement

The descriptive characteristics of the inventory item.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	The language that is used in the item description	None
description	Annotated[str | String, BeforeValidator] | None	Textual description of the item	None

InventoryItemInstance

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_item.InventoryItemInstance

Bases: BackboneElement

Instances or occurrences of the product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 identifier for the physical instance, typically a serial number	None
lotNumber	Annotated[str | String, BeforeValidator] | None	The lot or batch number of the item	None
expiry	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The expiry date or date and time for the product	None
subject	Reference | None	The subject that the item is associated with	None
location	Reference | None	The location that the item is associated with	None

InventoryItemName

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_item.InventoryItemName

Bases: BackboneElement

The item name(s) - the brand name, or common name, functional name, generic name.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
nameType	Coding | None	The type of name e.g. 'brand-name', 'functional-name', 'common-name'	None
language	Annotated[str | Code, BeforeValidator] | None	The language used to express the item name	None
name	Annotated[str | String, BeforeValidator] | None	The name or designation of the item	None

InventoryItemResponsibleOrganization

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_item.InventoryItemResponsibleOrganization

Bases: BackboneElement

Organization(s) responsible for the product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The role of the organization e.g. manufacturer, distributor, or other	None
organization	Reference | None	An organization that is associated with the item	None

InventoryReport

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_report.InventoryReport

Bases: DomainResource

A report of inventory or stock items.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 report	None
status	Annotated[str | Code, BeforeValidator] | None	draft | requested | active | entered-in-error	None
countType	Annotated[str | Code, BeforeValidator] | None	snapshot | difference	None
operationType	CodeableConcept | None	addition | subtraction	None
operationTypeReason	CodeableConcept | None	The reason for this count - regular count, ad-hoc count, new arrivals, etc	None
reportedDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the report has been submitted	None
reporter	Reference | None	Who submits the report	None
reportingPeriod	Period | None	The period the report refers to	None
inventoryListing	List[InventoryReportInventoryListing] | None	An inventory listing section (grouped by any of the attributes)	None
note	List[Annotation] | None	A note associated with the InventoryReport	None

InventoryReportInventoryListing

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_report.InventoryReportInventoryListing

Bases: BackboneElement

An inventory listing section (grouped by any of the attributes).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 of the inventory items	None
itemStatus	CodeableConcept | None	The status of the items that are being reported	None
countingDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date and time when the items were counted	None
item	List[InventoryReportInventoryListingItem] | None	The item or items in this listing	None

InventoryReportInventoryListingItem

Path: fhircraft.fhir.resources.datatypes.R5.core.inventory_report.InventoryReportInventoryListingItem

Bases: BackboneElement

The item or items in this listing.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The inventory category or classification of the items being reported	None
quantity	Quantity | None	The quantity of the item or items being reported	None
item	CodeableReference | None	The code or reference to the item type	None

Invoice

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	draft | issued | balanced | cancelled | entered-in-error	None
cancelledReason	Annotated[str | String, BeforeValidator] | None	Reason for cancellation of this Invoice	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	DEPRICATED	None
creation	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When posted	None
periodDate	Annotated[date | str | Date, BeforeValidator] | None	Billing date or period	None
periodPeriod	Period | None	Billing date or period	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[MonetaryComponent] | 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	Annotated[str | Markdown, BeforeValidator] | None	Payment details	None
note	List[Annotation] | None	Comments made about the invoice	None

InvoiceLineItem

Path: fhircraft.fhir.resources.datatypes.R5.core.invoice.InvoiceLineItem

Bases: BackboneElement

Each line item represents one charge for goods and services rendered. Details such.ofType(date), code and amount are found in the referenced ChargeItem resource.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	Sequence number of line item	None
servicedDate	Annotated[date | str | Date, BeforeValidator] | None	Service data or period	None
servicedPeriod	Period | None	Service data or period	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[MonetaryComponent] | None	Components of total line item price	None

InvoiceParticipant

Path: fhircraft.fhir.resources.datatypes.R5.core.invoice.InvoiceParticipant

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

Library

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this library, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the library	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the library	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this library (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this library (human friendly)	None
subtitle	Annotated[str | String, BeforeValidator] | None	Subordinate title of the library	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the library	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	Annotated[str | Markdown, BeforeValidator] | None	Why this library is defined	None
usage	Annotated[str | Markdown, BeforeValidator] | None	Describes the clinical usage of the library	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the library was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the library was last reviewed by the publisher	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

Linkage

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this linkage assertion is active or not	None
author	Reference | None	Who is responsible for linkages	None
item	List[LinkageItem] | None	Item to be linked	None

LinkageItem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	source | alternate | historical	None
resource	Reference | None	Resource being linked	None

List

Path: fhircraft.fhir.resources.datatypes.R5.core.list.List

Bases: DomainResource

A List is a curated collection of resources, for things such as problem lists, allergy lists, facility list, organization list, etc.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	current | retired | entered-in-error	None
mode	Annotated[str | Code, BeforeValidator] | None	working | snapshot | changes	None
title	Annotated[str | String, BeforeValidator] | None	Descriptive name for the list	None
code	CodeableConcept | None	What the purpose of this list is	None
subject	List[Reference] | None	If all resources have the same subject(s)	None
encounter	Reference | None	Context in which list created	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the list was prepared	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

ListEntry

Path: fhircraft.fhir.resources.datatypes.R5.core.list.ListEntry

Bases: BackboneElement

Entries in this list.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	If this item is actually marked as deleted	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When item added to list	None
item	Reference | None	Actual entry	None

Location

Path: fhircraft.fhir.resources.datatypes.R5.core.location.Location

Bases: DomainResource

Details and position information for a place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | suspended | inactive	None
operationalStatus	Coding | None	The operational status of the location (typically only for a bed/room)	None
name	Annotated[str | String, BeforeValidator] | None	Name of the location as used by humans	None
alias	List[Annotated[str | String, BeforeValidator]] | None	A list of alternate names that the location is known as, or was known as, in the past	None
description	Annotated[str | Markdown, BeforeValidator] | None	Additional details about the location that could be displayed as further information to identify the location beyond its name	None
mode	Annotated[str | Code, BeforeValidator] | None	instance | kind	None
type	List[CodeableConcept] | None	Type of function performed	None
contact	List[ExtendedContactDetail] | None	Official contact details for the location	None
address	Address | None	Physical location	None
form	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
characteristic	List[CodeableConcept] | None	Collection of characteristics (attributes)	None
hoursOfOperation	List[Availability] | None	What days/times during a week is this location usually open (including exceptions)	None
virtualService	List[VirtualServiceDetail] | None	Connection details of a virtual service (e.g. conference call)	None
endpoint	List[Reference] | None	Technical endpoints providing access to services operated for the location	None

LocationPosition

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[float | Decimal, BeforeValidator] | None	Longitude with WGS84 datum	None
latitude	Annotated[float | Decimal, BeforeValidator] | None	Latitude with WGS84 datum	None
altitude	Annotated[float | Decimal, BeforeValidator] | None	Altitude with WGS84 datum	None

ManufacturedItemDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.manufactured_item_definition.ManufacturedItemDefinition

Bases: DomainResource

The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
name	Annotated[str | String, BeforeValidator] | None	A descriptive name applied to this item	None
manufacturedDoseForm	CodeableConcept | None	Dose form as manufactured (before any necessary transformation)	None
unitOfPresentation	CodeableConcept | None	The “real-world” units in which the quantity of the item is described	None
manufacturer	List[Reference] | None	Manufacturer of the item, one of several possible	None
marketingStatus	List[MarketingStatus] | None	Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated	None
ingredient	List[CodeableConcept] | None	The ingredients of this manufactured item. Only needed if these are not specified by incoming references from the Ingredient resource	None
property_	List[ManufacturedItemDefinitionProperty] | None	General characteristics of this item	None
component	List[ManufacturedItemDefinitionComponent] | None	Physical parts of the manufactured item, that it is intrisically made from. This is distinct from the ingredients that are part of its chemical makeup	None

ManufacturedItemDefinitionComponent

Path: fhircraft.fhir.resources.datatypes.R5.core.manufactured_item_definition.ManufacturedItemDefinitionComponent

Bases: BackboneElement

Physical parts of the manufactured item, that it is intrisically made from. This is distinct from the ingredients that are part of its chemical makeup.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Defining type of the component e.g. shell, layer, ink	None
function	List[CodeableConcept] | None	The function of this component within the item e.g. delivers active ingredient, masks taste	None
amount	List[Quantity] | None	The measurable amount of total quantity of all substances in the component, expressable in different ways (e.g. by mass or volume)	None
constituent	List[ManufacturedItemDefinitionComponentConstituent] | None	A reference to a constituent of the manufactured item as a whole, linked here so that its component location within the item can be indicated. This not where the item's ingredient are primarily stated (for which see Ingredient.for or ManufacturedItemDefinition.ingredient)	None
property_	List[ManufacturedItemDefinitionComponentProperty] | None	General characteristics of this component	None
component	List[ManufacturedItemDefinitionComponent] | None	A component that this component contains or is made from	None

ManufacturedItemDefinitionComponentConstituent

Path: fhircraft.fhir.resources.datatypes.R5.core.manufactured_item_definition.ManufacturedItemDefinitionComponentConstituent

Bases: BackboneElement

A reference to a constituent of the manufactured item as a whole, linked here so that its component location within the item can be indicated. This not where the item's ingredient are primarily stated (for which see Ingredient.for or ManufacturedItemDefinition.ingredient).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[Quantity] | None	The measurable amount of the substance, expressable in different ways (e.g. by mass or volume)	None
location	List[CodeableConcept] | None	The physical location of the constituent/ingredient within the component	None
function	List[CodeableConcept] | None	The function of this constituent within the component e.g. binder	None
hasIngredient	List[CodeableReference] | None	The ingredient that is the constituent of the given component	None

ManufacturedItemDefinitionComponentProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.manufactured_item_definition.ManufacturedItemDefinitionComponentProperty

Bases: BackboneElement

General characteristics of this component.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 expressing the type of characteristic	None
valueCodeableConcept	CodeableConcept | None	A value for the characteristic	None
valueQuantity	Quantity | None	A value for the characteristic	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	A value for the characteristic	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	A value for the characteristic	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	A value for the characteristic	None
valueAttachment	Attachment | None	A value for the characteristic	None
valueReference	Reference | None	A value for the characteristic	None

ManufacturedItemDefinitionProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.manufactured_item_definition.ManufacturedItemDefinitionProperty

Bases: BackboneElement

General characteristics of this item.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 expressing the type of characteristic	None
valueCodeableConcept	CodeableConcept | None	A value for the characteristic	None
valueQuantity	Quantity | None	A value for the characteristic	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	A value for the characteristic	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	A value for the characteristic	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	A value for the characteristic	None
valueAttachment	Attachment | None	A value for the characteristic	None
valueReference	Reference | None	A value for the characteristic	None

Measure

Path: fhircraft.fhir.resources.datatypes.R5.core.measure.Measure

Bases: DomainResource

The Measure resource provides the definition of a quality measure.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this measure, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the measure	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the measure	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this measure (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this measure (human friendly)	None
subtitle	Annotated[str | String, BeforeValidator] | None	Subordinate title of the measure	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	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
basis	Annotated[str | Code, BeforeValidator] | None	Population basis	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the measure	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	Annotated[str | Markdown, BeforeValidator] | None	Why this measure is defined	None
usage	Annotated[str | Markdown, BeforeValidator] | None	Describes the clinical usage of the measure	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the measure was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the measure was last reviewed by the publisher	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[Annotated[str | Canonical, BeforeValidator]] | None	Logic used by the measure	None
disclaimer	Annotated[str | Markdown, BeforeValidator] | None	Disclaimer for use of the measure or its referenced content	None
scoring	CodeableConcept | None	proportion | ratio | continuous-variable | cohort	None
scoringUnit	CodeableConcept | None	What units?	None
compositeScoring	CodeableConcept | None	opportunity | all-or-nothing | linear | weighted	None
type	List[CodeableConcept] | None	process | outcome | structure | patient-reported-outcome | composite	None
riskAdjustment	Annotated[str | Markdown, BeforeValidator] | None	How risk adjustment is applied for this measure	None
rateAggregation	Annotated[str | Markdown, BeforeValidator] | None	How is rate aggregation performed for this measure	None
rationale	Annotated[str | Markdown, BeforeValidator] | None	Detailed description of why the measure exists	None
clinicalRecommendationStatement	Annotated[str | Markdown, BeforeValidator] | None	Summary of clinical guidelines	None
improvementNotation	CodeableConcept | None	increase | decrease	None
term	List[MeasureTerm] | None	Defined terms used in the measure documentation	None
guidance	Annotated[str | Markdown, BeforeValidator] | None	Additional guidance for implementers (deprecated)	None
group	List[MeasureGroup] | None	Population criteria group	None
supplementalData	List[MeasureSupplementalData] | None	What other data should be reported with the measure	None

MeasureGroup

Path: fhircraft.fhir.resources.datatypes.R5.core.measure.MeasureGroup

Bases: BackboneElement

A group of population criteria for the measure.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Unique id for group in measure	None
code	CodeableConcept | None	Meaning of the group	None
description	Annotated[str | Markdown, BeforeValidator] | None	Summary description	None
type	List[CodeableConcept] | None	process | outcome | structure | patient-reported-outcome | composite	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
basis	Annotated[str | Code, BeforeValidator] | None	Population basis	None
scoring	CodeableConcept | None	proportion | ratio | continuous-variable | cohort	None
scoringUnit	CodeableConcept | None	What units?	None
rateAggregation	Annotated[str | Markdown, BeforeValidator] | None	How is rate aggregation performed for this measure	None
improvementNotation	CodeableConcept | None	increase | decrease	None
library	List[Annotated[str | Canonical, BeforeValidator]] | None	Logic used by the measure group	None
population	List[MeasureGroupPopulation] | None	Population criteria	None
stratifier	List[MeasureGroupStratifier] | None	Stratifier criteria for the measure	None

MeasureGroupPopulation

Path: fhircraft.fhir.resources.datatypes.R5.core.measure.MeasureGroupPopulation

Bases: BackboneElement

A population criteria for the measure.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Unique id for population in measure	None
code	CodeableConcept | None	initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation	None
description	Annotated[str | Markdown, BeforeValidator] | None	The human readable description of this population criteria	None
criteria	Expression | None	The criteria that defines this population	None
groupDefinition	Reference | None	A group resource that defines this population	None
inputPopulationId	Annotated[str | String, BeforeValidator] | None	Which population	None
aggregateMethod	CodeableConcept | None	Aggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)	None

MeasureGroupStratifier

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Unique id for stratifier in measure	None
code	CodeableConcept | None	Meaning of the stratifier	None
description	Annotated[str | Markdown, BeforeValidator] | None	The human readable description of this stratifier	None
criteria	Expression | None	How the measure should be stratified	None
groupDefinition	Reference | None	A group resource that defines this population	None
component	List[MeasureGroupStratifierComponent] | None	Stratifier criteria component for the measure	None

MeasureGroupStratifierComponent

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Unique id for stratifier component in measure	None
code	CodeableConcept | None	Meaning of the stratifier component	None
description	Annotated[str | Markdown, BeforeValidator] | None	The human readable description of this stratifier component	None
criteria	Expression | None	Component of how the measure should be stratified	None
groupDefinition	Reference | None	A group resource that defines this population	None

MeasureSupplementalData

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Unique id for supplementalData in measure	None
code	CodeableConcept | None	Meaning of the supplemental data	None
usage	List[CodeableConcept] | None	supplemental-data | risk-adjustment-factor	None
description	Annotated[str | Markdown, BeforeValidator] | None	The human readable description of this supplemental data	None
criteria	Expression | None	Expression describing additional data to be reported	None

MeasureTerm

Path: fhircraft.fhir.resources.datatypes.R5.core.measure.MeasureTerm

Bases: BackboneElement

Provides a description of an individual term used within the measure.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 term?	None
definition	Annotated[str | Markdown, BeforeValidator] | None	Meaning of the term	None

MeasureReport

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	complete | pending | error	None
type	Annotated[str | Code, BeforeValidator] | None	individual | subject-list | summary | data-exchange	None
dataUpdateType	Annotated[str | Code, BeforeValidator] | None	incremental | snapshot	None
measure	Annotated[str | Canonical, BeforeValidator] | None	What measure was calculated	None
subject	Reference | None	What individual(s) the report is for	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the measure was calculated	None
reporter	Reference | None	Who is reporting the data	None
reportingVendor	Reference | None	What vendor prepared the data	None
location	Reference | None	Where the reported data is from	None
period	Period | None	What period the report covers	None
inputParameters	Reference | None	What parameters were provided to the report	None
scoring	CodeableConcept | None	What scoring method (e.g. proportion, ratio, continuous-variable)	None
improvementNotation	CodeableConcept | None	increase | decrease	None
group	List[MeasureReportGroup] | None	Measure results for each group	None
supplementalData	List[Reference] | None	Additional information collected for the report	None
evaluatedResource	List[Reference] | None	What data was used to calculate the measure score	None

MeasureReportGroup

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Pointer to specific group from Measure	None
code	CodeableConcept | None	Meaning of the group	None
subject	Reference | None	What individual(s) the report is for	None
population	List[MeasureReportGroupPopulation] | None	The populations in the group	None
measureScoreQuantity	Quantity | None	What score this group achieved	None
measureScoreDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	What score this group achieved	None
measureScoreCodeableConcept	CodeableConcept | None	What score this group achieved	None
measureScorePeriod	Period | None	What score this group achieved	None
measureScoreRange	Range | None	What score this group achieved	None
measureScoreDuration	Duration | None	What score this group achieved	None
stratifier	List[MeasureReportGroupStratifier] | None	Stratification results	None

MeasureReportGroupPopulation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Pointer to specific population from Measure	None
code	CodeableConcept | None	initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation	None
count	Annotated[int | Integer, BeforeValidator] | None	Size of the population	None
subjectResults	Reference | None	For subject-list reports, the subject results in this population	None
subjectReport	List[Reference] | None	For subject-list reports, a subject result in this population	None
subjects	Reference | None	What individual(s) in the population	None

MeasureReportGroupStratifier

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Pointer to specific stratifier from Measure	None
code	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.R5.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	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
valueCodeableConcept	CodeableConcept | None	The stratum value, e.g. male	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	The stratum value, e.g. male	None
valueQuantity	Quantity | None	The stratum value, e.g. male	None
valueRange	Range | None	The stratum value, e.g. male	None
valueReference	Reference | 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
measureScoreQuantity	Quantity | None	What score this stratum achieved	None
measureScoreDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	What score this stratum achieved	None
measureScoreCodeableConcept	CodeableConcept | None	What score this stratum achieved	None
measureScorePeriod	Period | None	What score this stratum achieved	None
measureScoreRange	Range | None	What score this stratum achieved	None
measureScoreDuration	Duration | None	What score this stratum achieved	None

MeasureReportGroupStratifierStratumComponent

Path: fhircraft.fhir.resources.datatypes.R5.core.measure_report.MeasureReportGroupStratifierStratumComponent

Bases: BackboneElement

A stratifier component value.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Pointer to specific stratifier component from Measure	None
code	CodeableConcept | None	What stratifier component of the group	None
valueCodeableConcept	CodeableConcept | None	The stratum component value, e.g. male	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	The stratum component value, e.g. male	None
valueQuantity	Quantity | None	The stratum component value, e.g. male	None
valueRange	Range | None	The stratum component value, e.g. male	None
valueReference	Reference | None	The stratum component value, e.g. male	None

MeasureReportGroupStratifierStratumPopulation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Pointer to specific population from Measure	None
code	CodeableConcept | None	initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation	None
count	Annotated[int | Integer, BeforeValidator] | None	Size of the population	None
subjectResults	Reference | None	For subject-list reports, the subject results in this population	None
subjectReport	List[Reference] | None	For subject-list reports, a subject result in this population	None
subjects	Reference | None	What individual(s) in the population	None

Medication

Path: fhircraft.fhir.resources.datatypes.R5.core.medication.Medication

Bases: DomainResource

This resource is primarily used for the identification and definition of a medication, including ingredients, 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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | inactive | entered-in-error	None
marketingAuthorizationHolder	Reference | None	Organization that has authorization to market medication	None
doseForm	CodeableConcept | None	powder | tablets | capsule +	None
totalVolume	Quantity | None	When the specified product code does not infer a package size, this is the specific amount of drug in the product	None
ingredient	List[MedicationIngredient] | None	Active or inactive ingredient	None
batch	MedicationBatch | None	Details about packaged medications	None
definition	Reference | None	Knowledge about this medication	None

MedicationBatch

Path: fhircraft.fhir.resources.datatypes.R5.core.medication.MedicationBatch

Bases: BackboneElement

Information that only applies to packages (not products).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Identifier assigned to batch	None
expirationDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When batch will expire	None

MedicationIngredient

Path: fhircraft.fhir.resources.datatypes.R5.core.medication.MedicationIngredient

Bases: BackboneElement

Identifies a particular constituent of interest in the product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
item	CodeableReference | None	The ingredient (substance or medication) that the ingredient.strength relates to	None
isActive	Annotated[bool | Boolean, BeforeValidator] | None	Active ingredient indicator	None
strengthRatio	Ratio | None	Quantity of ingredient present	None
strengthCodeableConcept	CodeableConcept | None	Quantity of ingredient present	None
strengthQuantity	Quantity | None	Quantity of ingredient present	None

MedicationAdministration

Path: fhircraft.fhir.resources.datatypes.R5.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. This event can also be used to record waste using a status of not-done and the appropriate statusReason.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Plan this is fulfilled by this administration	None
partOf	List[Reference] | None	Part of referenced event	None
status	Annotated[str | Code, BeforeValidator] | None	in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown	None
statusReason	List[CodeableConcept] | None	Reason administration not performed	None
category	List[CodeableConcept] | None	Type of medication administration	None
medication	CodeableReference | None	What was administered	None
subject	Reference | None	Who received medication	None
encounter	Reference | None	Encounter administered as part of	None
supportingInformation	List[Reference] | None	Additional information to support administration	None
occurenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Specific date/time or interval of time during which the administration took place (or did not take place)	None
occurencePeriod	Period | None	Specific date/time or interval of time during which the administration took place (or did not take place)	None
occurenceTiming	Timing | None	Specific date/time or interval of time during which the administration took place (or did not take place)	None
recorded	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the MedicationAdministration was first captured in the subject's record	None
isSubPotent	Annotated[bool | Boolean, BeforeValidator] | None	Full dose was not administered	None
subPotentReason	List[CodeableConcept] | None	Reason full dose was not administered	None
performer	List[MedicationAdministrationPerformer] | None	Who or what performed the medication administration and what type of performance they did	None
reason	List[CodeableReference] | None	Concept, condition or observation that supports why the medication was administered	None
request	Reference | None	Request administration performed against	None
device	List[CodeableReference] | 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

MedicationAdministrationDosage

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Free text dosage instructions e.g. SIG	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.R5.core.medication_administration.MedicationAdministrationPerformer

Bases: BackboneElement

The performer of the medication treatment. For devices this is the device that performed the administration of the medication. An IV Pump would be an example of a device that is performing the administration. Both the IV Pump and the practitioner that set the rate or bolus on the pump can be listed as performers.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableReference | None	Who or what performed the medication administration	None

MedicationDispense

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Plan that is fulfilled by this dispense	None
partOf	List[Reference] | None	Event that dispense is part of	None
status	Annotated[str | Code, BeforeValidator] | None	preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown	None
notPerformedReason	CodeableReference | None	Why a dispense was not performed	None
statusChanged	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the status changed	None
category	List[CodeableConcept] | None	Type of medication dispense	None
medication	CodeableReference | None	What medication was supplied	None
subject	Reference | None	Who the dispense is for	None
encounter	Reference | None	Encounter 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
recorded	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the recording of the dispense started	None
whenPrepared	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When product was packaged and reviewed	None
whenHandedOver	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When product was given out	None
destination	Reference | None	Where the medication was/will be sent	None
receiver	List[Reference] | None	Who collected the medication or where the medication was delivered	None
note	List[Annotation] | None	Information about the dispense	None
renderedDosageInstruction	Annotated[str | Markdown, BeforeValidator] | None	Full representation of the dosage instructions	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
eventHistory	List[Reference] | None	A list of relevant lifecycle events	None

MedicationDispensePerformer

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_dispense.MedicationDispensePerformer

Bases: BackboneElement

Indicates who or what performed the event.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether a substitution was or was not performed on the dispense	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	Reference | None	Who is responsible for the substitution	None

MedicationKnowledge

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledge

Bases: DomainResource

Information about a medication that is used to support knowledge.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	code that identifies this medication	None
status	Annotated[str | Code, BeforeValidator] | None	active | entered-in-error | inactive	None
author	Reference | None	Creator or owner of the knowledge or information about the medication	None
intendedJurisdiction	List[CodeableConcept] | None	Codes that identify the different jurisdictions for which the information of this resource was created	None
name	List[Annotated[str | String, BeforeValidator]] | None	A name associated with the medication being described	None
relatedMedicationKnowledge	List[MedicationKnowledgeRelatedMedicationKnowledge] | None	Associated or related medication information	None
associatedMedication	List[Reference] | None	The set of medication resources that are 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
preparationInstruction	Annotated[str | Markdown, BeforeValidator] | None	The instructions for preparing the medication	None
cost	List[MedicationKnowledgeCost] | None	The pricing of the medication	None
monitoringProgram	List[MedicationKnowledgeMonitoringProgram] | None	Program under which a medication is reviewed	None
indicationGuideline	List[MedicationKnowledgeIndicationGuideline] | None	Guidelines or protocols for administration of the medication for an indication	None
medicineClassification	List[MedicationKnowledgeMedicineClassification] | None	Categorization of the medication within a formulary or classification system	None
packaging	List[MedicationKnowledgePackaging] | None	Details about packaged medications	None
clinicalUseIssue	List[Reference] | None	Potential clinical issue with or between medication(s)	None
storageGuideline	List[MedicationKnowledgeStorageGuideline] | None	How the medication should be stored	None
regulatory	List[MedicationKnowledgeRegulatory] | None	Regulatory information about a medication	None
definitional	MedicationKnowledgeDefinitional | None	Minimal definition information about the medication	None

MedicationKnowledgeCost

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeCost

Bases: BackboneElement

The price of the medication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
effectiveDate	List[Period] | None	The date range for which the cost is effective	None
type	CodeableConcept | None	The category of the cost information	None
source	Annotated[str | String, BeforeValidator] | None	The source or owner for the price information	None
costMoney	Money | None	The price or category of the cost of the medication	None
costCodeableConcept	CodeableConcept | None	The price or category of the cost of the medication	None

MedicationKnowledgeDefinitional

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeDefinitional

Bases: BackboneElement

Along with the link to a Medicinal Product Definition resource, this information provides common definitional elements that are needed to understand the specific medication that is being described.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	List[Reference] | None	Definitional resources that provide more information about this medication	None
doseForm	CodeableConcept | None	powder | tablets | capsule +	None
intendedRoute	List[CodeableConcept] | None	The intended or approved route of administration	None
ingredient	List[MedicationKnowledgeDefinitionalIngredient] | None	Active or inactive ingredient	None
drugCharacteristic	List[MedicationKnowledgeDefinitionalDrugCharacteristic] | None	Specifies descriptive properties of the medicine	None

MedicationKnowledgeDefinitionalDrugCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeDefinitionalDrugCharacteristic

Bases: BackboneElement

Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Description of the characteristic	None
valueQuantity	Quantity | None	Description of the characteristic	None
valueBase64Binary	Annotated[str | Base64Binary, BeforeValidator] | None	Description of the characteristic	None
valueAttachment	Attachment | None	Description of the characteristic	None

MedicationKnowledgeDefinitionalIngredient

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeDefinitionalIngredient

Bases: BackboneElement

Identifies a particular constituent of interest in the product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
item	CodeableReference | None	Substances contained in the medication	None
type	CodeableConcept | None	A code that defines the type of ingredient, active, base, etc	None
strengthRatio	Ratio | None	Quantity of ingredient present	None
strengthCodeableConcept	CodeableConcept | None	Quantity of ingredient present	None
strengthQuantity	Quantity | None	Quantity of ingredient present	None

MedicationKnowledgeIndicationGuideline

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeIndicationGuideline

Bases: BackboneElement

Guidelines or protocols that are applicable for the administration of the medication based on indication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
indication	List[CodeableReference] | None	Indication for use that applies to the specific administration guideline	None
dosingGuideline	List[MedicationKnowledgeIndicationGuidelineDosingGuideline] | None	Guidelines for dosage of the medication	None

MedicationKnowledgeIndicationGuidelineDosingGuideline

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeIndicationGuidelineDosingGuideline

Bases: BackboneElement

The guidelines for the dosage of the medication for the indication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
treatmentIntent	CodeableConcept | None	Intention of the treatment	None
dosage	List[MedicationKnowledgeIndicationGuidelineDosingGuidelineDosage] | None	Dosage for the medication for the specific guidelines	None
administrationTreatment	CodeableConcept | None	Type of treatment the guideline applies to	None
patientCharacteristic	List[MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristic] | None	Characteristics of the patient that are relevant to the administration guidelines	None

MedicationKnowledgeIndicationGuidelineDosingGuidelineDosage

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeIndicationGuidelineDosingGuidelineDosage

Bases: BackboneElement

Dosage for the medication for the specific guidelines.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 dosage for a medication	None
dosage	List[Dosage] | None	Dosage for the medication for the specific guidelines	None

MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeIndicationGuidelineDosingGuidelinePatientCharacteristic

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	str | None	Unique id for inter-element referencing	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	Categorization of specific characteristic that is relevant to the administration guideline	None
valueCodeableConcept	CodeableConcept | None	The specific characteristic	None
valueQuantity	Quantity | None	The specific characteristic	None
valueRange	Range | None	The specific characteristic	None

MedicationKnowledgeMedicineClassification

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeMedicineClassification

Bases: BackboneElement

Categorization of the medication within a formulary or classification system.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
sourceString	Annotated[str | String, BeforeValidator] | None	The source of the classification	None
sourceUri	Annotated[str | Uri, BeforeValidator] | None	The source of the classification	None
classification	List[CodeableConcept] | None	Specific category assigned to the medication	None

MedicationKnowledgeMonitoringProgram

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeMonitoringProgram

Bases: BackboneElement

The program under which the medication is reviewed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name of the reviewing program	None

MedicationKnowledgeMonograph

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeMonograph

Bases: BackboneElement

Associated documentation about the medication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.medication_knowledge.MedicationKnowledgePackaging

Bases: BackboneElement

Information that only applies to packages (not products).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
cost	List[MedicationKnowledgePackagingCost] | None	Cost of the packaged medication	None
packagedProduct	Reference | None	The packaged medication that is being priced	None

MedicationKnowledgePackagingCost

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgePackagingCost

Bases: BackboneElement

The cost of the packaged medication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
effectiveDate	List[Period] | None	The date range for which the cost is effective	None
type	CodeableConcept | None	The category of the cost information	None
source	Annotated[str | String, BeforeValidator] | None	The source or owner for the price information	None
costMoney	Money | None	The price or category of the cost of the medication	None
costCodeableConcept	CodeableConcept | None	The price or category of the cost of the medication	None

MedicationKnowledgeRegulatory

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeRegulatory

Bases: BackboneElement

Regulatory information about a medication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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[CodeableConcept] | 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.R5.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	str | None	Unique id for inter-element referencing	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

MedicationKnowledgeRegulatorySubstitution

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Specifies if regulation allows for changes in the medication when dispensing	None

MedicationKnowledgeRelatedMedicationKnowledge

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeRelatedMedicationKnowledge

Bases: BackboneElement

Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

MedicationKnowledgeStorageGuideline

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeStorageGuideline

Bases: BackboneElement

Information on how the medication should be stored, for example, refrigeration temperatures and length of stability at a given temperature.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	Reference to additional information	None
note	List[Annotation] | None	Additional storage notes	None
stabilityDuration	Duration | None	Duration remains stable	None
environmentalSetting	List[MedicationKnowledgeStorageGuidelineEnvironmentalSetting] | None	Setting or value of environment for adequate storage	None

MedicationKnowledgeStorageGuidelineEnvironmentalSetting

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_knowledge.MedicationKnowledgeStorageGuidelineEnvironmentalSetting

Bases: BackboneElement

Describes a setting/value on the environment for the adequate storage of the medication and other substances. Environment settings may involve temperature, humidity, or exposure to light.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Categorization of the setting	None
valueQuantity	Quantity | None	Value of the setting	None
valueRange	Range | None	Value of the setting	None
valueCodeableConcept	CodeableConcept | None	Value of the setting	None

MedicationRequest

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
basedOn	List[Reference] | None	A plan or request that is fulfilled in whole or in part by this medication request	None
priorPrescription	Reference | None	Reference to an order/prescription that is being replaced by this MedicationRequest	None
groupIdentifier	Identifier | None	Composite request this is part of	None
status	Annotated[str | Code, BeforeValidator] | None	active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown	None
statusReason	CodeableConcept | None	Reason for current status	None
statusChanged	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the status was changed	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option	None
category	List[CodeableConcept] | None	Grouping or category of medication request	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
doNotPerform	Annotated[bool | Boolean, BeforeValidator] | None	True if patient is to stop taking or not to start taking the medication	None
medication	CodeableReference | None	Medication to be taken	None
subject	Reference | None	Individual or group for whom the medication has been requested	None
informationSource	List[Reference] | None	The person or organization who provided the information about this request, if the source is someone other than the requestor	None
encounter	Reference | None	Encounter created as part of encounter/admission/stay	None
supportingInformation	List[Reference] | None	Information to support fulfilling of the medication	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When request was initially authored	None
requester	Reference | None	Who/What requested the Request	None
reported	Annotated[bool | Boolean, BeforeValidator] | None	Reported rather than primary record	None
performerType	CodeableConcept | None	Desired kind of performer of the medication administration	None
performer	List[Reference] | None	Intended performer of administration	None
device	List[CodeableReference] | None	Intended type of device for the administration	None
recorder	Reference | None	Person who entered the request	None
reason	List[CodeableReference] | None	Reason or indication for ordering or not ordering the medication	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
renderedDosageInstruction	Annotated[str | Markdown, BeforeValidator] | None	Full representation of the dosage instructions	None
effectiveDosePeriod	Period | None	Period over which the medication is to be taken	None
dosageInstruction	List[Dosage] | None	Specific instructions for how the medication should be taken	None
dispenseRequest	MedicationRequestDispenseRequest | None	Medication supply authorization	None
substitution	MedicationRequestSubstitution | None	Any restrictions on medication substitution	None
eventHistory	List[Reference] | None	A list of events of interest in the lifecycle	None

MedicationRequestDispenseRequest

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | UnsignedInt, BeforeValidator] | None	Number of refills authorized	None
quantity	Quantity | None	Amount of medication to supply per dispense	None
expectedSupplyDuration	Duration | None	Number of days supply per dispense	None
dispenser	Reference | None	Intended performer of dispense	None
dispenserInstruction	List[Annotation] | None	Additional information for the dispenser	None
doseAdministrationAid	CodeableConcept | None	Type of adherence packaging to use for the dispense	None

MedicationRequestDispenseRequestInitialFill

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_request.MedicationRequestDispenseRequestInitialFill

Bases: BackboneElement

Indicates the quantity or duration for the first dispense of the medication.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether substitution is allowed or not	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.R5.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 medicationstatement and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationstatement 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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Part of referenced event	None
status	Annotated[str | Code, BeforeValidator] | None	recorded | entered-in-error | draft	None
category	List[CodeableConcept] | None	Type of medication statement	None
medication	CodeableReference | None	What medication was taken	None
subject	Reference | None	Who is/was taking the medication	None
encounter	Reference | None	Encounter associated with MedicationStatement	None
effectiveDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date/time or interval when the medication is/was/will be taken	None
effectivePeriod	Period | None	The date/time or interval when the medication is/was/will be taken	None
effectiveTiming	Timing | None	The date/time or interval when the medication is/was/will be taken	None
dateAsserted	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the usage was asserted?	None
informationSource	List[Reference] | None	Person or organization that provided the information about the taking of this medication	None
derivedFrom	List[Reference] | None	Link to information used to derive the MedicationStatement	None
reason	List[CodeableReference] | None	Reason for why the medication is being/was taken	None
note	List[Annotation] | None	Further information about the usage	None
relatedClinicalInformation	List[Reference] | None	Link to information relevant to the usage of a medication	None
renderedDosageInstruction	Annotated[str | Markdown, BeforeValidator] | None	Full representation of the dosage instructions	None
dosage	List[Dosage] | None	Details of how medication is/was taken or should be taken	None
adherence	MedicationStatementAdherence | None	Indicates whether the medication is or is not being consumed or administered	None

MedicationStatementAdherence

Path: fhircraft.fhir.resources.datatypes.R5.core.medication_statement.MedicationStatementAdherence

Bases: BackboneElement

Indicates whether the medication is or is not being consumed or administered.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 adherence	None
reason	CodeableConcept | None	Details of the reason for the current use of the medication	None

MedicinalProductDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinition

Bases: DomainResource

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use, drug catalogs, to support prescribing, adverse events management etc.).

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	CodeableConcept | None	If this medicine applies to human or veterinary uses	None
version	Annotated[str | String, BeforeValidator] | None	A business identifier relating to a specific version of the product	None
status	CodeableConcept | None	The status within the lifecycle of this product record	None
statusDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date at which the given status became applicable	None
description	Annotated[str | Markdown, BeforeValidator] | None	General description of this product	None
combinedPharmaceuticalDoseForm	CodeableConcept | None	The dose form for a single part product, or combined form of a multiple part product	None
route	List[CodeableConcept] | None	The path by which the product is taken into or makes contact with the body	None
indication	Annotated[str | Markdown, BeforeValidator] | None	Description of indication(s) for this product, used when structured indications are not required	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[CodeableConcept] | None	Whether the Medicinal Product is subject to special measures for regulatory reasons	None
pediatricUseIndicator	CodeableConcept | None	If authorised for use in children	None
classification	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 authorization	None
packagedMedicinalProduct	List[CodeableConcept] | None	Package type for the product	None
comprisedOf	List[Reference] | None	Types of medicinal manufactured items and/or devices that this product consists of, such as tablets, capsule, or syringes	None
ingredient	List[CodeableConcept] | None	The ingredients of this medicinal product - when not detailed in other resources	None
impurity	List[CodeableReference] | None	Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product	None
attachedDocument	List[Reference] | None	Additional documentation about the medicinal product	None
masterFile	List[Reference] | None	A master file for the medicinal product (e.g. Pharmacovigilance System Master File)	None
contact	List[MedicinalProductDefinitionContact] | 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
code	List[Coding] | None	A code that this product is known by, within some formal terminology	None
name	List[MedicinalProductDefinitionName] | None	The product's name, including full name and possibly coded parts	None
crossReference	List[MedicinalProductDefinitionCrossReference] | None	Reference to another product, e.g. for linking authorised to investigational product	None
operation	List[MedicinalProductDefinitionOperation] | None	A manufacturing or administrative process for the medicinal product	None
characteristic	List[MedicinalProductDefinitionCharacteristic] | None	Key product features such as "sugar free", "modified release"	None

MedicinalProductDefinitionCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinitionCharacteristic

Bases: BackboneElement

Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import".

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 expressing the type of characteristic	None
valueCodeableConcept	CodeableConcept | None	A value for the characteristic	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	A value for the characteristic	None
valueQuantity	Quantity | None	A value for the characteristic	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	A value for the characteristic	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	A value for the characteristic	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	A value for the characteristic	None
valueAttachment	Attachment | None	A value for the characteristic	None

MedicinalProductDefinitionContact

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinitionContact

Bases: BackboneElement

A product specific contact, person (in a role), or an organization.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Allows the contact to be classified, for example QPPV, Pharmacovigilance Enquiry Information	None
contact	Reference | None	A product specific contact, person (in a role), or an organization	None

MedicinalProductDefinitionCrossReference

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinitionCrossReference

Bases: BackboneElement

Reference to another product, e.g. for linking authorised to investigational product, or a virtual product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableReference | None	Reference to another product, e.g. for linking authorised to investigational product	None
type	CodeableConcept | None	The type of relationship, for instance branded to generic or virtual to actual product	None

MedicinalProductDefinitionName

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinitionName

Bases: BackboneElement

The product's name, including full name and possibly coded parts.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The full product name	None
type	CodeableConcept | None	Type of product name, such as rINN, BAN, Proprietary, Non-Proprietary	None
part	List[MedicinalProductDefinitionNamePart] | None	Coding words or phrases of the name	None
usage	List[MedicinalProductDefinitionNameUsage] | None	Country and jurisdiction where the name applies	None

MedicinalProductDefinitionNamePart

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinitionNamePart

Bases: BackboneElement

Coding words or phrases of the name.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	A fragment of a product name	None
type	CodeableConcept | None	Identifying type for this part of the name (e.g. strength part)	None

MedicinalProductDefinitionNameUsage

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinitionNameUsage

Bases: BackboneElement

Country and jurisdiction where the name applies, and associated language.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

MedicinalProductDefinitionOperation

Path: fhircraft.fhir.resources.datatypes.R5.core.medicinal_product_definition.MedicinalProductDefinitionOperation

Bases: BackboneElement

A manufacturing or administrative process or step associated with (or performed on) the medicinal product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableReference | None	The type of manufacturing operation e.g. manufacturing itself, re-packaging	None
effectiveDate	Period | None	Date range of applicability	None
organization	List[Reference] | None	The organization responsible for the particular process, e.g. the manufacturer or importer	None
confidentialityIndicator	CodeableConcept | None	Specifies whether this process is considered proprietary or confidential	None

MessageDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	The cannonical URL for a given MessageDefinition	None
identifier	List[Identifier] | None	Business Identifier for a given MessageDefinition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the message definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this message definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this message definition (human friendly)	None
replaces	List[Annotated[str | Canonical, BeforeValidator]] | None	Takes the place of	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the message definition	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	Annotated[str | Markdown, BeforeValidator] | None	Why this message definition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
base	Annotated[str | Canonical, BeforeValidator] | None	Definition this one is based on	None
parent	List[Annotated[str | Canonical, BeforeValidator]] | None	Protocol/workflow this is part of	None
eventCoding	Coding | None	Event code or link to the EventDefinition	None
eventUri	Annotated[str | Uri, BeforeValidator] | None	Event code or link to the EventDefinition	None
category	Annotated[str | Code, BeforeValidator] | None	consequence | currency | notification	None
focus	List[MessageDefinitionFocus] | None	Resource(s) that are the subject of the event	None
responseRequired	Annotated[str | Code, BeforeValidator] | None	always | on-error | never | on-success	None
allowedResponse	List[MessageDefinitionAllowedResponse] | None	Responses to this message	None
graph	Annotated[str | Canonical, BeforeValidator] | None	canonical reference to a GraphDefinition	None

MessageDefinitionAllowedResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Canonical, BeforeValidator] | None	Reference to allowed message definition response	None
situation	Annotated[str | Markdown, BeforeValidator] | None	When should this response be used	None

MessageDefinitionFocus

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Type of resource	None
profile	Annotated[str | Canonical, BeforeValidator] | None	Profile that must be adhered to by focus	None
min	Annotated[int | UnsignedInt, BeforeValidator] | None	Minimum number of focuses of this type	None
max	Annotated[str | String, BeforeValidator] | None	Maximum number of focuses of this type	None

MessageHeader

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Event code or link to EventDefinition	None
eventCanonical	Annotated[str | Canonical, BeforeValidator] | None	Event code or link to EventDefinition	None
destination	List[MessageHeaderDestination] | None	Message destination application(s)	None
sender	Reference | None	Real world sender of the message	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	Annotated[str | Canonical, BeforeValidator] | None	Link to the definition for this message	None

MessageHeaderDestination

Path: fhircraft.fhir.resources.datatypes.R5.core.message_header.MessageHeaderDestination

Bases: BackboneElement

The destination application which the message is intended for.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
endpointUrl	Annotated[str | Url, BeforeValidator] | None	Actual destination address or Endpoint resource	None
endpointReference	Reference | None	Actual destination address or Endpoint resource	None
name	Annotated[str | String, BeforeValidator] | None	Name of system	None
target	Reference | None	Particular delivery destination within the destination	None
receiver	Reference | None	Intended "real-world" recipient for the data	None

MessageHeaderResponse

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Bundle.identifier of original message	None
code	Annotated[str | Code, BeforeValidator] | None	ok | transient-error | fatal-error	None
details	Reference | None	Specific list of hints/warnings/errors	None

MessageHeaderSource

Path: fhircraft.fhir.resources.datatypes.R5.core.message_header.MessageHeaderSource

Bases: BackboneElement

The source application from which this message originated.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
endpointUrl	Annotated[str | Url, BeforeValidator] | None	Actual source address or Endpoint resource	None
endpointReference	Reference | None	Actual source address or Endpoint resource	None
name	Annotated[str | String, BeforeValidator] | None	Name of system	None
software	Annotated[str | String, BeforeValidator] | None	Name of software running the system	None
version	Annotated[str | String, BeforeValidator] | None	Version of software running	None
contact	ContactPoint | None	Human contact for problems	None

MetadataResource

Path: fhircraft.fhir.resources.datatypes.R5.core.metadata_resource.MetadataResource

Bases: CanonicalResource

Common Interface declaration for conformance and knowledge artifact resources.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this {{title}}, represented as an absolute URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the {{title}}	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the {{title}}	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this {{title}} (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this {{title}} (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the {{title}}	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for {{title}} (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this {{title}} is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the {{title}} was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the {{title}} was last reviewed by the publisher	None
effectivePeriod	Period | None	When the {{title}} is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc	None
author	List[ContactDetail] | None	Who authored the {{title}}	None
editor	List[ContactDetail] | None	Who edited the {{title}}	None
reviewer	List[ContactDetail] | None	Who reviewed the {{title}}	None
endorser	List[ContactDetail] | None	Who endorsed the {{title}}	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc	None

MolecularSequence

Path: fhircraft.fhir.resources.datatypes.R5.core.molecular_sequence.MolecularSequence

Bases: DomainResource

Representation of a molecular sequence.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	None
type	Annotated[str | Code, BeforeValidator] | None	aa | dna | rna	None
subject	Reference | None	Subject this sequence is associated too	None
focus	List[Reference] | None	What the molecular sequence is about, when it is not about the subject of record	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
literal	Annotated[str | String, BeforeValidator] | None	Sequence that was observed	None
formatted	List[Attachment] | None	Embedded file or a link (URL) which contains content to represent the sequence	None
relative	List[MolecularSequenceRelative] | None	A sequence defined relative to another sequence	None

MolecularSequenceRelative

Path: fhircraft.fhir.resources.datatypes.R5.core.molecular_sequence.MolecularSequenceRelative

Bases: BackboneElement

A sequence defined relative to another sequence.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
coordinateSystem	CodeableConcept | None	Ways of identifying nucleotides or amino acids within a sequence	None
ordinalPosition	Annotated[int | Integer, BeforeValidator] | None	Indicates the order in which the sequence should be considered when putting multiple 'relative' elements together	None
sequenceRange	Range | None	Indicates the nucleotide range in the composed sequence when multiple 'relative' elements are used together	None
startingSequence	MolecularSequenceRelativeStartingSequence | None	A sequence used as starting sequence	None
edit	List[MolecularSequenceRelativeEdit] | None	Changes in sequence from the starting sequence	None

MolecularSequenceRelativeEdit

Path: fhircraft.fhir.resources.datatypes.R5.core.molecular_sequence.MolecularSequenceRelativeEdit

Bases: BackboneElement

Changes in sequence from the starting sequence.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | Integer, BeforeValidator] | None	Start position of the edit on the starting sequence	None
end	Annotated[int | Integer, BeforeValidator] | None	End position of the edit on the starting sequence	None
replacementSequence	Annotated[str | String, BeforeValidator] | None	Allele that was observed	None
replacedSequence	Annotated[str | String, BeforeValidator] | None	Allele in the starting sequence	None

MolecularSequenceRelativeStartingSequence

Path: fhircraft.fhir.resources.datatypes.R5.core.molecular_sequence.MolecularSequenceRelativeStartingSequence

Bases: BackboneElement

A sequence that is used as a starting sequence to describe variants that are present in a sequence analyzed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
genomeAssembly	CodeableConcept | None	The genome assembly used for starting sequence, e.g. GRCh38	None
chromosome	CodeableConcept | None	Chromosome Identifier	None
sequenceCodeableConcept	CodeableConcept | None	The reference sequence that represents the starting sequence	None
sequenceString	Annotated[str | String, BeforeValidator] | None	The reference sequence that represents the starting sequence	None
sequenceReference	Reference | None	The reference sequence that represents the starting sequence	None
windowStart	Annotated[int | Integer, BeforeValidator] | None	Start position of the window on the starting sequence	None
windowEnd	Annotated[int | Integer, BeforeValidator] | None	End position of the window on the starting sequence	None
orientation	Annotated[str | Code, BeforeValidator] | None	sense | antisense	None
strand	Annotated[str | Code, BeforeValidator] | None	watson | crick	None

NamingSystem

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this naming system, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the naming system (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the naming system	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this naming system (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Title for this naming system (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
kind	Annotated[str | Code, BeforeValidator] | None	codesystem | identifier | root	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
responsible	Annotated[str | String, BeforeValidator] | None	Who maintains system namespace?	None
type	CodeableConcept | None	e.g. driver, provider, patient, bank etc	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the naming system	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
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this naming system is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the NamingSystem was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the NamingSystem was last reviewed by the publisher	None
effectivePeriod	Period | None	When the NamingSystem is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc	None
author	List[ContactDetail] | None	Who authored the CodeSystem	None
editor	List[ContactDetail] | None	Who edited the NamingSystem	None
reviewer	List[ContactDetail] | None	Who reviewed the NamingSystem	None
endorser	List[ContactDetail] | None	Who endorsed the NamingSystem	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc	None
usage	Annotated[str | String, BeforeValidator] | None	How/where is it used	None
uniqueId	List[NamingSystemUniqueId] | None	Unique identifiers used for system	None

NamingSystemUniqueId

Path: fhircraft.fhir.resources.datatypes.R5.core.naming_system.NamingSystemUniqueId

Bases: BackboneElement

Indicates how the system may be identified when referenced in electronic exchange.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	oid | uuid | uri | iri-stem | v2csmnemonic | other	None
value	Annotated[str | String, BeforeValidator] | None	The unique identifier	None
preferred	Annotated[bool | Boolean, BeforeValidator] | None	Is this the id that should be used for this type	None
comment	Annotated[str | String, BeforeValidator] | None	Notes about identifier usage	None
period	Period | None	When is identifier valid?	None
authoritative	Annotated[bool | Boolean, BeforeValidator] | None	Whether the identifier is authoritative	None

NutritionIntake

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_intake.NutritionIntake

Bases: DomainResource

A record of food or fluid that is being consumed by a patient. A NutritionIntake may indicate that the patient may be consuming the food or fluid now or has consumed the food or fluid in the past. 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 or through an app that tracks food or fluids consumed. The consumption information may come from sources such as the patient's memory, from a nutrition label, or from a clinician documenting observed intake.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
instantiatesCanonical	List[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	None
basedOn	List[Reference] | None	Fulfils plan, proposal or order	None
partOf	List[Reference] | None	Part of referenced event	None
status	Annotated[str | Code, BeforeValidator] | None	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown	None
statusReason	List[CodeableConcept] | None	Reason for current status	None
code	CodeableConcept | None	code representing an overall type of nutrition intake	None
subject	Reference | None	Who is/was consuming the food or fluid	None
encounter	Reference | None	Encounter associated with NutritionIntake	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date/time or interval when the food or fluid is/was consumed	None
occurrencePeriod	Period | None	The date/time or interval when the food or fluid is/was consumed	None
recorded	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the intake was recorded	None
reportedBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Person or organization that provided the information about the consumption of this food or fluid	None
reportedReference	Reference | None	Person or organization that provided the information about the consumption of this food or fluid	None
consumedItem	List[NutritionIntakeConsumedItem] | None	What food or fluid product or item was consumed	None
ingredientLabel	List[NutritionIntakeIngredientLabel] | None	Total nutrient for the whole meal, product, serving	None
performer	List[NutritionIntakePerformer] | None	Who was performed in the intake	None
location	Reference | None	Where the intake occurred	None
derivedFrom	List[Reference] | None	Additional supporting information	None
reason	List[CodeableReference] | None	Reason for why the food or fluid is /was consumed	None
note	List[Annotation] | None	Further information about the consumption	None

NutritionIntakeConsumedItem

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_intake.NutritionIntakeConsumedItem

Bases: BackboneElement

What food or fluid product or item was consumed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 food or fluid product	None
nutritionProduct	CodeableReference | None	code that identifies the food or fluid product that was consumed	None
schedule	Timing | None	Scheduled frequency of consumption	None
amount	Quantity | None	Quantity of the specified food	None
rate	Quantity | None	Rate at which enteral feeding was administered	None
notConsumed	Annotated[bool | Boolean, BeforeValidator] | None	Flag to indicate if the food or fluid item was refused or otherwise not consumed	None
notConsumedReason	CodeableConcept | None	Reason food or fluid was not consumed	None

NutritionIntakeIngredientLabel

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_intake.NutritionIntakeIngredientLabel

Bases: BackboneElement

Total nutrient amounts for the whole meal, product, serving, etc.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
nutrient	CodeableReference | None	Total nutrient consumed	None
amount	Quantity | None	Total amount of nutrient consumed	None

NutritionIntakePerformer

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_intake.NutritionIntakePerformer

Bases: BackboneElement

Who performed the intake and how they were involved.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 performer	None
actor	Reference | None	Who performed the intake	None

NutritionOrder

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	None
instantiates	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates protocol or definition	None
basedOn	List[Reference] | None	What this order fulfills	None
groupIdentifier	Identifier | None	Composite Request ID	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
subject	Reference | None	Who requires the diet, formula or nutritional supplement	None
encounter	Reference | None	The encounter associated with this nutrition order	None
supportingInformation	List[Reference] | None	Information to support fulfilling of the nutrition order	None
dateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date and time the nutrition order was requested	None
orderer	Reference | None	Who ordered the diet, formula or nutritional supplement	None
performer	List[CodeableReference] | None	Who is desired to perform the administration of what is being ordered	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
outsideFoodAllowed	Annotated[bool | Boolean, BeforeValidator] | None	Capture when a food item is brought in by the patient and/or family	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

NutritionOrderEnteralFormula

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	CodeableReference | None	Type of enteral or infant formula	None
baseFormulaProductName	Annotated[str | String, BeforeValidator] | None	Product or brand name of the enteral or infant formula	None
deliveryDevice	List[CodeableReference] | None	Intended type of device for the administration	None
additive	List[NutritionOrderEnteralFormulaAdditive] | None	Components to add to the feeding	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	Annotated[str | Markdown, BeforeValidator] | None	Formula feeding instructions expressed as text	None

NutritionOrderEnteralFormulaAdditive

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_order.NutritionOrderEnteralFormulaAdditive

Bases: BackboneElement

Indicates modular components to be provided in addition or mixed with the base formula.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableReference | None	Type of modular component to add to the feeding	None
productName	Annotated[str | String, BeforeValidator] | None	Product or brand name of the modular additive	None
quantity	Quantity | None	Amount of additive to be given or mixed in	None

NutritionOrderEnteralFormulaAdministration

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	NutritionOrderEnteralFormulaAdministrationSchedule | None	Scheduling information for enteral formula products	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

NutritionOrderEnteralFormulaAdministrationSchedule

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_order.NutritionOrderEnteralFormulaAdministrationSchedule

Bases: BackboneElement

Schedule information for an enteral formula.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
timing	List[Timing] | None	Scheduled frequency of enteral formula	None
asNeeded	Annotated[bool | Boolean, BeforeValidator] | None	Take 'as needed'	None
asNeededFor	CodeableConcept | None	Take 'as needed' for x	None

NutritionOrderOralDiet

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_order.NutritionOrderOralDiet

Bases: BackboneElement

Diet given orally in contrast to enteral (tube) feeding.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	NutritionOrderOralDietSchedule | None	Scheduling information for oral diets	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	Annotated[str | String, BeforeValidator] | None	Instructions or additional information about the oral diet	None

NutritionOrderOralDietNutrient

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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

NutritionOrderOralDietSchedule

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_order.NutritionOrderOralDietSchedule

Bases: BackboneElement

Schedule information for an oral diet.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
timing	List[Timing] | None	Scheduled frequency of diet	None
asNeeded	Annotated[bool | Boolean, BeforeValidator] | None	Take 'as needed'	None
asNeededFor	CodeableConcept | None	Take 'as needed' for x	None

NutritionOrderOralDietTexture

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	CodeableReference | None	Type of supplement product requested	None
productName	Annotated[str | String, BeforeValidator] | None	Product or brand name of the nutritional supplement	None
schedule	NutritionOrderSupplementSchedule | None	Scheduling information for supplements	None
quantity	Quantity | None	Amount of the nutritional supplement	None
instruction	Annotated[str | String, BeforeValidator] | None	Instructions or additional information about the oral supplement	None

NutritionOrderSupplementSchedule

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_order.NutritionOrderSupplementSchedule

Bases: BackboneElement

Schedule information for a supplement.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
timing	List[Timing] | None	Scheduled frequency of diet	None
asNeeded	Annotated[bool | Boolean, BeforeValidator] | None	Take 'as needed'	None
asNeededFor	CodeableConcept | None	Take 'as needed' for x	None

NutritionProduct

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_product.NutritionProduct

Bases: DomainResource

A food or supplement that is consumed by patients.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	A code that can identify the detailed nutrients and ingredients in a specific food product	None
status	Annotated[str | Code, BeforeValidator] | None	active | inactive | entered-in-error	None
category	List[CodeableConcept] | None	Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products	None
manufacturer	List[Reference] | None	Manufacturer, representative or officially responsible for the product	None
nutrient	List[NutritionProductNutrient] | None	The product's nutritional information expressed by the nutrients	None
ingredient	List[NutritionProductIngredient] | None	Ingredients contained in this product	None
knownAllergen	List[CodeableReference] | None	Known or suspected allergens that are a part of this product	None
characteristic	List[NutritionProductCharacteristic] | None	Specifies descriptive properties of the nutrition product	None
instance	List[NutritionProductInstance] | None	One or several physical instances or occurrences of the nutrition product	None
note	List[Annotation] | None	Comments made about the product	None

NutritionProductCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_product.NutritionProductCharacteristic

Bases: BackboneElement

Specifies descriptive properties of the nutrition product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	None
valueCodeableConcept	CodeableConcept | None	The value of the characteristic	None
valueString	Annotated[str | String, BeforeValidator] | None	The value of the characteristic	None
valueQuantity	Quantity | None	The value of the characteristic	None
valueBase64Binary	Annotated[str | Base64Binary, BeforeValidator] | None	The value of the characteristic	None
valueAttachment	Attachment | None	The value of the characteristic	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	The value of the characteristic	None

NutritionProductIngredient

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_product.NutritionProductIngredient

Bases: BackboneElement

Ingredients contained in this product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
item	CodeableReference | None	The ingredient contained in the product	None
amount	List[Ratio] | None	The amount of ingredient that is in the product	None

NutritionProductInstance

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_product.NutritionProductInstance

Bases: BackboneElement

Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 amount of items or instances	None
identifier	List[Identifier] | None	The identifier for the physical instance, typically a serial number or manufacturer number	None
name	Annotated[str | String, BeforeValidator] | None	The name for the specific product	None
lotNumber	Annotated[str | String, BeforeValidator] | None	The identification of the batch or lot of the product	None
expiry	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The expiry date or date and time for the product	None
useBy	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date until which the product is expected to be good for consumption	None
biologicalSourceEvent	Identifier | None	An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled	None

NutritionProductNutrient

Path: fhircraft.fhir.resources.datatypes.R5.core.nutrition_product.NutritionProductNutrient

Bases: BackboneElement

The product's nutritional information expressed by the nutrients.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
item	CodeableReference | None	The (relevant) nutrients in the product	None
amount	List[Ratio] | None	The amount of nutrient expressed in one or more units: X per pack / per serving / per dose	None

Observation

Path: fhircraft.fhir.resources.datatypes.R5.core.observation.Observation

Bases: DomainResource

Measurements and simple assertions made about a patient, device or other subject.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
instantiatesCanonical	Annotated[str | Canonical, BeforeValidator] | None	Instantiates FHIR ObservationDefinition	None
instantiatesReference	Reference | None	Instantiates FHIR ObservationDefinition	None
basedOn	List[Reference] | None	Fulfills plan, proposal or order	None
triggeredBy	List[ObservationTriggeredBy] | None	Triggering observation(s)	None
partOf	List[Reference] | None	Part of referenced event	None
status	Annotated[str | Code, BeforeValidator] | None	registered | preliminary | final | amended +	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Clinically relevant time/time-period for observation	None
effectivePeriod	Period | None	Clinically relevant time/time-period for observation	None
effectiveTiming	Timing | None	Clinically relevant time/time-period for observation	None
effectiveInstant	Annotated[datetime | Instant, BeforeValidator] | None	Clinically relevant time/time-period for observation	None
issued	Annotated[datetime | Instant, BeforeValidator] | None	Date/time this version was made available	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	Annotated[str | String, BeforeValidator] | None	Actual result	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Actual result	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Actual result	None
valueRange	Range | None	Actual result	None
valueRatio	Ratio | None	Actual result	None
valueSampledData	SampledData | None	Actual result	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Actual result	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Actual result	None
valuePeriod	Period | None	Actual result	None
valueAttachment	Attachment | None	Actual result	None
valueReference	Reference | 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
bodyStructure	Reference | None	Observed body structure	None
method	CodeableConcept | None	How it was done	None
specimen	Reference | None	Specimen used for this observation	None
device	Reference | None	A reference to the device that generates the measurements or the device settings for the 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 resource from which the observation is made	None
component	List[ObservationComponent] | None	Component results	None

ObservationComponent

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Actual component result	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Actual component result	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Actual component result	None
valueRange	Range | None	Actual component result	None
valueRatio	Ratio | None	Actual component result	None
valueSampledData	SampledData | None	Actual component result	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Actual component result	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Actual component result	None
valuePeriod	Period | None	Actual component result	None
valueAttachment	Attachment | None	Actual component result	None
valueReference	Reference | 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.R5.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	str | None	Unique id for inter-element referencing	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
normalValue	CodeableConcept | None	Normal value, 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	Annotated[str | Markdown, BeforeValidator] | None	Text based reference range in an observation	None

ObservationReferenceRange

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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
normalValue	CodeableConcept | None	Normal value, 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	Annotated[str | Markdown, BeforeValidator] | None	Text based reference range in an observation	None

ObservationTriggeredBy

Path: fhircraft.fhir.resources.datatypes.R5.core.observation.ObservationTriggeredBy

Bases: BackboneElement

Identifies the observation(s) that triggered the performance of this observation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
observation	Reference | None	Triggering observation	None
type	Annotated[str | Code, BeforeValidator] | None	reflex | repeat | re-run	None
reason	Annotated[str | String, BeforeValidator] | None	Reason that the observation was triggered	None

ObservationDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	Logical canonical URL to reference this ObservationDefinition (globally unique)	None
identifier	Identifier | None	Business identifier of the ObservationDefinition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the ObservationDefinition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this ObservationDefinition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this ObservationDefinition (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	If for testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	The name of the individual or organization that published the ObservationDefinition	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the ObservationDefinition	None
useContext	List[UsageContext] | None	Content intends to support these contexts	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for this ObservationDefinition (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this ObservationDefinition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When ObservationDefinition was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	Date on which the asset content was last reviewed by the publisher	None
effectivePeriod	Period | None	The effective date range for the ObservationDefinition	None
derivedFromCanonical	List[Annotated[str | Canonical, BeforeValidator]] | None	Based on FHIR definition of another observation	None
derivedFromUri	List[Annotated[str | Uri, BeforeValidator]] | None	Based on external definition	None
subject	List[CodeableConcept] | None	Type of subject for the defined observation	None
performerType	CodeableConcept | None	Desired kind of performer for such kind of observation	None
category	List[CodeableConcept] | None	General type of observation	None
code	CodeableConcept | None	Type of observation	None
permittedDataType	List[Annotated[str | Code, BeforeValidator]] | None	Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period	None
multipleResultsAllowed	Annotated[bool | Boolean, BeforeValidator] | None	Multiple results allowed for conforming observations	None
bodySite	CodeableConcept | None	Body part to be observed	None
method	CodeableConcept | None	Method used to produce the observation	None
specimen	List[Reference] | None	Kind of specimen used by this type of observation	None
device	List[Reference] | None	Measurement device or model of device	None
preferredReportName	Annotated[str | String, BeforeValidator] | None	The preferred name to be used when reporting the observation results	None
permittedUnit	List[Coding] | None	Unit for quantitative results	None
qualifiedValue	List[ObservationDefinitionQualifiedValue] | None	Set of qualified values for observation results	None
hasMember	List[Reference] | None	Definitions of related resources belonging to this kind of observation group	None
component	List[ObservationDefinitionComponent] | None	Component results	None

ObservationDefinitionComponent

Path: fhircraft.fhir.resources.datatypes.R5.core.observation_definition.ObservationDefinitionComponent

Bases: BackboneElement

Some observations have multiple component observations, expressed as separate code value pairs.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 observation	None
permittedDataType	List[Annotated[str | Code, BeforeValidator]] | None	Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period	None
permittedUnit	List[Coding] | None	Unit for quantitative results	None
qualifiedValue	List[ObservationDefinitionComponentQualifiedValue] | None	Set of qualified values for observation results	None

ObservationDefinitionComponentQualifiedValue

Path: fhircraft.fhir.resources.datatypes.R5.core.observation_definition.ObservationDefinitionComponentQualifiedValue

Bases: BackboneElement

A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableConcept | None	Context qualifier for the set of qualified values	None
appliesTo	List[CodeableConcept] | None	Targetted population for the set of qualified values	None
gender	Annotated[str | Code, BeforeValidator] | None	male | female | other | unknown	None
age	Range | None	Applicable age range for the set of qualified values	None
gestationalAge	Range | None	Applicable gestational age range for the set of qualified values	None
condition	Annotated[str | String, BeforeValidator] | None	Condition associated with the set of qualified values	None
rangeCategory	Annotated[str | Code, BeforeValidator] | None	reference | critical | absolute	None
range	Range | None	The range for continuous or ordinal observations	None
validCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of valid coded values as part of this set of qualified values	None
normalCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of normal coded values as part of this set of qualified values	None
abnormalCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of abnormal coded values as part of this set of qualified values	None
criticalCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of critical coded values as part of this set of qualified values	None

ObservationDefinitionQualifiedValue

Path: fhircraft.fhir.resources.datatypes.R5.core.observation_definition.ObservationDefinitionQualifiedValue

Bases: BackboneElement

A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	CodeableConcept | None	Context qualifier for the set of qualified values	None
appliesTo	List[CodeableConcept] | None	Targetted population for the set of qualified values	None
gender	Annotated[str | Code, BeforeValidator] | None	male | female | other | unknown	None
age	Range | None	Applicable age range for the set of qualified values	None
gestationalAge	Range | None	Applicable gestational age range for the set of qualified values	None
condition	Annotated[str | String, BeforeValidator] | None	Condition associated with the set of qualified values	None
rangeCategory	Annotated[str | Code, BeforeValidator] | None	reference | critical | absolute	None
range	Range | None	The range for continuous or ordinal observations	None
validCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of valid coded values as part of this set of qualified values	None
normalCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of normal coded values as part of this set of qualified values	None
abnormalCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of abnormal coded values as part of this set of qualified values	None
criticalCodedValueSet	Annotated[str | Canonical, BeforeValidator] | None	Value set of critical coded values as part of this set of qualified values	None

OperationDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this operation definition, represented as an absolute URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the implementation guide (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the operation definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this operation definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this operation definition (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
kind	Annotated[str | Code, BeforeValidator] | None	operation | query	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the operation definition	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	Annotated[str | Markdown, BeforeValidator] | None	Why this operation definition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
affectsState	Annotated[bool | Boolean, BeforeValidator] | None	Whether content is changed by the operation	None
code	Annotated[str | Code, BeforeValidator] | None	Recommended name for operation in search url	None
comment	Annotated[str | Markdown, BeforeValidator] | None	Additional information about use	None
base	Annotated[str | Canonical, BeforeValidator] | None	Marks this as a profile of the base	None
resource	List[Annotated[str | Code, BeforeValidator]] | None	Types this operation applies to	None
system	Annotated[bool | Boolean, BeforeValidator] | None	Invoke at the system level?	None
type	Annotated[bool | Boolean, BeforeValidator] | None	Invoke at the type level?	None
instance	Annotated[bool | Boolean, BeforeValidator] | None	Invoke on an instance?	None
inputProfile	Annotated[str | Canonical, BeforeValidator] | None	Validation information for in parameters	None
outputProfile	Annotated[str | Canonical, BeforeValidator] | None	Validation information for out parameters	None
parameter	List[OperationDefinitionParameter] | None	Parameters for the operation/query	None
overload	List[OperationDefinitionOverload] | None	Define overloaded variants for when generating code	None

OperationDefinitionOverload

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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[Annotated[str | String, BeforeValidator]] | None	Name of parameter to include in overload	None
comment	Annotated[str | String, BeforeValidator] | None	Comments to go on overload	None

OperationDefinitionParameter

Path: fhircraft.fhir.resources.datatypes.R5.core.operation_definition.OperationDefinitionParameter

Bases: BackboneElement

The parameters for the operation/query.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Name in Parameters.parameter.name or in URL	None
use	Annotated[str | Code, BeforeValidator] | None	in | out	None
scope	List[Annotated[str | Code, BeforeValidator]] | None	instance | type | system	None
min	Annotated[int | Integer, BeforeValidator] | None	Minimum Cardinality	None
max	Annotated[str | String, BeforeValidator] | None	Maximum Cardinality (a number or *)	None
documentation	Annotated[str | Markdown, BeforeValidator] | None	Description of meaning/use	None
type	Annotated[str | Code, BeforeValidator] | None	What type this parameter has	None
allowedType	List[Annotated[str | Code, BeforeValidator]] | None	Allowed sub-type this parameter can have (if type is abstract)	None
targetProfile	List[Annotated[str | Canonical, BeforeValidator]] | None	If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types	None
searchType	Annotated[str | Code, BeforeValidator] | None	number | date | string | token | reference | composite | quantity | uri | special	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	required | extensible | preferred | example	None
valueSet	Annotated[str | Canonical, BeforeValidator] | None	Source of value set	None

OperationDefinitionParameterReferencedFrom

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Referencing parameter	None
sourceId	Annotated[str | String, BeforeValidator] | None	Element id of reference	None

OperationOutcome

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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

OperationOutcomeIssue

Path: fhircraft.fhir.resources.datatypes.R5.core.operation_outcome.OperationOutcomeIssue

Bases: BackboneElement

An error, warning, or information message that results from a system action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	fatal | error | warning | information | success	None
code	Annotated[str | Code, BeforeValidator] | None	Error or warning code	None
details	CodeableConcept | None	Additional details about the error	None
diagnostics	Annotated[str | String, BeforeValidator] | None	Additional diagnostic information about the issue	None
location	List[Annotated[str | String, BeforeValidator]] | None	Deprecated: Path of element(s) related to issue	None
expression	List[Annotated[str | String, BeforeValidator]] | None	FHIRPath of element(s) related to issue	None

Organization

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether the organization's record is still in active use	None
type	List[CodeableConcept] | None	Kind of organization	None
name	Annotated[str | String, BeforeValidator] | None	Name used for the organization	None
alias	List[Annotated[str | String, BeforeValidator]] | None	A list of alternate names that the organization is known as, or was known as in the past	None
description	Annotated[str | Markdown, BeforeValidator] | None	Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name	None
contact	List[ExtendedContactDetail] | None	Official contact details for the Organization	None
partOf	Reference | None	The organization of which this organization forms a part	None
endpoint	List[Reference] | None	Technical endpoints providing access to services operated for the organization	None
qualification	List[OrganizationQualification] | None	Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care	None

OrganizationQualification

Path: fhircraft.fhir.resources.datatypes.R5.core.organization.OrganizationQualification

Bases: BackboneElement

The official certifications, accreditations, training, designations and licenses that authorize and/or otherwise endorse the provision of care by the organization.

For example, an approval to provide a type of services issued by a certifying body (such as the US Joint Commission) to an organization.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 organization	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

OrganizationAffiliation

Path: fhircraft.fhir.resources.datatypes.R5.core.organization_affiliation.OrganizationAffiliation

Bases: DomainResource

Defines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this organization affiliation record is in active use	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	The 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
contact	List[ExtendedContactDetail] | None	Official 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

PackagedProductDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.packaged_product_definition.PackagedProductDefinition

Bases: DomainResource

A medically related item or items, in a container or package.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 unique identifier for this package as whole - not for the content of the package	None
name	Annotated[str | String, BeforeValidator] | None	A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc	None
type	CodeableConcept | None	A high level category e.g. medicinal product, raw material, shipping container etc	None
packageFor	List[Reference] | None	The product that this is a pack for	None
status	CodeableConcept | None	The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status	None
statusDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date at which the given status became applicable	None
containedItemQuantity	List[Quantity] | None	A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. See also packaging.containedItem.amount (especially the long definition)	None
description	Annotated[str | Markdown, BeforeValidator] | None	Textual description. Note that this is not the name of the package or product	None
legalStatusOfSupply	List[PackagedProductDefinitionLegalStatusOfSupply] | None	The legal status of supply of the packaged item as classified by the regulator	None
marketingStatus	List[MarketingStatus] | None	Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated	None
copackagedIndicator	Annotated[bool | Boolean, BeforeValidator] | None	Identifies if the drug product is supplied with another item such as a diluent or adjuvant	None
manufacturer	List[Reference] | None	Manufacturer of this package type (multiple means these are all possible manufacturers)	None
attachedDocument	List[Reference] | None	Additional information or supporting documentation about the packaged product	None
packaging	PackagedProductDefinitionPackaging | None	A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap	None
characteristic	List[PackagedProductDefinitionCharacteristic] | None	Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"	None

PackagedProductDefinitionCharacteristic

Path: fhircraft.fhir.resources.datatypes.R5.core.packaged_product_definition.PackagedProductDefinitionCharacteristic

Bases: BackboneElement

Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 expressing the type of characteristic	None
valueCodeableConcept	CodeableConcept | None	A value for the characteristic	None
valueQuantity	Quantity | None	A value for the characteristic	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	A value for the characteristic	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	A value for the characteristic	None
valueAttachment	Attachment | None	A value for the characteristic	None

PackagedProductDefinitionLegalStatusOfSupply

Path: fhircraft.fhir.resources.datatypes.R5.core.packaged_product_definition.PackagedProductDefinitionLegalStatusOfSupply

Bases: BackboneElement

The legal status of supply of the packaged item as classified by the regulator.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 actual status of supply. In what situation this package type may be supplied for use	None
jurisdiction	CodeableConcept | None	The place where the legal status of supply applies	None

PackagedProductDefinitionPackaging

Path: fhircraft.fhir.resources.datatypes.R5.core.packaged_product_definition.PackagedProductDefinitionPackaging

Bases: BackboneElement

A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier	None
type	CodeableConcept | None	The physical type of the container of the items	None
componentPart	Annotated[bool | Boolean, BeforeValidator] | None	Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial)	None
quantity	Annotated[int | Integer, BeforeValidator] | None	The quantity of this level of packaging in the package that contains it (with the outermost level being 1)	None
material	List[CodeableConcept] | None	Material type of the package item	None
alternateMaterial	List[CodeableConcept] | None	A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material	None
shelfLifeStorage	List[ProductShelfLife] | None	Shelf Life and storage information	None
manufacturer	List[Reference] | None	Manufacturer of this packaging item (multiple means these are all potential manufacturers)	None
property_	List[PackagedProductDefinitionPackagingProperty] | None	General characteristics of this item	None
containedItem	List[PackagedProductDefinitionPackagingContainedItem] | None	The item(s) within the packaging	None
packaging	List[PackagedProductDefinitionPackaging] | None	Allows containers (and parts of containers) within containers, still as a part of single packaged product	None

PackagedProductDefinitionPackagingContainedItem

Path: fhircraft.fhir.resources.datatypes.R5.core.packaged_product_definition.PackagedProductDefinitionPackagingContainedItem

Bases: BackboneElement

The item(s) within the packaging.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
item	CodeableReference | None	The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package	None
amount	Quantity | None	The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition)	None

PackagedProductDefinitionPackagingProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.packaged_product_definition.PackagedProductDefinitionPackagingProperty

Bases: BackboneElement

General characteristics of this item.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 expressing the type of characteristic	None
valueCodeableConcept	CodeableConcept | None	A value for the characteristic	None
valueQuantity	Quantity | None	A value for the characteristic	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	A value for the characteristic	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	A value for the characteristic	None
valueAttachment	Attachment | None	A value for the characteristic	None

Parameters

Path: fhircraft.fhir.resources.datatypes.R5.core.parameters.Parameters

Bases: Resource

This resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources except as described in the definition of the Parameters resource.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	None
parameter	List[ParametersParameter] | None	Operation Parameter	None

ParametersParameter

Path: fhircraft.fhir.resources.datatypes.R5.core.parameters.ParametersParameter

Bases: BackboneElement

A parameter passed to or received from the operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name from the definition	None
valueBase64Binary	Annotated[str | Base64Binary, BeforeValidator] | None	If parameter is a data type	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	If parameter is a data type	None
valueCanonical	Annotated[str | Canonical, BeforeValidator] | None	If parameter is a data type	None
valueCode	Annotated[str | Code, BeforeValidator] | None	If parameter is a data type	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	If parameter is a data type	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	If parameter is a data type	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	If parameter is a data type	None
valueId	Annotated[str | Id, BeforeValidator] | None	If parameter is a data type	None
valueInstant	Annotated[datetime | Instant, BeforeValidator] | None	If parameter is a data type	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	If parameter is a data type	None
valueInteger64	Annotated[int | Integer64, BeforeValidator] | None	If parameter is a data type	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	If parameter is a data type	None
valueOid	Annotated[str | Oid, BeforeValidator] | None	If parameter is a data type	None
valuePositiveInt	Annotated[int | PositiveInt, BeforeValidator] | None	If parameter is a data type	None
valueString	Annotated[str | String, BeforeValidator] | None	If parameter is a data type	None
valueTime	Annotated[time | Time, BeforeValidator] | None	If parameter is a data type	None
valueUnsignedInt	Annotated[int | UnsignedInt, BeforeValidator] | None	If parameter is a data type	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	If parameter is a data type	None
valueUrl	Annotated[str | Url, BeforeValidator] | None	If parameter is a data type	None
valueUuid	Annotated[str | Uuid, BeforeValidator] | None	If parameter is a data type	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
valueCodeableReference	CodeableReference | 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
valueRatioRange	RatioRange | 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
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
valueAvailability	Availability | None	If parameter is a data type	None
valueExtendedContactDetail	ExtendedContactDetail | 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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this patient's record is in active use	None
name	List[HumanName] | None	A name associated with the patient	None
telecom	List[ContactPoint] | None	A contact detail for the individual	None
gender	Annotated[str | Code, BeforeValidator] | None	male | female | other | unknown	None
birthDate	Annotated[date | str | Date, BeforeValidator] | None	The date of birth for the individual	None
deceasedBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Indicates if the individual is deceased or not	None
deceasedDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Indicates if the individual is deceased or not	None
address	List[Address] | None	An address for the individual	None
maritalStatus	CodeableConcept | None	Marital (civil) status of a patient	None
multipleBirthBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Whether patient is part of a multiple birth	None
multipleBirthInteger	Annotated[int | Integer, BeforeValidator] | None	Whether patient is part of a multiple birth	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 a Patient or RelatedPerson resource that concerns the same actual individual	None

PatientCommunication

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Language preference indicator	None

PatientContact

Path: fhircraft.fhir.resources.datatypes.R5.core.patient.PatientContact

Bases: BackboneElement

A contact party (e.g. guardian, partner, friend) for the patient.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	male | female | other | unknown	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.R5.core.patient.PatientLink

Bases: BackboneElement

Link to a Patient or RelatedPerson resource that concerns the same actual individual.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	replaced-by | replaces | refer | seealso	None

PaymentNotice

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 notice	None
status	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
request	Reference | None	Request reference	None
response	Reference | None	Response reference	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Creation date	None
reporter	Reference | None	Responsible practitioner	None
payment	Reference | None	Payment reference	None
paymentDate	Annotated[date | str | Date, BeforeValidator] | None	Payment or clearing date	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

PaymentReconciliation

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
type	CodeableConcept | None	Category of payment	None
status	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
kind	CodeableConcept | None	Workflow originating payment	None
period	Period | None	Period covered	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Creation date	None
enterer	Reference | None	Who entered the payment	None
issuerType	CodeableConcept | None	Nature of the source	None
paymentIssuer	Reference | None	Party generating payment	None
request	Reference | None	Reference to requesting resource	None
requestor	Reference | None	Responsible practitioner	None
outcome	Annotated[str | Code, BeforeValidator] | None	queued | complete | error | partial	None
disposition	Annotated[str | String, BeforeValidator] | None	Disposition message	None
date	Annotated[date | str | Date, BeforeValidator] | None	When payment issued	None
location	Reference | None	Where payment collected	None
method	CodeableConcept | None	Payment instrument	None
cardBrand	Annotated[str | String, BeforeValidator] | None	Type of card	None
accountNumber	Annotated[str | String, BeforeValidator] | None	Digits for verification	None
expirationDate	Annotated[date | str | Date, BeforeValidator] | None	Expiration year-month	None
processor	Annotated[str | String, BeforeValidator] | None	Processor name	None
referenceNumber	Annotated[str | String, BeforeValidator] | None	Check number or payment reference	None
authorization	Annotated[str | String, BeforeValidator] | None	Authorization number	None
tenderedAmount	Money | None	Amount offered by the issuer	None
returnedAmount	Money | None	Amount returned by the receiver	None
amount	Money | None	Total amount of Payment	None
paymentIdentifier	Identifier | None	Business identifier for the payment	None
allocation	List[PaymentReconciliationAllocation] | None	Settlement particulars	None
formCode	CodeableConcept | None	Printed form identifier	None
processNote	List[PaymentReconciliationProcessNote] | None	Note concerning processing	None

PaymentReconciliationAllocation

Path: fhircraft.fhir.resources.datatypes.R5.core.payment_reconciliation.PaymentReconciliationAllocation

Bases: BackboneElement

Distribution of the payment amount for a previously acknowledged payable.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
target	Reference | None	Subject of the payment	None
targetItemString	Annotated[str | String, BeforeValidator] | None	Sub-element of the subject	None
targetItemIdentifier	Identifier | None	Sub-element of the subject	None
targetItemPositiveInt	Annotated[int | PositiveInt, BeforeValidator] | None	Sub-element of the subject	None
encounter	Reference | None	Applied-to encounter	None
account	Reference | None	Applied-to account	None
type	CodeableConcept | None	Category of payment	None
submitter	Reference | None	Submitter of the request	None
response	Reference | None	Response committing to a payment	None
date	Annotated[date | str | Date, BeforeValidator] | None	Date of commitment to pay	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	display | print | printoper	None
text	Annotated[str | String, BeforeValidator] | None	Note explanatory text	None

Permission

Path: fhircraft.fhir.resources.datatypes.R5.core.permission.Permission

Bases: DomainResource

Permission resource holds access rules for a given data and context.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | entered-in-error | draft | rejected	None
asserter	Reference | None	The person or entity that asserts the permission	None
date	List[Annotated[datetime | date | str | DateTime, BeforeValidator]] | None	The date that permission was asserted	None
validity	Period | None	The period in which the permission is active	None
justification	PermissionJustification | None	The asserted justification for using the data	None
combining	Annotated[str | Code, BeforeValidator] | None	deny-overrides | permit-overrides | ordered-deny-overrides | ordered-permit-overrides | deny-unless-permit | permit-unless-deny	None
rule	List[PermissionRule] | None	Constraints to the Permission	None

PermissionJustification

Path: fhircraft.fhir.resources.datatypes.R5.core.permission.PermissionJustification

Bases: BackboneElement

The asserted justification for using the data.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
basis	List[CodeableConcept] | None	The regulatory grounds upon which this Permission builds	None
evidence	List[Reference] | None	Justifing rational	None

PermissionRule

Path: fhircraft.fhir.resources.datatypes.R5.core.permission.PermissionRule

Bases: BackboneElement

A set of rules.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	deny | permit	None
data	List[PermissionRuleData] | None	The selection criteria to identify data that is within scope of this provision	None
activity	List[PermissionRuleActivity] | None	A description or definition of which activities are allowed to be done on the data	None
limit	List[CodeableConcept] | None	What limits apply to the use of the data	None

PermissionRuleActivity

Path: fhircraft.fhir.resources.datatypes.R5.core.permission.PermissionRuleActivity

Bases: BackboneElement

A description or definition of which activities are allowed to be done on the data.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
actor	List[Reference] | None	Authorized actor(s)	None
action	List[CodeableConcept] | None	Actions controlled by this rule	None
purpose	List[CodeableConcept] | None	The purpose for which the permission is given	None

PermissionRuleData

Path: fhircraft.fhir.resources.datatypes.R5.core.permission.PermissionRuleData

Bases: BackboneElement

A description or definition of which activities are allowed to be done on the data.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
resource	List[PermissionRuleDataResource] | None	Explicit FHIR Resource references	None
security	List[Coding] | None	Security tag code on .meta.security	None
period	List[Period] | None	Timeframe encompasing data create/update	None
expression	Expression | None	Expression identifying the data	None

PermissionRuleDataResource

Path: fhircraft.fhir.resources.datatypes.R5.core.permission.PermissionRuleDataResource

Bases: BackboneElement

Explicit FHIR Resource references.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	instance | related | dependents | authoredby	None
reference	Reference | None	The actual data reference	None

Person

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	This person's record is in active use	None
name	List[HumanName] | None	A name associated with the person	None
telecom	List[ContactPoint] | None	A contact detail for the person	None
gender	Annotated[str | Code, BeforeValidator] | None	male | female | other | unknown	None
birthDate	Annotated[date | str | Date, BeforeValidator] | None	The date on which the person was born	None
deceasedBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Indicates if the individual is deceased or not	None
deceasedDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Indicates if the individual is deceased or not	None
address	List[Address] | None	One or more addresses for the person	None
maritalStatus	CodeableConcept | None	Marital (civil) status of a person	None
photo	List[Attachment] | None	Image of the person	None
communication	List[PersonCommunication] | None	A language which may be used to communicate with the person about his or her health	None
managingOrganization	Reference | None	The organization that is the custodian of the person record	None
link	List[PersonLink] | None	Link to a resource that concerns the same actual person	None

PersonCommunication

Path: fhircraft.fhir.resources.datatypes.R5.core.person.PersonCommunication

Bases: BackboneElement

A language which may be used to communicate with the person about his or her health.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 person about his or her health	None
preferred	Annotated[bool | Boolean, BeforeValidator] | None	Language preference indicator	None

PersonLink

Path: fhircraft.fhir.resources.datatypes.R5.core.person.PersonLink

Bases: BackboneElement

Link to a resource that concerns the same actual person.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	level1 | level2 | level3 | level4	None

PlanDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this plan definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the plan definition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the plan definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this plan definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this plan definition (human friendly)	None
subtitle	Annotated[str | String, BeforeValidator] | None	Subordinate title of the plan definition	None
type	CodeableConcept | None	order-set | clinical-protocol | eca-rule | workflow-definition	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	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
subjectCanonical	Annotated[str | Canonical, BeforeValidator] | None	Type of individual the plan definition is focused on	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the plan definition	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	Annotated[str | Markdown, BeforeValidator] | None	Why this plan definition is defined	None
usage	Annotated[str | Markdown, BeforeValidator] | None	Describes the clinical usage of the plan	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the plan definition was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the plan definition was last reviewed by the publisher	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[Annotated[str | Canonical, BeforeValidator]] | None	Logic used by the plan definition	None
goal	List[PlanDefinitionGoal] | None	What the plan is trying to accomplish	None
actor	List[PlanDefinitionActor] | None	Actors within the plan	None
action	List[PlanDefinitionAction] | None	Action defined by the plan	None
asNeededBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Preconditions for service	None
asNeededCodeableConcept	CodeableConcept | None	Preconditions for service	None

PlanDefinitionAction

Path: fhircraft.fhir.resources.datatypes.R5.core.plan_definition.PlanDefinitionAction

Bases: BackboneElement

An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Unique id for the action in the PlanDefinition	None
prefix	Annotated[str | String, BeforeValidator] | None	User-visible prefix for the action (e.g. 1. or A.)	None
title	Annotated[str | String, BeforeValidator] | None	User-visible title	None
description	Annotated[str | Markdown, BeforeValidator] | None	Brief description of the action	None
textEquivalent	Annotated[str | Markdown, BeforeValidator] | None	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
code	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[Annotated[str | Id, BeforeValidator]] | None	What goals this action supports	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
subjectCanonical	Annotated[str | Canonical, BeforeValidator] | 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[PlanDefinitionActionInput] | None	Input data requirements	None
output	List[PlanDefinitionActionOutput] | None	Output data definition	None
relatedAction	List[PlanDefinitionActionRelatedAction] | None	Relationship to another action	None
timingAge	Age | 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
location	CodeableReference | None	Where it should happen	None
participant	List[PlanDefinitionActionParticipant] | None	Who should participate in the action	None
type	CodeableConcept | None	create | update | remove | fire-event	None
groupingBehavior	Annotated[str | Code, BeforeValidator] | None	visual-group | logical-group | sentence-group	None
selectionBehavior	Annotated[str | Code, BeforeValidator] | None	any | all | all-or-none | exactly-one | at-most-one | one-or-more	None
requiredBehavior	Annotated[str | Code, BeforeValidator] | None	must | could | must-unless-documented	None
precheckBehavior	Annotated[str | Code, BeforeValidator] | None	yes | no	None
cardinalityBehavior	Annotated[str | Code, BeforeValidator] | None	single | multiple	None
definitionCanonical	Annotated[str | Canonical, BeforeValidator] | None	Description of the activity to be performed	None
definitionUri	Annotated[str | Uri, BeforeValidator] | None	Description of the activity to be performed	None
transform	Annotated[str | Canonical, BeforeValidator] | None	Transform to apply the template	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	applicability | start | stop	None
expression	Expression | None	boolean-valued expression	None

PlanDefinitionActionDynamicValue

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The path to the element to be set dynamically	None
expression	Expression | None	An expression that provides the dynamic value for the customization	None

PlanDefinitionActionInput

Path: fhircraft.fhir.resources.datatypes.R5.core.plan_definition.PlanDefinitionActionInput

Bases: BackboneElement

Defines input data requirements for the action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	User-visible title	None
requirement	DataRequirement | None	What data is provided	None
relatedData	Annotated[str | Id, BeforeValidator] | None	What data is provided	None

PlanDefinitionActionOutput

Path: fhircraft.fhir.resources.datatypes.R5.core.plan_definition.PlanDefinitionActionOutput

Bases: BackboneElement

Defines the outputs of the action, if any.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	User-visible title	None
requirement	DataRequirement | None	What data is provided	None
relatedData	Annotated[str | String, BeforeValidator] | None	What data is provided	None

PlanDefinitionActionParticipant

Path: fhircraft.fhir.resources.datatypes.R5.core.plan_definition.PlanDefinitionActionParticipant

Bases: BackboneElement

Indicates who should participate in performing the action described.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	What actor	None
type	Annotated[str | Code, BeforeValidator] | None	careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson	None
typeCanonical	Annotated[str | Canonical, BeforeValidator] | None	Who or what can participate	None
typeReference	Reference | None	Who or what can participate	None
role	CodeableConcept | None	E.g. Nurse, Surgeon, Parent	None
function	CodeableConcept | None	E.g. Author, Reviewer, Witness, etc	None

PlanDefinitionActionRelatedAction

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
targetId	Annotated[str | Id, BeforeValidator] | None	What action is this related to	None
relationship	Annotated[str | Code, BeforeValidator] | None	before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end	None
endRelationship	Annotated[str | Code, BeforeValidator] | None	before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end	None
offsetDuration	Duration | None	time offset for the relationship	None
offsetRange	Range | None	time offset for the relationship	None

PlanDefinitionActor

Path: fhircraft.fhir.resources.datatypes.R5.core.plan_definition.PlanDefinitionActor

Bases: BackboneElement

Actors represent the individuals or groups involved in the execution of the defined set of activities.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	User-visible title	None
description	Annotated[str | Markdown, BeforeValidator] | None	Describes the actor	None
option	List[PlanDefinitionActorOption] | None	Who or what can be this actor	None

PlanDefinitionActorOption

Path: fhircraft.fhir.resources.datatypes.R5.core.plan_definition.PlanDefinitionActorOption

Bases: BackboneElement

The characteristics of the candidates that could serve as the actor.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson	None
typeCanonical	Annotated[str | Canonical, BeforeValidator] | None	Who or what can participate	None
typeReference	Reference | None	Who or what can participate	None
role	CodeableConcept | None	E.g. Nurse, Surgeon, Parent	None

PlanDefinitionGoal

Path: fhircraft.fhir.resources.datatypes.R5.core.plan_definition.PlanDefinitionGoal

Bases: BackboneElement

A goal describes an expected outcome that 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, meeting the acceptance criteria for a test as specified by a quality specification, etc.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.plan_definition.PlanDefinitionGoalTarget

Bases: BackboneElement

Indicates what should be done and within what timeframe.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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
detailString	Annotated[str | String, BeforeValidator] | None	The target value to be achieved	None
detailBoolean	Annotated[bool | Boolean, BeforeValidator] | None	The target value to be achieved	None
detailInteger	Annotated[int | Integer, BeforeValidator] | None	The target value to be achieved	None
detailRatio	Ratio | None	The target value to be achieved	None
due	Duration | None	Reach goal within	None

Practitioner

Path: fhircraft.fhir.resources.datatypes.R5.core.practitioner.Practitioner

Bases: DomainResource

A person who is directly or indirectly involved in the provisioning of healthcare or related services.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this practitioner's record is in active use	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
gender	Annotated[str | Code, BeforeValidator] | None	male | female | other | unknown	None
birthDate	Annotated[date | str | Date, BeforeValidator] | None	The date on which the practitioner was born	None
deceasedBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Indicates if the practitioner is deceased or not	None
deceasedDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Indicates if the practitioner is deceased or not	None
address	List[Address] | None	Address(es) of the practitioner that are not role specific (typically home address)	None
photo	List[Attachment] | None	Image of the person	None
qualification	List[PractitionerQualification] | None	Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care	None
communication	List[PractitionerCommunication] | None	A language which may be used to communicate with the practitioner	None

PractitionerCommunication

Path: fhircraft.fhir.resources.datatypes.R5.core.practitioner.PractitionerCommunication

Bases: BackboneElement

A language which may be used to communicate with the practitioner, often for correspondence/administrative purposes.

The PractitionerRole.communication property should be used for publishing the languages that a practitioner is able to communicate with patients (on a per Organization/Role basis).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 code used to communicate with the practitioner	None
preferred	Annotated[bool | Boolean, BeforeValidator] | None	Language preference indicator	None

PractitionerQualification

Path: fhircraft.fhir.resources.datatypes.R5.core.practitioner.PractitionerQualification

Bases: BackboneElement

The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner.

For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain locality.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.practitioner_role.PractitionerRole

Bases: DomainResource

A specific set of Roles/Locations/specialties/services that a practitioner may perform, or has performed at an organization during a period of time.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 a role/location	None
active	Annotated[bool | Boolean, BeforeValidator] | None	Whether this practitioner role record is in active use	None
period	Period | None	The period during which the practitioner is authorized to perform in these role(s)	None
practitioner	Reference | None	Practitioner that provides 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	Location(s) where the practitioner provides care	None
healthcareService	List[Reference] | None	Healthcare services provided for this role's Organization/Location(s)	None
contact	List[ExtendedContactDetail] | None	Official contact details relating to this PractitionerRole	None
characteristic	List[CodeableConcept] | None	Collection of characteristics (attributes)	None
communication	List[CodeableConcept] | None	A language the practitioner (in this role) can use in patient communication	None
availability	List[Availability] | None	Times the Practitioner is available at this location and/or healthcare service (including exceptions)	None
endpoint	List[Reference] | None	Endpoints for interacting with the practitioner in this role	None

Procedure

Path: fhircraft.fhir.resources.datatypes.R5.core.procedure.Procedure

Bases: DomainResource

An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	None
basedOn	List[Reference] | None	A request for this procedure	None
partOf	List[Reference] | None	Part of referenced event	None
status	Annotated[str | Code, BeforeValidator] | None	preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown	None
statusReason	CodeableConcept | None	Reason for current status	None
category	List[CodeableConcept] | None	Classification of the procedure	None
code	CodeableConcept | None	Identification of the procedure	None
subject	Reference | None	Individual or entity the procedure was performed on	None
focus	Reference | None	Who is the target of the procedure when it is not the subject of record only	None
encounter	Reference | None	The Encounter during which this Procedure was created	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the procedure occurred or is occurring	None
occurrencePeriod	Period | None	When the procedure occurred or is occurring	None
occurrenceString	Annotated[str | String, BeforeValidator] | None	When the procedure occurred or is occurring	None
occurrenceAge	Age | None	When the procedure occurred or is occurring	None
occurrenceRange	Range | None	When the procedure occurred or is occurring	None
occurrenceTiming	Timing | None	When the procedure occurred or is occurring	None
recorded	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the procedure was first captured in the subject's record	None
recorder	Reference | None	Who recorded the procedure	None
reportedBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Reported rather than primary record	None
reportedReference	Reference | None	Reported rather than primary record	None
performer	List[ProcedurePerformer] | None	Who performed the procedure and what they did	None
location	Reference | None	Where the procedure happened	None
reason	List[CodeableReference] | 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[CodeableReference] | None	Complication following 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
used	List[CodeableReference] | None	Items used during procedure	None
supportingInfo	List[Reference] | None	Extra information relevant to the procedure	None

ProcedureFocalDevice

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.procedure.ProcedurePerformer

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 procedure	None
onBehalfOf	Reference | None	Organization the device or practitioner was acting for	None
period	Period | None	When the performer performed the procedure	None

Provenance

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the activity occurred	None
recorded	Annotated[datetime | Instant, BeforeValidator] | None	When the activity was recorded / updated	None
policy	List[Annotated[str | Uri, BeforeValidator]] | None	Policy or plan the activity was defined by	None
location	Reference | None	Where the activity occurred, if relevant	None
authorization	List[CodeableReference] | None	Authorization (purposeOfUse) related to the event	None
activity	CodeableConcept | None	Activity that occurred	None
basedOn	List[Reference] | None	Workflow authorization within which this event occurred	None
patient	Reference | None	The patient is the subject of the data created/updated (.target) by the activity	None
encounter	Reference | None	Encounter within which this event occurred or which the event is tightly associated	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

ProvenanceAgent

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	The agent that participated in the event	None
onBehalfOf	Reference | None	The agent that delegated	None

ProvenanceEntity

Path: fhircraft.fhir.resources.datatypes.R5.core.provenance.ProvenanceEntity

Bases: BackboneElement

An entity used in this activity.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	revision | quotation | source | instantiates | removal	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.R5.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 used the entity.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The agent that participated in the event	None
onBehalfOf	Reference | None	The agent that delegated	None

Questionnaire

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this questionnaire, represented as an absolute URI (globally unique)	None
identifier	List[Identifier] | None	Business identifier for questionnaire	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the questionnaire	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this questionnaire (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this questionnaire (human friendly)	None
derivedFrom	List[Annotated[str | Canonical, BeforeValidator]] | None	Based on Questionnaire	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
subjectType	List[Annotated[str | Code, BeforeValidator]] | None	Resource that can be subject of QuestionnaireResponse	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the questionnaire	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	Annotated[str | Markdown, BeforeValidator] | None	Why this questionnaire is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the questionnaire was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the questionnaire was last reviewed by the publisher	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

QuestionnaireItem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Unique id for item in questionnaire	None
definition	Annotated[str | Uri, BeforeValidator] | None	ElementDefinition - details for the item	None
code	List[Coding] | None	Corresponding concept for this item in a terminology	None
prefix	Annotated[str | String, BeforeValidator] | None	E.g. "1(a)", "2.5.3"	None
text	Annotated[str | String, BeforeValidator] | None	Primary text for the item	None
type	Annotated[str | Code, BeforeValidator] | None	group | display | boolean | decimal | integer | date | dateTime +	None
enableWhen	List[QuestionnaireItemEnableWhen] | None	Only allow data when	None
enableBehavior	Annotated[str | Code, BeforeValidator] | None	all | any	None
disabledDisplay	Annotated[str | Code, BeforeValidator] | None	hidden | protected	None
required	Annotated[bool | Boolean, BeforeValidator] | None	Whether the item must be included in data results	None
repeats	Annotated[bool | Boolean, BeforeValidator] | None	Whether the item may repeat	None
readOnly	Annotated[bool | Boolean, BeforeValidator] | None	Don't allow human editing	None
maxLength	Annotated[int | Integer, BeforeValidator] | None	No more than these many characters	None
answerConstraint	Annotated[str | Code, BeforeValidator] | None	optionsOnly | optionsOrType | optionsOrString	None
answerValueSet	Annotated[str | Canonical, BeforeValidator] | None	ValueSet containing permitted answers	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.R5.core.questionnaire.QuestionnaireItemAnswerOption

Bases: BackboneElement

One of the permitted answers for the question.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | Integer, BeforeValidator] | None	Answer value	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Answer value	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Answer value	None
valueString	Annotated[str | String, BeforeValidator] | None	Answer value	None
valueCoding	Coding | None	Answer value	None
valueReference	Reference | None	Answer value	None
initialSelected	Annotated[bool | Boolean, BeforeValidator] | None	Whether option is selected by default	None

QuestionnaireItemEnableWhen

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The linkId of question that determines whether item is enabled/disabled	None
operator	Annotated[str | Code, BeforeValidator] | None	exists | = | != | > | < | >= | <=	None
answerBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value for question comparison based on operator	None
answerDecimal	Annotated[float | Decimal, BeforeValidator] | None	Value for question comparison based on operator	None
answerInteger	Annotated[int | Integer, BeforeValidator] | None	Value for question comparison based on operator	None
answerDate	Annotated[date | str | Date, BeforeValidator] | None	Value for question comparison based on operator	None
answerDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Value for question comparison based on operator	None
answerTime	Annotated[time | Time, BeforeValidator] | None	Value for question comparison based on operator	None
answerString	Annotated[str | String, BeforeValidator] | None	Value for question comparison based on operator	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Actual value for initializing the question	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Actual value for initializing the question	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Actual value for initializing the question	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Actual value for initializing the question	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Actual value for initializing the question	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Actual value for initializing the question	None
valueString	Annotated[str | String, BeforeValidator] | None	Actual value for initializing the question	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	Actual value for initializing the question	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 set of answers	None
basedOn	List[Reference] | None	Request fulfilled by this QuestionnaireResponse	None
partOf	List[Reference] | None	Part of referenced event	None
questionnaire	Annotated[str | Canonical, BeforeValidator] | None	canonical URL of Questionnaire being answered	None
status	Annotated[str | Code, BeforeValidator] | None	in-progress | completed | amended | entered-in-error | stopped	None
subject	Reference | None	The subject of the questions	None
encounter	Reference | None	Encounter the questionnaire response is part of	None
authored	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date the answers were gathered	None
author	Reference | None	The individual or device that received and recorded the answers	None
source	Reference | None	The individual or device that answered the questions	None
item	List[QuestionnaireResponseItem] | None	Groups and questions	None

QuestionnaireResponseItem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Pointer to specific item from Questionnaire	None
definition	Annotated[str | Uri, BeforeValidator] | None	ElementDefinition - details for the item	None
text	Annotated[str | String, BeforeValidator] | None	Name for group or question text	None
answer	List[QuestionnaireResponseItemAnswer] | None	The response(s) to the question	None
item	List[QuestionnaireResponseItem] | None	Child items of group item	None

QuestionnaireResponseItemAnswer

Path: fhircraft.fhir.resources.datatypes.R5.core.questionnaire_response.QuestionnaireResponseItemAnswer

Bases: BackboneElement

The respondent's answer(s) to the question.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Single-valued answer to the question	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Single-valued answer to the question	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Single-valued answer to the question	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Single-valued answer to the question	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Single-valued answer to the question	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Single-valued answer to the question	None
valueString	Annotated[str | String, BeforeValidator] | None	Single-valued answer to the question	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	Single-valued answer to the question	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	Child items of question	None

RegulatedAuthorization

Path: fhircraft.fhir.resources.datatypes.R5.core.regulated_authorization.RegulatedAuthorization

Bases: DomainResource

Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity that is cited in a guidance, regulation, rule or legislative act. An example is Market Authorization relating to a Medicinal Product.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 authorization, typically assigned by the authorizing body	None
subject	List[Reference] | None	The product type, treatment, facility or activity that is being authorized	None
type	CodeableConcept | None	Overall type of this authorization, for example drug marketing approval, orphan drug designation	None
description	Annotated[str | Markdown, BeforeValidator] | None	General textual supporting information	None
region	List[CodeableConcept] | None	The territory in which the authorization has been granted	None
status	CodeableConcept | None	The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications	None
statusDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date at which the current status was assigned	None
validityPeriod	Period | None	The time period in which the regulatory approval etc. is in effect, e.g. a Marketing Authorization includes the date of authorization and/or expiration date	None
indication	List[CodeableReference] | None	Condition for which the use of the regulated product applies	None
intendedUse	CodeableConcept | None	The intended use of the product, e.g. prevention, treatment	None
basis	List[CodeableConcept] | None	The legal/regulatory framework or reasons under which this authorization is granted	None
holder	Reference | None	The organization that has been granted this authorization, by the regulator	None
regulator	Reference | None	The regulatory authority or authorizing body granting the authorization	None
attachedDocument	List[Reference] | None	Additional information or supporting documentation about the authorization	None
case	RegulatedAuthorizationCase | None	The case or regulatory procedure for granting or amending a regulated authorization. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page)	None

RegulatedAuthorizationCase

Path: fhircraft.fhir.resources.datatypes.R5.core.regulated_authorization.RegulatedAuthorizationCase

Bases: BackboneElement

The case or regulatory procedure for granting or amending a regulated authorization. An authorization is granted in response to submissions/applications by those seeking authorization. A case is the administrative process that deals with the application(s) that relate to this and assesses them. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 by which this case can be referenced	None
type	CodeableConcept | None	The defining type of case	None
status	CodeableConcept | None	The status associated with the case	None
datePeriod	Period | None	Relevant date for this case	None
dateDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Relevant date for this case	None
application	List[RegulatedAuthorizationCase] | None	Applications submitted to obtain a regulated authorization. Steps within the longer running case or procedure	None

RelatedPerson

Path: fhircraft.fhir.resources.datatypes.R5.core.related_person.RelatedPerson

Bases: DomainResource

Information about a person that is involved in a patient's health or 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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this related person's record is in active use	None
patient	Reference | None	The patient this person is related to	None
relationship	List[CodeableConcept] | None	The relationship of the related person to the patient	None
name	List[HumanName] | None	A name associated with the person	None
telecom	List[ContactPoint] | None	A contact detail for the person	None
gender	Annotated[str | Code, BeforeValidator] | None	male | female | other | unknown	None
birthDate	Annotated[date | str | Date, BeforeValidator] | None	The date on which the related person was born	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 the related person about the patient's health	None

RelatedPersonCommunication

Path: fhircraft.fhir.resources.datatypes.R5.core.related_person.RelatedPersonCommunication

Bases: BackboneElement

A language which may be used to communicate with the related person about the patient's health.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 related person about the patient's health	None
preferred	Annotated[bool | Boolean, BeforeValidator] | None	Language preference indicator	None

RequestOrchestration

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestration

Bases: DomainResource

A set 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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	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	Annotated[str | Code, BeforeValidator] | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
code	CodeableConcept | None	What's being requested/ordered	None
subject	Reference | None	Who the request orchestration is about	None
encounter	Reference | None	Created as part of	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the request orchestration was authored	None
author	Reference | None	Device or practitioner that authored the request orchestration	None
reason	List[CodeableReference] | None	Why the request orchestration is needed	None
goal	List[Reference] | None	What goals	None
note	List[Annotation] | None	Additional notes about the response	None
action	List[RequestOrchestrationAction] | None	Proposed actions, if any	None

RequestOrchestrationAction

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestrationAction

Bases: BackboneElement

The actions, if any, produced by the evaluation of the artifact.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Pointer to specific item from the PlanDefinition	None
prefix	Annotated[str | String, BeforeValidator] | None	User-visible prefix for the action (e.g. 1. or A.)	None
title	Annotated[str | String, BeforeValidator] | None	User-visible title	None
description	Annotated[str | Markdown, BeforeValidator] | None	Short description of the action	None
textEquivalent	Annotated[str | Markdown, BeforeValidator] | None	Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	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
goal	List[Reference] | None	What goals	None
condition	List[RequestOrchestrationActionCondition] | None	Whether or not the action is applicable	None
input	List[RequestOrchestrationActionInput] | None	Input data requirements	None
output	List[RequestOrchestrationActionOutput] | None	Output data definition	None
relatedAction	List[RequestOrchestrationActionRelatedAction] | None	Relationship to another action	None
timingDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the action should take place	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
location	CodeableReference | None	Where it should happen	None
participant	List[RequestOrchestrationActionParticipant] | None	Who should perform the action	None
type	CodeableConcept | None	create | update | remove | fire-event	None
groupingBehavior	Annotated[str | Code, BeforeValidator] | None	visual-group | logical-group | sentence-group	None
selectionBehavior	Annotated[str | Code, BeforeValidator] | None	any | all | all-or-none | exactly-one | at-most-one | one-or-more	None
requiredBehavior	Annotated[str | Code, BeforeValidator] | None	must | could | must-unless-documented	None
precheckBehavior	Annotated[str | Code, BeforeValidator] | None	yes | no	None
cardinalityBehavior	Annotated[str | Code, BeforeValidator] | None	single | multiple	None
resource	Reference | None	The target of the action	None
definitionCanonical	Annotated[str | Canonical, BeforeValidator] | None	Description of the activity to be performed	None
definitionUri	Annotated[str | Uri, BeforeValidator] | None	Description of the activity to be performed	None
transform	Annotated[str | Canonical, BeforeValidator] | None	Transform to apply the template	None
dynamicValue	List[RequestOrchestrationActionDynamicValue] | None	Dynamic aspects of the definition	None
action	List[RequestOrchestrationAction] | None	Sub action	None

RequestOrchestrationActionCondition

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestrationActionCondition

Bases: BackboneElement

An expression that describes applicability criteria, or start/stop conditions for the action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	applicability | start | stop	None
expression	Expression | None	boolean-valued expression	None

RequestOrchestrationActionDynamicValue

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestrationActionDynamicValue

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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The path to the element to be set dynamically	None
expression	Expression | None	An expression that provides the dynamic value for the customization	None

RequestOrchestrationActionInput

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestrationActionInput

Bases: BackboneElement

Defines input data requirements for the action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	User-visible title	None
requirement	DataRequirement | None	What data is provided	None
relatedData	Annotated[str | Id, BeforeValidator] | None	What data is provided	None

RequestOrchestrationActionOutput

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestrationActionOutput

Bases: BackboneElement

Defines the outputs of the action, if any.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	User-visible title	None
requirement	DataRequirement | None	What data is provided	None
relatedData	Annotated[str | String, BeforeValidator] | None	What data is provided	None

RequestOrchestrationActionParticipant

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestrationActionParticipant

Bases: BackboneElement

The participant that should perform or be responsible for this action.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson	None
typeCanonical	Annotated[str | Canonical, BeforeValidator] | None	Who or what can participate	None
typeReference	Reference | None	Who or what can participate	None
role	CodeableConcept | None	E.g. Nurse, Surgeon, Parent, etc	None
function	CodeableConcept | None	E.g. Author, Reviewer, Witness, etc	None
actorCanonical	Annotated[str | Canonical, BeforeValidator] | None	Who/what is participating?	None
actorReference	Reference | None	Who/what is participating?	None

RequestOrchestrationActionRelatedAction

Path: fhircraft.fhir.resources.datatypes.R5.core.request_orchestration.RequestOrchestrationActionRelatedAction

Bases: BackboneElement

A relationship to another action such as "before" or "30-60 minutes after start of".

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
targetId	Annotated[str | Id, BeforeValidator] | None	What action this is related to	None
relationship	Annotated[str | Code, BeforeValidator] | None	before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end	None
endRelationship	Annotated[str | Code, BeforeValidator] | None	before | before-start | before-end | concurrent | concurrent-with-start | concurrent-with-end | after | after-start | after-end	None
offsetDuration	Duration | None	time offset for the relationship	None
offsetRange	Range | None	time offset for the relationship	None

Requirements

Path: fhircraft.fhir.resources.datatypes.R5.core.requirements.Requirements

Bases: DomainResource

The Requirements resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this Requirements, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the Requirements (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the Requirements	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this Requirements (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this Requirements (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the requirements	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for Requirements (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this Requirements is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
derivedFrom	List[Annotated[str | Canonical, BeforeValidator]] | None	Other set of Requirements this builds on	None
reference	List[Annotated[str | Url, BeforeValidator]] | None	External artifact (rule/document etc. that) created this set of requirements	None
actor	List[Annotated[str | Canonical, BeforeValidator]] | None	Actor for these requirements	None
statement	List[RequirementsStatement] | None	Actual statement as markdown	None

RequirementsStatement

Path: fhircraft.fhir.resources.datatypes.R5.core.requirements.RequirementsStatement

Bases: BackboneElement

The actual statement of requirement, in markdown format.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
key	Annotated[str | Id, BeforeValidator] | None	Key that identifies this statement	None
label	Annotated[str | String, BeforeValidator] | None	Short Human label for this statement	None
conformance	List[Annotated[str | Code, BeforeValidator]] | None	SHALL | SHOULD | MAY | SHOULD-NOT	None
conditionality	Annotated[bool | Boolean, BeforeValidator] | None	Set to true if requirements statement is conditional	None
requirement	Annotated[str | Markdown, BeforeValidator] | None	The actual requirement	None
derivedFrom	Annotated[str | String, BeforeValidator] | None	Another statement this clarifies/restricts ([url#]key)	None
parent	Annotated[str | String, BeforeValidator] | None	A larger requirement that this requirement helps to refine and enable	None
satisfiedBy	List[Annotated[str | Url, BeforeValidator]] | None	Design artifact that satisfies this requirement	None
reference	List[Annotated[str | Url, BeforeValidator]] | None	External artifact (rule/document etc. that) created this requirement	None
source	List[Reference] | None	Who asked for this statement	None

ResearchStudy

Path: fhircraft.fhir.resources.datatypes.R5.core.research_study.ResearchStudy

Bases: DomainResource

A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this study resource	None
identifier	List[Identifier] | None	Business Identifier for study	None
version	Annotated[str | String, BeforeValidator] | None	The business version for the study record	None
name	Annotated[str | String, BeforeValidator] | None	Name for this study (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Human readable name of the study	None
label	List[ResearchStudyLabel] | None	Additional names for the study	None
protocol	List[Reference] | None	Steps followed in executing study	None
partOf	List[Reference] | None	Part of larger study	None
relatedArtifact	List[RelatedArtifact] | None	References, URLs, and attachments	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date the resource last changed	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	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
studyDesign	List[CodeableConcept] | None	Classifications of the study design characteristics	None
focus	List[CodeableReference] | None	Drugs, devices, etc. under study	None
condition	List[CodeableConcept] | None	Condition being studied	None
keyword	List[CodeableConcept] | None	Used to search for the study	None
region	List[CodeableConcept] | None	Geographic area for the study	None
descriptionSummary	Annotated[str | Markdown, BeforeValidator] | None	Brief text explaining the study	None
description	Annotated[str | Markdown, BeforeValidator] | None	Detailed narrative of the study	None
period	Period | None	When the study began and ended	None
site	List[Reference] | None	Facility where study activities are conducted	None
note	List[Annotation] | None	Comments made about the study	None
classifier	List[CodeableConcept] | None	Classification for the study	None
associatedParty	List[ResearchStudyAssociatedParty] | None	Sponsors, collaborators, and other parties	None
progressStatus	List[ResearchStudyProgressStatus] | None	Status of study with time for that status	None
whyStopped	CodeableConcept | None	accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design	None
recruitment	ResearchStudyRecruitment | None	Target or actual group of participants enrolled in study	None
comparisonGroup	List[ResearchStudyComparisonGroup] | None	Defined path through the study for a subject	None
objective	List[ResearchStudyObjective] | None	A goal for the study	None
outcomeMeasure	List[ResearchStudyOutcomeMeasure] | None	A variable measured during the study	None
result	List[Reference] | None	Link to results generated during the study	None

ResearchStudyAssociatedParty

Path: fhircraft.fhir.resources.datatypes.R5.core.research_study.ResearchStudyAssociatedParty

Bases: BackboneElement

Sponsors, collaborators, and other parties.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name of associated party	None
role	CodeableConcept | None	sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair	None
period	List[Period] | None	When active in the role	None
classifier	List[CodeableConcept] | None	nih | fda | government | nonprofit | academic | industry	None
party	Reference | None	Individual or organization associated with study (use practitionerRole to specify their organisation)	None

ResearchStudyComparisonGroup

Path: fhircraft.fhir.resources.datatypes.R5.core.research_study.ResearchStudyComparisonGroup

Bases: BackboneElement

Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily	None
name	Annotated[str | String, BeforeValidator] | None	Label for study comparisonGroup	None
type	CodeableConcept | None	Categorization of study comparisonGroup	None
description	Annotated[str | Markdown, BeforeValidator] | None	Short explanation of study path	None
intendedExposure	List[Reference] | None	Interventions or exposures in this comparisonGroup or cohort	None
observedGroup	Reference | None	Group of participants who were enrolled in study comparisonGroup	None

ResearchStudyLabel

Path: fhircraft.fhir.resources.datatypes.R5.core.research_study.ResearchStudyLabel

Bases: BackboneElement

Additional names for the study.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid	None
value	Annotated[str | String, BeforeValidator] | None	The name	None

ResearchStudyObjective

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Label for the objective	None
type	CodeableConcept | None	primary | secondary | exploratory	None
description	Annotated[str | Markdown, BeforeValidator] | None	Description of the objective	None

ResearchStudyOutcomeMeasure

Path: fhircraft.fhir.resources.datatypes.R5.core.research_study.ResearchStudyOutcomeMeasure

Bases: BackboneElement

An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Label for the outcome	None
type	List[CodeableConcept] | None	primary | secondary | exploratory	None
description	Annotated[str | Markdown, BeforeValidator] | None	Description of the outcome	None
reference	Reference | None	Structured outcome definition	None

ResearchStudyProgressStatus

Path: fhircraft.fhir.resources.datatypes.R5.core.research_study.ResearchStudyProgressStatus

Bases: BackboneElement

Status of study with time for that status.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
state	CodeableConcept | None	Label for status or state (e.g. recruitment status)	None
actual	Annotated[bool | Boolean, BeforeValidator] | None	Actual if true else anticipated	None
period	Period | None	Date range	None

ResearchStudyRecruitment

Path: fhircraft.fhir.resources.datatypes.R5.core.research_study.ResearchStudyRecruitment

Bases: BackboneElement

Target or actual group of participants enrolled in study.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
targetNumber	Annotated[int | UnsignedInt, BeforeValidator] | None	Estimated total number of participants to be enrolled	None
actualNumber	Annotated[int | UnsignedInt, BeforeValidator] | None	Actual total number of participants enrolled in study	None
eligibility	Reference | None	Inclusion and exclusion criteria	None
actualGroup	Reference | None	Group of participants who were enrolled in study	None

ResearchSubject

Path: fhircraft.fhir.resources.datatypes.R5.core.research_subject.ResearchSubject

Bases: DomainResource

A ResearchSubject is a participant or object which is the recipient of investigative activities in a research study.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
progress	List[ResearchSubjectProgress] | None	Subject status	None
period	Period | None	Start and end of participation	None
study	Reference | None	Study subject is part of	None
subject	Reference | None	Who or what is part of study	None
assignedComparisonGroup	Annotated[str | Id, BeforeValidator] | None	What path should be followed	None
actualComparisonGroup	Annotated[str | Id, BeforeValidator] | None	What path was followed	None
consent	List[Reference] | None	Agreement to participate in study	None

ResearchSubjectProgress

Path: fhircraft.fhir.resources.datatypes.R5.core.research_subject.ResearchSubjectProgress

Bases: BackboneElement

The current state (status) of the subject and resons for status change where appropriate.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	state | milestone	None
subjectState	CodeableConcept | 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
milestone	CodeableConcept | None	SignedUp | Screened | Randomized	None
reason	CodeableConcept | None	State change reason	None
startDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	State change date	None
endDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	State change date	None

Resource

Path: fhircraft.fhir.resources.datatypes.R5.core.resource.Resource

Bases: Base

Base Resource

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	None

RiskAssessment

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	registered | preliminary | final | amended +	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When was assessment made?	None
occurrencePeriod	Period | None	When was assessment made?	None
condition	Reference | None	Condition assessed	None
performer	Reference | None	Who did assessment?	None
reason	List[CodeableReference] | None	Why the assessment was necessary?	None
basis	List[Reference] | None	Information used in assessment	None
prediction	List[RiskAssessmentPrediction] | None	Outcome predicted	None
mitigation	Annotated[str | String, BeforeValidator] | None	How to reduce risk	None
note	List[Annotation] | None	Comments on the risk assessment	None

RiskAssessmentPrediction

Path: fhircraft.fhir.resources.datatypes.R5.core.risk_assessment.RiskAssessmentPrediction

Bases: BackboneElement

Describes the expected outcome for the subject.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[float | Decimal, BeforeValidator] | None	Likelihood of specified outcome	None
probabilityRange	Range | None	Likelihood of specified outcome	None
qualitativeRisk	CodeableConcept | None	Likelihood of specified outcome as a qualitative value	None
relativeRisk	Annotated[float | Decimal, BeforeValidator] | None	Relative likelihood	None
whenPeriod	Period | None	Timeframe or age range	None
whenRange	Range | None	Timeframe or age range	None
rationale	Annotated[str | String, BeforeValidator] | None	Explanation of prediction	None

Schedule

Path: fhircraft.fhir.resources.datatypes.R5.core.schedule.Schedule

Bases: DomainResource

A container for slots of time that may be available for booking appointments.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether this schedule is in active use	None
serviceCategory	List[CodeableConcept] | None	High-level category	None
serviceType	List[CodeableReference] | None	Specific service	None
specialty	List[CodeableConcept] | None	Type of specialty needed	None
name	Annotated[str | String, BeforeValidator] | None	Human-readable label	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	Annotated[str | Markdown, BeforeValidator] | None	Comments on availability	None

SearchParameter

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this search parameter, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the search parameter (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the search parameter	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this search parameter (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this search parameter (human friendly)	None
derivedFrom	Annotated[str | Canonical, BeforeValidator] | None	Original definition for the search parameter	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the search parameter	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	Annotated[str | Markdown, BeforeValidator] | None	Why this search parameter is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
code	Annotated[str | Code, BeforeValidator] | None	Recommended name for parameter in search url	None
base	List[Annotated[str | Code, BeforeValidator]] | None	The resource type(s) this search parameter applies to	None
type	Annotated[str | Code, BeforeValidator] | None	number | date | string | token | reference | composite | quantity | uri | special	None
expression	Annotated[str | String, BeforeValidator] | None	FHIRPath expression that extracts the values	None
processingMode	Annotated[str | Code, BeforeValidator] | None	normal | phonetic | other	None
constraint	Annotated[str | String, BeforeValidator] | None	FHIRPath expression that constraints the usage of this SearchParamete	None
target	List[Annotated[str | Code, BeforeValidator]] | None	Types of resource (if a resource reference)	None
multipleOr	Annotated[bool | Boolean, BeforeValidator] | None	Allow multiple values per parameter (or)	None
multipleAnd	Annotated[bool | Boolean, BeforeValidator] | None	Allow multiple parameters (and)	None
comparator	List[Annotated[str | Code, BeforeValidator]] | None	eq | ne | gt | lt | ge | le | sa | eb | ap	None
modifier	List[Annotated[str | Code, BeforeValidator]] | None	missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate	None
chain	List[Annotated[str | String, BeforeValidator]] | None	Chained names supported	None
component	List[SearchParameterComponent] | None	For Composite resources to define the parts	None

SearchParameterComponent

Path: fhircraft.fhir.resources.datatypes.R5.core.search_parameter.SearchParameterComponent

Bases: BackboneElement

Used to define the parts of a composite search parameter.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Canonical, BeforeValidator] | None	Defines how the part works	None
expression	Annotated[str | String, BeforeValidator] | None	Subexpression relative to main expression	None

ServiceRequest

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | Canonical, BeforeValidator]] | None	Instantiates FHIR protocol or definition	None
instantiatesUri	List[Annotated[str | Uri, BeforeValidator]] | None	Instantiates external protocol or definition	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	Annotated[str | Code, BeforeValidator] | None	draft | active | on-hold | revoked | completed | entered-in-error | unknown	None
intent	Annotated[str | Code, BeforeValidator] | None	proposal | plan | directive | order +	None
category	List[CodeableConcept] | None	Classification of service	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
doNotPerform	Annotated[bool | Boolean, BeforeValidator] | None	True if service/procedure should not be performed	None
code	CodeableReference | None	What is being requested/ordered	None
orderDetail	List[ServiceRequestOrderDetail] | 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
focus	List[Reference] | None	What the service request is about, when it is not about the subject of record	None
encounter	Reference | None	Encounter in which the request was created	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When service should occur	None
occurrencePeriod	Period | None	When service should occur	None
occurrenceTiming	Timing | None	When service should occur	None
asNeededBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Preconditions for service	None
asNeededCodeableConcept	CodeableConcept | None	Preconditions for service	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date request signed	None
requester	Reference | None	Who/what is requesting service	None
performerType	CodeableConcept | None	Performer role	None
performer	List[Reference] | None	Requested performer	None
location	List[CodeableReference] | None	Requested location	None
reason	List[CodeableReference] | None	Explanation/Justification for procedure or service	None
insurance	List[Reference] | None	Associated insurance coverage	None
supportingInfo	List[CodeableReference] | None	Additional clinical information	None
specimen	List[Reference] | None	Procedure Samples	None
bodySite	List[CodeableConcept] | None	Coded location on Body	None
bodyStructure	Reference | None	BodyStructure-based location on the body	None
note	List[Annotation] | None	Comments	None
patientInstruction	List[ServiceRequestPatientInstruction] | None	Patient or consumer-oriented instructions	None
relevantHistory	List[Reference] | None	Request provenance	None

ServiceRequestOrderDetail

Path: fhircraft.fhir.resources.datatypes.R5.core.service_request.ServiceRequestOrderDetail

Bases: BackboneElement

Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
parameterFocus	CodeableReference | None	The context of the order details by reference	None
parameter	List[ServiceRequestOrderDetailParameter] | None	The parameter details for the service being requested	None

ServiceRequestOrderDetailParameter

Path: fhircraft.fhir.resources.datatypes.R5.core.service_request.ServiceRequestOrderDetailParameter

Bases: BackboneElement

The parameter details for the service being requested.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 detail of the order being requested	None
valueQuantity	Quantity | None	The value for the order detail	None
valueRatio	Ratio | None	The value for the order detail	None
valueRange	Range | None	The value for the order detail	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	The value for the order detail	None
valueCodeableConcept	CodeableConcept | None	The value for the order detail	None
valueString	Annotated[str | String, BeforeValidator] | None	The value for the order detail	None
valuePeriod	Period | None	The value for the order detail	None

ServiceRequestPatientInstruction

Path: fhircraft.fhir.resources.datatypes.R5.core.service_request.ServiceRequestPatientInstruction

Bases: BackboneElement

Instructions in terms that are understood by the patient or consumer.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
instructionMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Patient or consumer-oriented instructions	None
instructionReference	Reference | None	Patient or consumer-oriented instructions	None

Slot

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[CodeableReference] | 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 Schedule 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	List[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	Annotated[str | Code, BeforeValidator] | None	busy | free | busy-unavailable | busy-tentative | entered-in-error	None
start	Annotated[datetime | Instant, BeforeValidator] | None	Date/time that the slot is to begin	None
end	Annotated[datetime | Instant, BeforeValidator] | None	Date/time that the slot is to conclude	None
overbooked	Annotated[bool | Boolean, BeforeValidator] | None	This slot has already been overbooked, appointments are unlikely to be accepted for this time	None
comment	Annotated[str | String, BeforeValidator] | None	Comments on the slot to describe any extended information. Such as custom constraints on the slot	None

Specimen

Path: fhircraft.fhir.resources.datatypes.R5.core.specimen.Specimen

Bases: DomainResource

A sample to be used for analysis.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	available | unavailable | unsatisfactory | entered-in-error	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, a biologically-derived product, or a device	None
receivedTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The time when specimen is received by the testing laboratory	None
parent	List[Reference] | None	Specimen from which this specimen originated	None
request	List[Reference] | None	Why the specimen was collected	None
combined	Annotated[str | Code, BeforeValidator] | None	grouped | pooled	None
role	List[CodeableConcept] | None	The role the specimen serves	None
feature	List[SpecimenFeature] | None	The physical feature of a specimen	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

SpecimenCollection

Path: fhircraft.fhir.resources.datatypes.R5.core.specimen.SpecimenCollection

Bases: BackboneElement

Details concerning the specimen collection.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Collection time	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
device	CodeableReference | None	Device used to perform collection	None
procedure	Reference | None	The procedure that collects the specimen	None
bodySite	CodeableReference | 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.R5.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	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
device	Reference | None	Device resource for the container	None
location	Reference | None	Where the container is	None
specimenQuantity	Quantity | None	Quantity of specimen within container	None

SpecimenFeature

Path: fhircraft.fhir.resources.datatypes.R5.core.specimen.SpecimenFeature

Bases: BackboneElement

A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Highlighted feature	None
description	Annotated[str | String, BeforeValidator] | None	Information about the feature	None

SpecimenProcessing

Path: fhircraft.fhir.resources.datatypes.R5.core.specimen.SpecimenProcessing

Bases: BackboneElement

Details concerning processing and processing steps for the specimen.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Textual description of procedure	None
method	CodeableConcept | None	Indicates the treatment step applied to the specimen	None
additive	List[Reference] | None	Material used in the processing step	None
timeDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date and time of specimen processing	None
timePeriod	Period | None	Date and time of specimen processing	None

SpecimenDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.specimen_definition.SpecimenDefinition

Bases: DomainResource

A kind of specimen with associated set of requirements.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	Logical canonical URL to reference this SpecimenDefinition (globally unique)	None
identifier	Identifier | None	Business identifier	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the SpecimenDefinition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this {{title}} (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this SpecimenDefinition (Human friendly)	None
derivedFromCanonical	List[Annotated[str | Canonical, BeforeValidator]] | None	Based on FHIR definition of another SpecimenDefinition	None
derivedFromUri	List[Annotated[str | Uri, BeforeValidator]] | None	Based on external definition	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	If this SpecimenDefinition is not for real usage	None
subjectCodeableConcept	CodeableConcept | None	Type of subject for specimen collection	None
subjectReference	Reference | None	Type of subject for specimen collection	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date status first applied	None
publisher	Annotated[str | String, BeforeValidator] | None	The name of the individual or organization that published the SpecimenDefinition	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the SpecimenDefinition	None
useContext	List[UsageContext] | None	Content intends to support these contexts	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction for this SpecimenDefinition (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this SpecimenDefinition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When SpecimenDefinition was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	The date on which the asset content was last reviewed by the publisher	None
effectivePeriod	Period | None	The effective date range for the SpecimenDefinition	None
typeCollected	CodeableConcept | None	Kind of material to collect	None
patientPreparation	List[CodeableConcept] | None	Patient preparation for collection	None
timeAspect	Annotated[str | String, BeforeValidator] | None	time aspect for collection	None
collection	List[CodeableConcept] | None	Specimen collection procedure	None
typeTested	List[SpecimenDefinitionTypeTested] | None	Specimen in container intended for testing by lab	None

SpecimenDefinitionTypeTested

Path: fhircraft.fhir.resources.datatypes.R5.core.specimen_definition.SpecimenDefinitionTypeTested

Bases: BackboneElement

Specimen conditioned in a container as expected by the testing laboratory.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Primary or secondary specimen	None
type	CodeableConcept | None	Type of intended specimen	None
preference	Annotated[str | Code, BeforeValidator] | None	preferred | alternate	None
container	SpecimenDefinitionTypeTestedContainer | None	The specimen's container	None
requirement	Annotated[str | Markdown, BeforeValidator] | None	Requirements for specimen delivery and special handling	None
retentionTime	Duration | None	The usual time for retaining this kind of specimen	None
singleUse	Annotated[bool | Boolean, BeforeValidator] | None	Specimen for single use only	None
rejectionCriterion	List[CodeableConcept] | None	Criterion specified for specimen rejection	None
handling	List[SpecimenDefinitionTypeTestedHandling] | None	Specimen handling before testing	None
testingDestination	List[CodeableConcept] | None	Where the specimen will be tested	None

SpecimenDefinitionTypeTestedContainer

Path: fhircraft.fhir.resources.datatypes.R5.core.specimen_definition.SpecimenDefinitionTypeTestedContainer

Bases: BackboneElement

The specimen's container.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	The material type used for the container	None
type	CodeableConcept | None	Kind of container associated with the kind of specimen	None
cap	CodeableConcept | None	Color of container cap	None
description	Annotated[str | Markdown, BeforeValidator] | None	The description of the kind of container	None
capacity	Quantity | None	The capacity of this kind of container	None
minimumVolumeQuantity	Quantity | None	Minimum volume	None
minimumVolumeString	Annotated[str | String, BeforeValidator] | None	Minimum volume	None
additive	List[SpecimenDefinitionTypeTestedContainerAdditive] | None	Additive associated with container	None
preparation	Annotated[str | Markdown, BeforeValidator] | None	Special processing applied to the container for this specimen type	None

SpecimenDefinitionTypeTestedContainerAdditive

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Qualifies the interval of temperature	None
temperatureRange	Range | None	Temperature range for these handling instructions	None
maxDuration	Duration | None	Maximum preservation time	None
instruction	Annotated[str | Markdown, BeforeValidator] | None	Preservation instruction	None

StructureDefinition

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this structure definition, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the structure definition	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the structure definition	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this structure definition (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this structure definition (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the structure definition	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	Annotated[str | Markdown, BeforeValidator] | None	Why this structure definition is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
keyword	List[Coding] | None	Assist with indexing and finding	None
fhirVersion	Annotated[str | Code, BeforeValidator] | None	FHIR Version this StructureDefinition targets	None
mapping	List[StructureDefinitionMapping] | None	External specification that the content is mapped to	None
kind	Annotated[str | Code, BeforeValidator] | None	primitive-type | complex-type | resource | logical	None
abstract	Annotated[bool | Boolean, BeforeValidator] | None	Whether the structure is abstract	None
context	List[StructureDefinitionContext] | None	If an extension, where it can be used in instances	None
contextInvariant	List[Annotated[str | String, BeforeValidator]] | None	FHIRPath invariants - when the extension can be used	None
type	Annotated[str | Uri, BeforeValidator] | None	Type defined or constrained by this structure	None
baseDefinition	Annotated[str | Canonical, BeforeValidator] | None	Definition that this type is constrained/specialized from	None
derivation	Annotated[str | Code, BeforeValidator] | None	specialization | constraint - How relates to base definition	None
snapshot	StructureDefinitionSnapshot | None	Snapshot view of the structure	None
differential	StructureDefinitionDifferential | None	Differential view of the structure	None

StructureDefinitionContext

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_definition.StructureDefinitionContext

Bases: BackboneElement

Identifies the types of resource or data type elements to which the extension can be applied. For more guidance on using the 'context' element, see the defining extensions page.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	fhirpath | element | extension	None
expression	Annotated[str | String, BeforeValidator] | None	Where the extension can be used in instances	None

StructureDefinitionDifferential

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.structure_definition.StructureDefinitionMapping

Bases: BackboneElement

An external specification that the content is mapped to.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Internal id when this mapping is used	None
uri	Annotated[str | Uri, BeforeValidator] | None	Identifies what this mapping refers to	None
name	Annotated[str | String, BeforeValidator] | None	Names what this mapping refers to	None
comment	Annotated[str | String, BeforeValidator] | None	Versions, Issues, Scope limitations etc	None

StructureDefinitionSnapshot

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this structure map, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the structure map	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the structure map	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this structure map (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this structure map (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the structure map	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	Annotated[str | Markdown, BeforeValidator] | None	Why this structure map is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
structure	List[StructureMapStructure] | None	Structure Definition used by this map	None
import_	List[Annotated[str | Canonical, BeforeValidator]] | None	Other maps used by this map (canonical URLs)	None
const	List[StructureMapConst] | None	Definition of the constant value used in the map rules	None
group	List[StructureMapGroup] | None	Named sections for reader convenience	None

StructureMapConst

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapConst

Bases: BackboneElement

Definition of a constant value used in the map rules.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Constant name	None
value	Annotated[str | String, BeforeValidator] | None	FHIRPath exression - value of the constant	None

StructureMapGroup

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapGroup

Bases: BackboneElement

Organizes the mapping into managable chunks for human review/ease of maintenance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Human-readable label	None
extends	Annotated[str | Id, BeforeValidator] | None	Another group that this group adds rules to	None
typeMode	Annotated[str | Code, BeforeValidator] | None	types | type-and-types	None
documentation	Annotated[str | String, BeforeValidator] | None	Additional description/explanation for group	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Name for this instance of data	None
type	Annotated[str | String, BeforeValidator] | None	Type for this instance of data	None
mode	Annotated[str | Code, BeforeValidator] | None	source | target	None
documentation	Annotated[str | String, BeforeValidator] | None	Documentation for this instance of data	None

StructureMapGroupRule

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapGroupRule

Bases: BackboneElement

Transform Rule from source to target.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Name of the rule for internal references	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	Annotated[str | String, BeforeValidator] | None	Documentation for this instance of data	None

StructureMapGroupRuleDependent

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapGroupRuleDependent

Bases: BackboneElement

Which other rules to apply in the context of this rule.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Name of a rule or group to apply	None
parameter	List[StructureMapGroupRuleDependentParameter] | None	Parameter to pass to the rule or group	None

StructureMapGroupRuleDependentParameter

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapGroupRuleDependentParameter

Bases: BackboneElement

Parameter to pass to the rule or group.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Parameter value - variable or literal	None
valueString	Annotated[str | String, BeforeValidator] | None	Parameter value - variable or literal	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Parameter value - variable or literal	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Parameter value - variable or literal	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Parameter value - variable or literal	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Parameter value - variable or literal	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Parameter value - variable or literal	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Parameter value - variable or literal	None

StructureMapGroupRuleSource

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapGroupRuleSource

Bases: BackboneElement

Source inputs to the mapping.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Type or variable this rule applies to	None
min	Annotated[int | Integer, BeforeValidator] | None	Specified minimum cardinality	None
max	Annotated[str | String, BeforeValidator] | None	Specified maximum cardinality (number or *)	None
type	Annotated[str | String, BeforeValidator] | None	Rule only applies if source has this type	None
defaultValue	Annotated[str | String, BeforeValidator] | None	Default value if no value exists	None
element	Annotated[str | String, BeforeValidator] | None	Optional field for this source	None
listMode	Annotated[str | Code, BeforeValidator] | None	first | not_first | last | not_last | only_one	None
variable	Annotated[str | Id, BeforeValidator] | None	Named context for field, if a field is specified	None
condition	Annotated[str | String, BeforeValidator] | None	FHIRPath expression - must be true or the rule does not apply	None
check	Annotated[str | String, BeforeValidator] | None	FHIRPath expression - must be true or the mapping engine throws an error instead of completing	None
logMessage	Annotated[str | String, BeforeValidator] | None	Message to put in log if source exists (FHIRPath)	None

StructureMapGroupRuleTarget

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapGroupRuleTarget

Bases: BackboneElement

Content to create because of this mapping rule.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Variable this rule applies to	None
element	Annotated[str | String, BeforeValidator] | None	Field to create in the context	None
variable	Annotated[str | Id, BeforeValidator] | None	Named context for field, if desired, and a field is specified	None
listMode	List[Annotated[str | Code, BeforeValidator]] | None	first | share | last | single	None
listRuleId	Annotated[str | Id, BeforeValidator] | None	Internal rule reference for shared list items	None
transform	Annotated[str | Code, BeforeValidator] | None	create | copy +	None
parameter	List[StructureMapGroupRuleTargetParameter] | None	Parameters to the transform	None

StructureMapGroupRuleTargetParameter

Path: fhircraft.fhir.resources.datatypes.R5.core.structure_map.StructureMapGroupRuleTargetParameter

Bases: BackboneElement

Parameters to the transform.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Id, BeforeValidator] | None	Parameter value - variable or literal	None
valueString	Annotated[str | String, BeforeValidator] | None	Parameter value - variable or literal	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Parameter value - variable or literal	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Parameter value - variable or literal	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Parameter value - variable or literal	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Parameter value - variable or literal	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Parameter value - variable or literal	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Parameter value - variable or literal	None

StructureMapStructure

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Canonical, BeforeValidator] | None	canonical reference to structure definition	None
mode	Annotated[str | Code, BeforeValidator] | None	source | queried | target | produced	None
alias	Annotated[str | String, BeforeValidator] | None	Name for type in this map	None
documentation	Annotated[str | String, BeforeValidator] | None	Documentation on use of structure	None

Subscription

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription.Subscription

Bases: DomainResource

The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 identifiers (business identifier)	None
name	Annotated[str | String, BeforeValidator] | None	Human readable name for this subscription	None
status	Annotated[str | Code, BeforeValidator] | None	requested | active | error | off | entered-in-error	None
topic	Annotated[str | Canonical, BeforeValidator] | None	Reference to the subscription topic being subscribed to	None
contact	List[ContactPoint] | None	Contact details for source (e.g. troubleshooting)	None
end	Annotated[datetime | Instant, BeforeValidator] | None	When to automatically delete the subscription	None
managingEntity	Reference | None	Entity responsible for Subscription changes	None
reason	Annotated[str | String, BeforeValidator] | None	Description of why this subscription was created	None
filterBy	List[SubscriptionFilterBy] | None	Criteria for narrowing the subscription topic stream	None
channelType	Coding | None	Channel type for notifications	None
endpoint	Annotated[str | Url, BeforeValidator] | None	Where the channel points to	None
parameter	List[SubscriptionParameter] | None	Channel type	None
heartbeatPeriod	Annotated[int | UnsignedInt, BeforeValidator] | None	Interval in seconds to send 'heartbeat' notification	None
timeout	Annotated[int | UnsignedInt, BeforeValidator] | None	Timeout in seconds to attempt notification delivery	None
contentType	Annotated[str | Code, BeforeValidator] | None	MIME type to send, or omit for no payload	None
content	Annotated[str | Code, BeforeValidator] | None	empty | id-only | full-resource	None
maxCount	Annotated[int | PositiveInt, BeforeValidator] | None	Maximum number of events that can be combined in a single notification	None

SubscriptionFilterBy

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription.SubscriptionFilterBy

Bases: BackboneElement

The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
resourceType	Annotated[str | String, BeforeValidator] | None	Allowed Resource (reference to definition) for this Subscription filter	None
filterParameter	Annotated[str | String, BeforeValidator] | None	Filter label defined in SubscriptionTopic	None
comparator	Annotated[str | Code, BeforeValidator] | None	eq | ne | gt | lt | ge | le | sa | eb | ap	None
modifier	Annotated[str | Code, BeforeValidator] | None	missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate	None
value	Annotated[str | String, BeforeValidator] | None	Literal value or resource path	None

SubscriptionParameter

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription.SubscriptionParameter

Bases: BackboneElement

Channel-dependent information to send as part of the notification (e.g., HTTP Headers).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name (key) of the parameter	None
value	Annotated[str | String, BeforeValidator] | None	Value of the parameter to use or pass through	None

SubscriptionStatus

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_status.SubscriptionStatus

Bases: DomainResource

The SubscriptionStatus resource describes the state of a Subscription during notifications. It is not persisted.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	requested | active | error | off | entered-in-error	None
type	Annotated[str | Code, BeforeValidator] | None	handshake | heartbeat | event-notification | query-status | query-event	None
eventsSinceSubscriptionStart	Annotated[int | Integer64, BeforeValidator] | None	Events since the Subscription was created	None
notificationEvent	List[SubscriptionStatusNotificationEvent] | None	Detailed information about any events relevant to this notification	None
subscription	Reference | None	Reference to the Subscription responsible for this notification	None
topic	Annotated[str | Canonical, BeforeValidator] | None	Reference to the SubscriptionTopic this notification relates to	None
error	List[CodeableConcept] | None	List of errors on the subscription	None

SubscriptionStatusNotificationEvent

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_status.SubscriptionStatusNotificationEvent

Bases: BackboneElement

Detailed information about events relevant to this subscription notification.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
eventNumber	Annotated[int | Integer64, BeforeValidator] | None	Sequencing index of this event	None
timestamp	Annotated[datetime | Instant, BeforeValidator] | None	The instant this event occurred	None
focus	Reference | None	Reference to the primary resource or information of this event	None
additionalContext	List[Reference] | None	References related to the focus resource and/or context of this event	None

SubscriptionTopic

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_topic.SubscriptionTopic

Bases: DomainResource

Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this subscription topic, represented as an absolute URI (globally unique)	None
identifier	List[Identifier] | None	Business identifier for subscription topic	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the subscription topic	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this subscription topic (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this subscription topic (human friendly)	None
derivedFrom	List[Annotated[str | Canonical, BeforeValidator]] | None	Based on FHIR protocol or definition	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	If for testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date status first applied	None
publisher	Annotated[str | String, BeforeValidator] | None	The name of the individual or organization that published the SubscriptionTopic	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the SubscriptionTopic	None
useContext	List[UsageContext] | None	Content intends to support these contexts	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction of the SubscriptionTopic (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this SubscriptionTopic is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When SubscriptionTopic is/was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	Date the Subscription Topic was last reviewed by the publisher	None
effectivePeriod	Period | None	The effective date range for the SubscriptionTopic	None
resourceTrigger	List[SubscriptionTopicResourceTrigger] | None	Definition of a resource-based trigger for the subscription topic	None
eventTrigger	List[SubscriptionTopicEventTrigger] | None	Event definitions the SubscriptionTopic	None
canFilterBy	List[SubscriptionTopicCanFilterBy] | None	Properties by which a Subscription can filter notifications from the SubscriptionTopic	None
notificationShape	List[SubscriptionTopicNotificationShape] | None	Properties for describing the shape of notifications generated by this topic	None

SubscriptionTopicCanFilterBy

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_topic.SubscriptionTopicCanFilterBy

Bases: BackboneElement

List of properties by which Subscriptions on the SubscriptionTopic can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Description of this filter parameter	None
resource	Annotated[str | Uri, BeforeValidator] | None	URL of the triggering Resource that this filter applies to	None
filterParameter	Annotated[str | String, BeforeValidator] | None	Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter	None
filterDefinition	Annotated[str | Uri, BeforeValidator] | None	canonical URL for a filterParameter definition	None
comparator	List[Annotated[str | Code, BeforeValidator]] | None	eq | ne | gt | lt | ge | le | sa | eb | ap	None
modifier	List[Annotated[str | Code, BeforeValidator]] | None	missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate	None

SubscriptionTopicEventTrigger

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_topic.SubscriptionTopicEventTrigger

Bases: BackboneElement

Event definition which can be used to trigger the SubscriptionTopic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Text representation of the event trigger	None
event	CodeableConcept | None	Event which can trigger a notification from the SubscriptionTopic	None
resource	Annotated[str | Uri, BeforeValidator] | None	Data Type or Resource (reference to definition) for this trigger definition	None

SubscriptionTopicNotificationShape

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_topic.SubscriptionTopicNotificationShape

Bases: BackboneElement

List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
resource	Annotated[str | Uri, BeforeValidator] | None	URL of the Resource that is the focus (main) resource in a notification shape	None
include	List[Annotated[str | String, BeforeValidator]] | None	Include directives, rooted in the resource for this shape	None
revInclude	List[Annotated[str | String, BeforeValidator]] | None	Reverse include directives, rooted in the resource for this shape	None

SubscriptionTopicResourceTrigger

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_topic.SubscriptionTopicResourceTrigger

Bases: BackboneElement

A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Text representation of the resource trigger	None
resource	Annotated[str | Uri, BeforeValidator] | None	Data Type or Resource (reference to definition) for this trigger definition	None
supportedInteraction	List[Annotated[str | Code, BeforeValidator]] | None	create | update | delete	None
queryCriteria	SubscriptionTopicResourceTriggerQueryCriteria | None	Query based trigger rule	None
fhirPathCriteria	Annotated[str | String, BeforeValidator] | None	FHIRPath based trigger rule	None

SubscriptionTopicResourceTriggerQueryCriteria

Path: fhircraft.fhir.resources.datatypes.R5.core.subscription_topic.SubscriptionTopicResourceTriggerQueryCriteria

Bases: BackboneElement

The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
previous	Annotated[str | String, BeforeValidator] | None	Rule applied to previous resource state	None
resultForCreate	Annotated[str | Code, BeforeValidator] | None	test-passes | test-fails	None
current	Annotated[str | String, BeforeValidator] | None	Rule applied to current resource state	None
resultForDelete	Annotated[str | Code, BeforeValidator] | None	test-passes | test-fails	None
requireBoth	Annotated[bool | Boolean, BeforeValidator] | None	Both must be true flag	None

Substance

Path: fhircraft.fhir.resources.datatypes.R5.core.substance.Substance

Bases: DomainResource

A homogeneous material with a definite composition.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
instance	Annotated[bool | Boolean, BeforeValidator] | None	Is this an instance of a substance or a kind of one	None
status	Annotated[str | Code, BeforeValidator] | None	active | inactive | entered-in-error	None
category	List[CodeableConcept] | None	What class/type of substance this is	None
code	CodeableReference | None	What substance this is	None
description	Annotated[str | Markdown, BeforeValidator] | None	Textual description of the substance, comments	None
expiry	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When no longer valid to use	None
quantity	Quantity | None	Amount of substance in the package	None
ingredient	List[SubstanceIngredient] | None	Composition information about the substance	None

SubstanceIngredient

Path: fhircraft.fhir.resources.datatypes.R5.core.substance.SubstanceIngredient

Bases: BackboneElement

A substance can be composed of other substances.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

SubstanceDefinition

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinition

Bases: DomainResource

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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 by which this substance is known	None
version	Annotated[str | String, BeforeValidator] | None	A business level version identifier of the substance	None
status	CodeableConcept | None	Status of substance within the catalogue e.g. active, retired	None
classification	List[CodeableConcept] | None	A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity	None
domain	CodeableConcept | None	If the substance applies to human or veterinary use	None
grade	List[CodeableConcept] | None	The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)	None
description	Annotated[str | Markdown, BeforeValidator] | None	Textual description of the substance	None
informationSource	List[Reference] | None	Supporting literature	None
note	List[Annotation] | None	Textual comment about the substance's catalogue or registry record	None
manufacturer	List[Reference] | None	The entity that creates, makes, produces or fabricates the substance	None
supplier	List[Reference] | None	An entity that is the source for the substance. It may be different from the manufacturer	None
moiety	List[SubstanceDefinitionMoiety] | None	Moiety, for structural modifications	None
characterization	List[SubstanceDefinitionCharacterization] | None	General specifications for this substance	None
property_	List[SubstanceDefinitionProperty] | None	General specifications for this substance	None
referenceInformation	Reference | None	General information detailing this substance	None
molecularWeight	List[SubstanceDefinitionMolecularWeight] | None	The average mass of a molecule of a compound	None
structure	SubstanceDefinitionStructure | None	Structural information	None
code	List[SubstanceDefinitionCode] | None	Codes associated with the substance	None
name	List[SubstanceDefinitionName] | None	Names applicable to this substance	None
relationship	List[SubstanceDefinitionRelationship] | None	A link between this substance and another	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	SubstanceDefinitionSourceMaterial | None	Material or taxonomic/anatomical source	None

SubstanceDefinitionCharacterization

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionCharacterization

Bases: BackboneElement

General specifications for this substance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
technique	CodeableConcept | None	The method used to find the characterization e.g. HPLC	None
form	CodeableConcept | None	Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form	None
description	Annotated[str | Markdown, BeforeValidator] | None	The description or justification in support of the interpretation of the data file	None
file	List[Attachment] | None	The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis	None

SubstanceDefinitionCode

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionCode

Bases: BackboneElement

Codes associated with the substance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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, for example 'provisional', 'approved'	None
statusDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date at which the code status was changed	None
note	List[Annotation] | None	Any comment can be provided in this field	None
source	List[Reference] | None	Supporting literature	None

SubstanceDefinitionMoiety

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionMoiety

Bases: BackboneElement

Moiety, for structural modifications.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Textual name for this moiety substance	None
stereochemistry	CodeableConcept | None	Stereochemistry type	None
opticalActivity	CodeableConcept | None	Optical activity type	None
molecularFormula	Annotated[str | String, BeforeValidator] | None	Molecular formula for this moiety (e.g. with the Hill system)	None
amountQuantity	Quantity | None	Quantitative value for this moiety	None
amountString	Annotated[str | String, BeforeValidator] | None	Quantitative value for this moiety	None
measurementType	CodeableConcept | None	The measurement type of the quantitative value	None

SubstanceDefinitionMolecularWeight

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionMolecularWeight

Bases: BackboneElement

The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 weight was determined	None
type	CodeableConcept | None	Type of molecular weight e.g. exact, average, weight average	None
amount	Quantity | None	Used to capture quantitative values for a variety of elements	None

SubstanceDefinitionName

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionName

Bases: BackboneElement

Names applicable to this substance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The actual name	None
type	CodeableConcept | None	Name type e.g. 'systematic', 'scientific, 'brand'	None
status	CodeableConcept | None	The status of the name e.g. 'current', 'proposed'	None
preferred	Annotated[bool | Boolean, BeforeValidator] | None	If this is the preferred name for this substance	None
language	List[CodeableConcept] | None	Human language that the name is written in	None
domain	List[CodeableConcept] | None	The use context of this name e.g. as an active ingredient or as a food colour additive	None
jurisdiction	List[CodeableConcept] | None	The jurisdiction where this name applies	None
synonym	List[SubstanceDefinitionName] | None	A synonym of this particular name, by which the substance is also known	None
translation	List[SubstanceDefinitionName] | None	A translation for this name into another human language	None
official	List[SubstanceDefinitionNameOfficial] | None	Details of the official nature of this name	None
source	List[Reference] | None	Supporting literature	None

SubstanceDefinitionNameOfficial

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionNameOfficial

Bases: BackboneElement

Details of the official nature of this name.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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, for example 'draft', 'active'	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date of official name change	None

SubstanceDefinitionProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionProperty

Bases: BackboneElement

General specifications for this substance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 expressing the type of property	None
valueCodeableConcept	CodeableConcept | None	A value for the property	None
valueQuantity	Quantity | None	A value for the property	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	A value for the property	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	A value for the property	None
valueAttachment	Attachment | None	A value for the property	None

SubstanceDefinitionRelationship

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionRelationship

Bases: BackboneElement

A link between this substance and another, with details of the relationship.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
substanceDefinitionReference	Reference | None	A pointer to another substance, as a resource or a representational code	None
substanceDefinitionCodeableConcept	CodeableConcept | None	A pointer to another substance, as a resource or a representational code	None
type	CodeableConcept | None	For example "salt to parent", "active moiety"	None
isDefining	Annotated[bool | Boolean, BeforeValidator] | None	For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships	None
amountQuantity	Quantity | None	A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other	None
amountRatio	Ratio | None	A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other	None
amountString	Annotated[str | String, BeforeValidator] | None	A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other	None
ratioHighLimitAmount	Ratio | None	For use when the numeric has an uncertain range	None
comparator	CodeableConcept | None	An operator for the amount, for example "average", "approximately", "less than"	None
source	List[Reference] | None	Supporting literature	None

SubstanceDefinitionSourceMaterial

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionSourceMaterial

Bases: BackboneElement

Material or taxonomic/anatomical source for the substance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Classification of the origin of the raw material. e.g. cat hair is an Animal source type	None
genus	CodeableConcept | None	The genus of an organism e.g. the Latin epithet of the plant/animal scientific name	None
species	CodeableConcept | None	The species of an organism e.g. the Latin epithet of the species of the plant/animal	None
part	CodeableConcept | None	An anatomical origin of the source material within an organism	None
countryOfOrigin	List[CodeableConcept] | None	The country or countries where the material is harvested	None

SubstanceDefinitionStructure

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionStructure

Bases: BackboneElement

Structural information.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	An expression which states the number and type of atoms present in a molecule of a substance	None
molecularFormulaByMoiety	Annotated[str | String, BeforeValidator] | None	Specified per moiety according to the Hill system	None
molecularWeight	SubstanceDefinitionStructureMolecularWeight | None	The molecular weight or weight range	None
technique	List[CodeableConcept] | None	The method used to find the structure e.g. X-ray, NMR	None
sourceDocument	List[Reference] | None	Source of information for the structure	None
representation	List[SubstanceDefinitionStructureRepresentation] | None	A depiction of the structure of the substance	None

SubstanceDefinitionStructureMolecularWeight

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionStructureMolecularWeight

Bases: BackboneElement

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 weight was determined	None
type	CodeableConcept | None	Type of molecular weight e.g. exact, average, weight average	None
amount	Quantity | None	Used to capture quantitative values for a variety of elements	None

SubstanceDefinitionStructureRepresentation

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_definition.SubstanceDefinitionStructureRepresentation

Bases: BackboneElement

A depiction of the structure of the substance.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 kind of structural representation (e.g. full, partial)	None
representation	Annotated[str | String, BeforeValidator] | None	The structural representation as a text string in a standard format	None
format	CodeableConcept | None	The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)	None
document	Reference | None	An attachment with the structural representation e.g. a structure graphic or AnIML file	None

SubstanceNucleicAcid

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[int | Integer, BeforeValidator] | 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
areaOfHybridisation	Annotated[str | String, BeforeValidator] | 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
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

SubstanceNucleicAcidSubunit

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | Integer, BeforeValidator] | 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
sequence	Annotated[str | String, BeforeValidator] | 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
length	Annotated[int | Integer, BeforeValidator] | None	The length of the sequence shall be captured	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.R5.core.substance_nucleic_acid.SubstanceNucleicAcidSubunitLinkage

Bases: BackboneElement

The linkages between sugar residues will also be captured.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | 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
identifier	Identifier | None	Each linkage will be registered as a fragment and have an ID	None
name	Annotated[str | String, BeforeValidator] | 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
residueSite	Annotated[str | String, BeforeValidator] | None	Residues shall be captured as described in 5.3.6.8.3	None

SubstanceNucleicAcidSubunitSugar

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_nucleic_acid.SubstanceNucleicAcidSubunitSugar

Bases: BackboneElement

5.3.6.8.1 Sugar ID (Mandatory).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The name of the sugar or sugar-like component that make up the nucleotide	None
residueSite	Annotated[str | String, BeforeValidator] | 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

SubstancePolymer

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_polymer.SubstancePolymer

Bases: DomainResource

Properties of a substance specific to it being a polymer.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	A business idenfier for this polymer, but typically this is handled by a SubstanceDefinition identifier	None
class_	CodeableConcept | None	Overall type of the polymer	None
geometry	CodeableConcept | None	Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic	None
copolymerConnectivity	List[CodeableConcept] | None	Descrtibes the copolymer sequence type (polymer connectivity)	None
modification	Annotated[str | String, BeforeValidator] | None	Todo - this is intended to connect to a repeating full modification structure, also used by Protein and Nucleic Acid . string is just a placeholder	None
monomerSet	List[SubstancePolymerMonomerSet] | None	Todo	None
repeat	List[SubstancePolymerRepeat] | None	Specifies and quantifies the repeated units and their configuration	None

SubstancePolymerMonomerSet

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_polymer.SubstancePolymerMonomerSet

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio	None
startingMaterial	List[SubstancePolymerMonomerSetStartingMaterial] | None	The starting materials - monomer(s) used in the synthesis of the polymer	None

SubstancePolymerMonomerSetStartingMaterial

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_polymer.SubstancePolymerMonomerSetStartingMaterial

Bases: BackboneElement

The starting materials - monomer(s) used in the synthesis of the polymer.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 type of substance for this starting material	None
category	CodeableConcept | None	Substance high level category, e.g. chemical substance	None
isDefining	Annotated[bool | Boolean, BeforeValidator] | None	Used to specify whether the attribute described is a defining element for the unique identification of the polymer	None
amount	Quantity | None	A percentage	None

SubstancePolymerRepeat

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_polymer.SubstancePolymerRepeat

Bases: BackboneElement

Specifies and quantifies the repeated units and their configuration.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
averageMolecularFormula	Annotated[str | String, BeforeValidator] | None	A representation of an (average) molecular formula from a polymer	None
repeatUnitAmountType	CodeableConcept | None	How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average)	None
repeatUnit	List[SubstancePolymerRepeatRepeatUnit] | None	An SRU - Structural Repeat Unit	None

SubstancePolymerRepeatRepeatUnit

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_polymer.SubstancePolymerRepeatRepeatUnit

Bases: BackboneElement

An SRU - Structural Repeat Unit.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
unit	Annotated[str | String, BeforeValidator] | None	Structural repeat units are essential elements for defining polymers	None
orientation	CodeableConcept | None	The orientation of the polymerisation, e.g. head-tail, head-head, random	None
amount	Annotated[int | Integer, BeforeValidator] | None	Number of repeats of this unit	None
degreeOfPolymerisation	List[SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation] | None	Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described	None
structuralRepresentation	List[SubstancePolymerRepeatRepeatUnitStructuralRepresentation] | None	A graphical structure for this SRU	None

SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_polymer.SubstancePolymerRepeatRepeatUnitDegreeOfPolymerisation

Bases: BackboneElement

Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 degree of polymerisation shall be described, e.g. SRU/Polymer Ratio	None
average	Annotated[int | Integer, BeforeValidator] | None	An average amount of polymerisation	None
low	Annotated[int | Integer, BeforeValidator] | None	A low expected limit of the amount	None
high	Annotated[int | Integer, BeforeValidator] | None	A high expected limit of the amount	None

SubstancePolymerRepeatRepeatUnitStructuralRepresentation

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_polymer.SubstancePolymerRepeatRepeatUnitStructuralRepresentation

Bases: BackboneElement

A graphical structure for this SRU.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	The structural representation as text string in a standard format e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF	None
format	CodeableConcept | None	The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF	None
attachment	Attachment | None	An attached file with the structural representation	None

SubstanceProtein

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[int | Integer, BeforeValidator] | 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
disulfideLinkage	List[Annotated[str | String, BeforeValidator]] | 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
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

SubstanceProteinSubunit

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | Integer, BeforeValidator] | 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
sequence	Annotated[str | String, BeforeValidator] | 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
length	Annotated[int | Integer, BeforeValidator] | None	Length of linear sequences of amino acids contained in the subunit	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	Annotated[str | String, BeforeValidator] | None	The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified	None
cTerminalModificationId	Identifier | None	Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID	None
cTerminalModification	Annotated[str | String, BeforeValidator] | None	The modification at the C-terminal shall be specified	None

SubstanceReferenceInformation

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_reference_information.SubstanceReferenceInformation

Bases: DomainResource

Todo.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource.	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | String, BeforeValidator] | None	Todo	None
gene	List[SubstanceReferenceInformationGene] | None	Todo	None
geneElement	List[SubstanceReferenceInformationGeneElement] | None	Todo	None
target	List[SubstanceReferenceInformationTarget] | None	Todo	None

SubstanceReferenceInformationGene

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_reference_information.SubstanceReferenceInformationGene

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.substance_reference_information.SubstanceReferenceInformationGeneElement

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.substance_reference_information.SubstanceReferenceInformationTarget

Bases: BackboneElement

Todo.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Todo	None
amountType	CodeableConcept | None	Todo	None
source	List[Reference] | None	Todo	None

SubstanceSourceMaterial

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | String, BeforeValidator] | None	The organism accepted Scientific name shall be provided based on the organism taxonomy	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[Annotated[str | String, BeforeValidator]] | None	The parent substance of the Herbal Drug, or Herbal preparation	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[Annotated[str | String, BeforeValidator]] | None	The place/region where the plant is harvested or the places/regions where the animal source material has its habitat	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

SubstanceSourceMaterialFractionDescription

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	This element is capturing information about the fraction of a plant part, or human plasma for fractionation	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | 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
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.R5.core.substance_source_material.SubstanceSourceMaterialOrganismAuthor

Bases: BackboneElement

4.9.13.6.1 Author type (Conditional).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | 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

SubstanceSourceMaterialOrganismHybrid

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_source_material.SubstanceSourceMaterialOrganismHybrid

Bases: BackboneElement

4.9.13.8.1 Hybrid species maternal organism ID (Optional).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | 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
maternalOrganismName	Annotated[str | String, BeforeValidator] | 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
paternalOrganismId	Annotated[str | String, BeforeValidator] | None	The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary	None
paternalOrganismName	Annotated[str | String, BeforeValidator] | None	The name of the paternal species constituting the hybrid organism shall be specified	None
hybridType	CodeableConcept | None	The hybrid type of an organism shall be specified	None

SubstanceSourceMaterialOrganismOrganismGeneral

Path: fhircraft.fhir.resources.datatypes.R5.core.substance_source_material.SubstanceSourceMaterialOrganismOrganismGeneral

Bases: BackboneElement

4.9.13.7.1 Kingdom (Conditional).

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.substance_source_material.SubstanceSourceMaterialPartDescription

Bases: BackboneElement

To do.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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

SupplyDelivery

Path: fhircraft.fhir.resources.datatypes.R5.core.supply_delivery.SupplyDelivery

Bases: DomainResource

Record of delivery of what is supplied.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	in-progress | completed | abandoned | entered-in-error	None
patient	Reference | None	Patient for whom the item is supplied	None
type	CodeableConcept | None	Category of supply event	None
suppliedItem	List[SupplyDeliverySuppliedItem] | None	The item that is delivered or supplied	None
occurrenceDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When event occurred	None
occurrencePeriod	Period | None	When event occurred	None
occurrenceTiming	Timing | None	When event occurred	None
supplier	Reference | None	The item supplier	None
destination	Reference | None	Where the delivery was sent	None
receiver	List[Reference] | None	Who received the delivery	None

SupplyDeliverySuppliedItem

Path: fhircraft.fhir.resources.datatypes.R5.core.supply_delivery.SupplyDeliverySuppliedItem

Bases: BackboneElement

The item that is being delivered or has been supplied.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 supplied	None
itemCodeableConcept	CodeableConcept | None	Medication, Substance, Device or Biologically Derived Product supplied	None
itemReference	Reference | None	Medication, Substance, Device or Biologically Derived Product supplied	None

SupplyRequest

Path: fhircraft.fhir.resources.datatypes.R5.core.supply_request.SupplyRequest

Bases: DomainResource

A record of a non-patient specific request for a medication, substance, device, certain types of biologically derived product, and nutrition product used in the healthcare setting.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	draft | active | suspended +	None
basedOn	List[Reference] | None	What other request is fulfilled by this supply request	None
category	CodeableConcept | None	The kind of supply (central, non-stock, etc.)	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
deliverFor	Reference | None	The patient for who the supply request is for	None
item	CodeableReference | 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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the request should be fulfilled	None
occurrencePeriod	Period | None	When the request should be fulfilled	None
occurrenceTiming	Timing | None	When the request should be fulfilled	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the request was made	None
requester	Reference | None	Individual making the request	None
supplier	List[Reference] | None	Who is intended to fulfill the request	None
reason	List[CodeableReference] | 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

SupplyRequestParameter

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Value of detail	None

Task

Path: fhircraft.fhir.resources.datatypes.R5.core.task.Task

Bases: DomainResource

A task to be performed.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Canonical, BeforeValidator] | None	Formal definition of task	None
instantiatesUri	Annotated[str | Uri, BeforeValidator] | None	Formal definition of task	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	Annotated[str | Code, BeforeValidator] | None	draft | requested | received | accepted | +	None
statusReason	CodeableReference | None	Reason for current status	None
businessStatus	CodeableConcept | None	E.g. "Specimen collected", "IV prepped"	None
intent	Annotated[str | Code, BeforeValidator] | None	unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
doNotPerform	Annotated[bool | Boolean, BeforeValidator] | None	True if Task is prohibiting action	None
code	CodeableConcept | None	Task Type	None
description	Annotated[str | String, BeforeValidator] | None	Human-readable explanation of task	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
requestedPeriod	Period | None	When the task should be performed	None
executionPeriod	Period | None	Start and end time of execution	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Task Creation date	None
lastModified	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Task Last Modified date	None
requester	Reference | None	Who is asking for task to be done	None
requestedPerformer	List[CodeableReference] | None	Who should perform Task	None
owner	Reference | None	Responsible individual	None
performer	List[TaskPerformer] | None	Who or what performed the task	None
location	Reference | None	Where task occurs	None
reason	List[CodeableReference] | 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

TaskInput

Path: fhircraft.fhir.resources.datatypes.R5.core.task.TaskInput

Bases: BackboneElement

Additional information that may be needed in the execution of the task.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Base64Binary, BeforeValidator] | None	Content to use in performing the task	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Content to use in performing the task	None
valueCanonical	Annotated[str | Canonical, BeforeValidator] | None	Content to use in performing the task	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Content to use in performing the task	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Content to use in performing the task	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Content to use in performing the task	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Content to use in performing the task	None
valueId	Annotated[str | Id, BeforeValidator] | None	Content to use in performing the task	None
valueInstant	Annotated[datetime | Instant, BeforeValidator] | None	Content to use in performing the task	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Content to use in performing the task	None
valueInteger64	Annotated[int | Integer64, BeforeValidator] | None	Content to use in performing the task	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Content to use in performing the task	None
valueOid	Annotated[str | Oid, BeforeValidator] | None	Content to use in performing the task	None
valuePositiveInt	Annotated[int | PositiveInt, BeforeValidator] | None	Content to use in performing the task	None
valueString	Annotated[str | String, BeforeValidator] | None	Content to use in performing the task	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Content to use in performing the task	None
valueUnsignedInt	Annotated[int | UnsignedInt, BeforeValidator] | None	Content to use in performing the task	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	Content to use in performing the task	None
valueUrl	Annotated[str | Url, BeforeValidator] | None	Content to use in performing the task	None
valueUuid	Annotated[str | Uuid, BeforeValidator] | None	Content to use in performing the task	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
valueCodeableReference	CodeableReference | 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
valueRatioRange	RatioRange | 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
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
valueAvailability	Availability | None	Content to use in performing the task	None
valueExtendedContactDetail	ExtendedContactDetail | 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.R5.core.task.TaskOutput

Bases: BackboneElement

Outputs produced by the Task.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Base64Binary, BeforeValidator] | None	Result of output	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Result of output	None
valueCanonical	Annotated[str | Canonical, BeforeValidator] | None	Result of output	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Result of output	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Result of output	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Result of output	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Result of output	None
valueId	Annotated[str | Id, BeforeValidator] | None	Result of output	None
valueInstant	Annotated[datetime | Instant, BeforeValidator] | None	Result of output	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Result of output	None
valueInteger64	Annotated[int | Integer64, BeforeValidator] | None	Result of output	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Result of output	None
valueOid	Annotated[str | Oid, BeforeValidator] | None	Result of output	None
valuePositiveInt	Annotated[int | PositiveInt, BeforeValidator] | None	Result of output	None
valueString	Annotated[str | String, BeforeValidator] | None	Result of output	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Result of output	None
valueUnsignedInt	Annotated[int | UnsignedInt, BeforeValidator] | None	Result of output	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	Result of output	None
valueUrl	Annotated[str | Url, BeforeValidator] | None	Result of output	None
valueUuid	Annotated[str | Uuid, BeforeValidator] | None	Result of output	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
valueCodeableReference	CodeableReference | 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
valueRatioRange	RatioRange | 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
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
valueAvailability	Availability | None	Result of output	None
valueExtendedContactDetail	ExtendedContactDetail | None	Result of output	None
valueDosage	Dosage | None	Result of output	None
valueMeta	Meta | None	Result of output	None

TaskPerformer

Path: fhircraft.fhir.resources.datatypes.R5.core.task.TaskPerformer

Bases: BackboneElement

The entity who performed the requested task.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 task	None

TaskRestriction

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	How many times to repeat	None
period	Period | None	When fulfillment is sought	None
recipient	List[Reference] | None	For whom is fulfillment sought?	None

TerminologyCapabilities

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this terminology capabilities, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the terminology capabilities	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the terminology capabilities	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this terminology capabilities (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this terminology capabilities (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the terminology capabilities	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	Annotated[str | Markdown, BeforeValidator] | None	Why this terminology capabilities is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
kind	Annotated[str | Code, BeforeValidator] | None	instance | capability | requirements	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether lockedDate is supported	None
codeSystem	List[TerminologyCapabilitiesCodeSystem] | None	A code system supported by the server	None
expansion	TerminologyCapabilitiesExpansion | None	Information about the ValueSet/$expand operation	None
codeSearch	Annotated[str | Code, BeforeValidator] | None	in-compose | in-expansion | in-compose-or-expansion	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

TerminologyCapabilitiesClosure

Path: fhircraft.fhir.resources.datatypes.R5.core.terminology_capabilities.TerminologyCapabilitiesClosure

Bases: BackboneElement

Whether the $closure operation is supported.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	If cross-system closure is supported	None

TerminologyCapabilitiesCodeSystem

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Canonical, BeforeValidator] | None	canonical identifier for the code system, represented as a URI	None
version	List[TerminologyCapabilitiesCodeSystemVersion] | None	Version of code System supported	None
content	Annotated[str | Code, BeforeValidator] | None	not-present | example | fragment | complete | supplement	None
subsumption	Annotated[bool | Boolean, BeforeValidator] | None	Whether subsumption is supported	None

TerminologyCapabilitiesCodeSystemVersion

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Version identifier for this version	None
isDefault	Annotated[bool | Boolean, BeforeValidator] | None	If this is the default version for this code system	None
compositional	Annotated[bool | Boolean, BeforeValidator] | None	If compositional grammar is supported	None
language	List[Annotated[str | Code, BeforeValidator]] | None	Language Displays supported	None
filter	List[TerminologyCapabilitiesCodeSystemVersionFilter] | None	Filter Properties supported	None
property_	List[Annotated[str | Code, BeforeValidator]] | None	Properties supported for $lookup	None

TerminologyCapabilitiesCodeSystemVersionFilter

Path: fhircraft.fhir.resources.datatypes.R5.core.terminology_capabilities.TerminologyCapabilitiesCodeSystemVersionFilter

Bases: BackboneElement

Filter Properties supported.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	code of the property supported	None
op	List[Annotated[str | Code, BeforeValidator]] | None	Operations supported for the property	None

TerminologyCapabilitiesExpansion

Path: fhircraft.fhir.resources.datatypes.R5.core.terminology_capabilities.TerminologyCapabilitiesExpansion

Bases: BackboneElement

Information about the ValueSet/$expand operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether the server can return nested value sets	None
paging	Annotated[bool | Boolean, BeforeValidator] | None	Whether the server supports paging on expansion	None
incomplete	Annotated[bool | Boolean, BeforeValidator] | None	Allow request for incomplete expansions?	None
parameter	List[TerminologyCapabilitiesExpansionParameter] | None	Supported expansion parameter	None
textFilter	Annotated[str | Markdown, BeforeValidator] | None	Documentation about text searching works	None

TerminologyCapabilitiesExpansionParameter

Path: fhircraft.fhir.resources.datatypes.R5.core.terminology_capabilities.TerminologyCapabilitiesExpansionParameter

Bases: BackboneElement

Supported expansion parameter.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Name of the supported expansion parameter	None
documentation	Annotated[str | String, BeforeValidator] | None	Description of support for parameter	None

TerminologyCapabilitiesImplementation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Describes this specific instance	None
url	Annotated[str | Url, BeforeValidator] | None	Base URL for the implementation	None

TerminologyCapabilitiesSoftware

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	A name the software is known by	None
version	Annotated[str | String, BeforeValidator] | None	Version covered by this statement	None

TerminologyCapabilitiesTranslation

Path: fhircraft.fhir.resources.datatypes.R5.core.terminology_capabilities.TerminologyCapabilitiesTranslation

Bases: BackboneElement

Information about the ConceptMap/$translate operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether the client must identify the map	None

TerminologyCapabilitiesValidateCode

Path: fhircraft.fhir.resources.datatypes.R5.core.terminology_capabilities.TerminologyCapabilitiesValidateCode

Bases: BackboneElement

Information about the ValueSet/$validate-code operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether translations are validated	None

TestPlan

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlan

Bases: DomainResource

A plan for executing testing on an artifact or specifications

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this test plan, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Business identifier identifier for the test plan	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the test plan	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this test plan (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this test plan (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the test plan	None
useContext	List[UsageContext] | None	The context that the content is intended to support	None
jurisdiction	List[CodeableConcept] | None	Intended jurisdiction where the test plan applies (if applicable)	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this test plan is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
category	List[CodeableConcept] | None	The category of the Test Plan - can be acceptance, unit, performance	None
scope	List[Reference] | None	What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference	None
testTools	Annotated[str | Markdown, BeforeValidator] | None	A description of test tools to be used in the test plan - narrative for now	None
dependency	List[TestPlanDependency] | None	The required criteria to execute the test plan - e.g. preconditions, previous tests	None
exitCriteria	Annotated[str | Markdown, BeforeValidator] | None	The threshold or criteria for the test plan to be considered successfully executed - narrative	None
testCase	List[TestPlanTestCase] | None	The test cases that constitute this plan	None

TestPlanDependency

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlanDependency

Bases: BackboneElement

The required criteria to execute the test plan - e.g. preconditions, previous tests...

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Description of the dependency criterium	None
predecessor	Reference | None	Link to predecessor test plans	None

TestPlanTestCase

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlanTestCase

Bases: BackboneElement

The individual test cases that are part of this plan, when they they are made explicit.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[int | Integer, BeforeValidator] | None	Sequence of test case in the test plan	None
scope	List[Reference] | None	The scope or artifact covered by the case	None
dependency	List[TestPlanTestCaseDependency] | None	Required criteria to execute the test case	None
testRun	List[TestPlanTestCaseTestRun] | None	The actual test to be executed	None
testData	List[TestPlanTestCaseTestData] | None	The test data used in the test case	None
assertion	List[TestPlanTestCaseAssertion] | None	Test assertions or expectations	None

TestPlanTestCaseAssertion

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlanTestCaseAssertion

Bases: BackboneElement

The test assertions - the expectations of test results from the execution of the test case.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Assertion type - for example 'informative' or 'required'	None
object	List[CodeableReference] | None	The focus or object of the assertion	None
result	List[CodeableReference] | None	The actual result assertion	None

TestPlanTestCaseDependency

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlanTestCaseDependency

Bases: BackboneElement

The required criteria to execute the test case - e.g. preconditions, previous tests.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Markdown, BeforeValidator] | None	Description of the criteria	None
predecessor	Reference | None	Link to predecessor test plans	None

TestPlanTestCaseTestData

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlanTestCaseTestData

Bases: BackboneElement

The test data used in the test case.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 type of test data description, e.g. 'synthea'	None
content	Reference | None	The actual test resources when they exist	None
sourceString	Annotated[str | String, BeforeValidator] | None	Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc	None
sourceReference	Reference | None	Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc	None

TestPlanTestCaseTestRun

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlanTestCaseTestRun

Bases: BackboneElement

The actual test to be executed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
narrative	Annotated[str | Markdown, BeforeValidator] | None	The narrative description of the tests	None
script	TestPlanTestCaseTestRunScript | None	The test cases in a structured language e.g. gherkin, Postman, or FHIR TestScript	None

TestPlanTestCaseTestRunScript

Path: fhircraft.fhir.resources.datatypes.R5.core.test_plan.TestPlanTestCaseTestRunScript

Bases: BackboneElement

The test cases in a structured language e.g. gherkin, Postman, or FHIR TestScript.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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 for the test cases e.g. 'gherkin', 'testscript'	None
sourceString	Annotated[str | String, BeforeValidator] | None	The actual content of the cases - references to TestScripts or externally defined content	None
sourceReference	Reference | None	The actual content of the cases - references to TestScripts or externally defined content	None

TestReport

Path: fhircraft.fhir.resources.datatypes.R5.core.test_report.TestReport

Bases: DomainResource

A summary of information based on the results of executing a TestScript.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | String, BeforeValidator] | None	Informal name of the executed TestReport	None
status	Annotated[str | Code, BeforeValidator] | None	completed | in-progress | waiting | stopped | entered-in-error	None
testScript	Annotated[str | Canonical, BeforeValidator] | None	canonical URL to the version-specific TestScript that was executed to produce this TestReport	None
result	Annotated[str | Code, BeforeValidator] | None	pass | fail | pending	None
score	Annotated[float | Decimal, BeforeValidator] | None	The final score (percentage of tests passed) resulting from the execution of the TestScript	None
tester	Annotated[str | String, BeforeValidator] | None	Name of the tester producing this report (Organization or individual)	None
issued	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the TestScript was executed and this TestReport was generated	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

TestReportParticipant

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	test-engine | client | server	None
uri	Annotated[str | Uri, BeforeValidator] | None	The uri of the participant. An absolute URL is preferred	None
display	Annotated[str | String, BeforeValidator] | None	The display name of the participant	None

TestReportSetup

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.test_report.TestReportSetupAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.test_report.TestReportSetupActionAssert

Bases: BackboneElement

The results of the assertion performed on the previous operations.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	pass | skip | fail | warning | error	None
message	Annotated[str | Markdown, BeforeValidator] | None	A message associated with the result	None
detail	Annotated[str | String, BeforeValidator] | None	A link to further details on the result	None
requirement	List[TestReportSetupActionAssertRequirement] | None	Links or references to the testing requirements	None

TestReportSetupActionAssertRequirement

Path: fhircraft.fhir.resources.datatypes.R5.core.test_report.TestReportSetupActionAssertRequirement

Bases: BackboneElement

Links or references providing traceability to the testing requirements for this assert.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
linkUri	Annotated[str | Uri, BeforeValidator] | None	Link or reference to the testing requirement	None
linkCanonical	Annotated[str | Canonical, BeforeValidator] | None	Link or reference to the testing requirement	None

TestReportSetupActionOperation

Path: fhircraft.fhir.resources.datatypes.R5.core.test_report.TestReportSetupActionOperation

Bases: BackboneElement

The operation performed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	pass | skip | fail | warning | error	None
message	Annotated[str | Markdown, BeforeValidator] | None	A message associated with the result	None
detail	Annotated[str | Uri, BeforeValidator] | None	A link to further details on the result	None

TestReportTeardown

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.test_report.TestReportTeardownAction

Bases: BackboneElement

The teardown action will only contain an operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.test_report.TestReportTest

Bases: BackboneElement

A test executed from the test script.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Tracking/logging name of this test	None
description	Annotated[str | String, BeforeValidator] | None	Tracking/reporting short description of the test	None
action	List[TestReportTestAction] | None	A test operation or assert that was performed	None

TestReportTestAction

Path: fhircraft.fhir.resources.datatypes.R5.core.test_report.TestReportTestAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.test_report.TestReportTestActionAssert

Bases: BackboneElement

The results of the assertion performed on the previous operations.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	pass | skip | fail | warning | error	None
message	Annotated[str | Markdown, BeforeValidator] | None	A message associated with the result	None
detail	Annotated[str | String, BeforeValidator] | None	A link to further details on the result	None
requirement	List[TestReportSetupActionAssertRequirement] | None	Links or references to the testing requirements	None

TestReportTestActionOperation

Path: fhircraft.fhir.resources.datatypes.R5.core.test_report.TestReportTestActionOperation

Bases: BackboneElement

An operation would involve a REST request to a server.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	pass | skip | fail | warning | error	None
message	Annotated[str | Markdown, BeforeValidator] | None	A message associated with the result	None
detail	Annotated[str | Uri, BeforeValidator] | None	A link to further details on the result	None

TestScript

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this test script, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the test script	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the test script	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this test script (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this test script (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the test script	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	Annotated[str | Markdown, BeforeValidator] | None	Why this test script is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	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
scope	List[TestScriptScope] | None	Indication of the artifact(s) that are tested by this test case	None
fixture	List[TestScriptFixture] | None	Fixture in the test script - by reference (uri)	None
profile	List[Annotated[str | Canonical, BeforeValidator]] | 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

TestScriptDestination

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | Integer, BeforeValidator] | None	The index of the abstract destination server starting at 1	None
profile	Coding | None	FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor	None
url	Annotated[str | Url, BeforeValidator] | None	The url path of the destination server	None

TestScriptFixture

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Whether or not to implicitly create the fixture during setup	None
autodelete	Annotated[bool | Boolean, BeforeValidator] | None	Whether or not to implicitly delete the fixture during teardown	None
resource	Reference | None	Reference of the resource	None

TestScriptMetadata

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[bool | Boolean, BeforeValidator] | None	Are the capabilities required?	None
validated	Annotated[bool | Boolean, BeforeValidator] | None	Are the capabilities validated?	None
description	Annotated[str | String, BeforeValidator] | None	The expected capabilities of the server	None
origin	List[Annotated[int | Integer, BeforeValidator]] | None	Which origin server these requirements apply to	None
destination	Annotated[int | Integer, BeforeValidator] | None	Which server these requirements apply to	None
link	List[Annotated[str | Uri, BeforeValidator]] | None	Links to the FHIR specification	None
capabilities	Annotated[str | Canonical, BeforeValidator] | None	Required Capability Statement	None

TestScriptMetadataLink

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptMetadataLink

Bases: BackboneElement

A link to the FHIR specification that this test is covering.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	URL to the specification	None
description	Annotated[str | String, BeforeValidator] | None	Short description	None

TestScriptOrigin

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[int | Integer, BeforeValidator] | None	The index of the abstract origin server starting at 1	None
profile	Coding | None	FHIR-Client | FHIR-SDC-FormFiller	None
url	Annotated[str | Url, BeforeValidator] | None	The url path of the origin server	None

TestScriptScope

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptScope

Bases: BackboneElement

The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
artifact	Annotated[str | Canonical, BeforeValidator] | None	The specific conformance artifact being tested	None
conformance	CodeableConcept | None	required | optional | strict	None
phase	CodeableConcept | None	unit | integration | production	None

TestScriptSetup

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptSetup

Bases: BackboneElement

A series of required setup operations before tests are executed.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.test_script.TestScriptSetupAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Tracking/logging assertion label	None
description	Annotated[str | String, BeforeValidator] | None	Tracking/reporting assertion description	None
direction	Annotated[str | Code, BeforeValidator] | None	response | request	None
compareToSourceId	Annotated[str | String, BeforeValidator] | None	id_ of the source fixture to be evaluated	None
compareToSourceExpression	Annotated[str | String, BeforeValidator] | None	The FHIRPath expression to evaluate against the source fixture	None
compareToSourcePath	Annotated[str | String, BeforeValidator] | None	XPath or JSONPath expression to evaluate against the source fixture	None
contentType	Annotated[str | Code, BeforeValidator] | None	Mime type to compare against the 'Content-Type' header	None
defaultManualCompletion	Annotated[str | Code, BeforeValidator] | None	fail | pass | skip | stop	None
expression	Annotated[str | String, BeforeValidator] | None	The FHIRPath expression to be evaluated	None
headerField	Annotated[str | String, BeforeValidator] | None	HTTP header field name	None
minimumId	Annotated[str | String, BeforeValidator] | None	Fixture id_ of minimum content resource	None
navigationLinks	Annotated[bool | Boolean, BeforeValidator] | None	Perform validation on navigation links?	None
operator	Annotated[str | Code, BeforeValidator] | None	equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval	None
path	Annotated[str | String, BeforeValidator] | None	XPath or JSONPath expression	None
requestMethod	Annotated[str | Code, BeforeValidator] | None	delete | get | options | patch | post | put | head	None
requestURL	Annotated[str | String, BeforeValidator] | None	Request URL comparison value	None
resource	Annotated[str | Uri, BeforeValidator] | None	Resource type	None
response	Annotated[str | Code, BeforeValidator] | None	continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported	None
responseCode	Annotated[str | String, BeforeValidator] | None	HTTP response code to test	None
sourceId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of source expression or headerField	None
stopTestOnFail	Annotated[bool | Boolean, BeforeValidator] | None	If this assert fails, will the current test execution stop?	None
validateProfileId	Annotated[str | Id, BeforeValidator] | None	Profile id_ of validation profile reference	None
value	Annotated[str | String, BeforeValidator] | None	The value to compare to	None
warningOnly	Annotated[bool | Boolean, BeforeValidator] | None	Will this assert produce a warning only on error?	None
requirement	List[TestScriptSetupActionAssertRequirement] | None	Links or references to the testing requirements	None

TestScriptSetupActionAssertRequirement

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptSetupActionAssertRequirement

Bases: BackboneElement

Links or references providing traceability to the testing requirements for this assert.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
linkUri	Annotated[str | Uri, BeforeValidator] | None	Link or reference to the testing requirement	None
linkCanonical	Annotated[str | Canonical, BeforeValidator] | None	Link or reference to the testing requirement	None

TestScriptSetupActionOperation

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptSetupActionOperation

Bases: BackboneElement

The operation to perform.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	Resource type	None
label	Annotated[str | String, BeforeValidator] | None	Tracking/logging operation label	None
description	Annotated[str | String, BeforeValidator] | None	Tracking/reporting operation description	None
accept	Annotated[str | Code, BeforeValidator] | None	Mime type to accept in the payload of the response, with charset etc	None
contentType	Annotated[str | Code, BeforeValidator] | None	Mime type of the request payload contents, with charset etc	None
destination	Annotated[int | Integer, BeforeValidator] | None	Server responding to the request	None
encodeRequestUrl	Annotated[bool | Boolean, BeforeValidator] | None	Whether or not to send the request url in encoded format	None
method	Annotated[str | Code, BeforeValidator] | None	delete | get | options | patch | post | put | head	None
origin	Annotated[int | Integer, BeforeValidator] | None	Server initiating the request	None
params	Annotated[str | String, BeforeValidator] | None	Explicitly defined path parameters	None
requestHeader	List[TestScriptSetupActionOperationRequestHeader] | None	Each operation can have one or more header elements	None
requestId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of mapped request	None
responseId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of mapped response	None
sourceId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of body for PUT and POST requests	None
targetId	Annotated[str | Id, BeforeValidator] | None	id_ of fixture used for extracting the [id], [type], and [vid] for GET requests	None
url	Annotated[str | String, BeforeValidator] | None	Request URL	None

TestScriptSetupActionOperationRequestHeader

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptSetupActionOperationRequestHeader

Bases: BackboneElement

Header elements would be used to set HTTP headers.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	HTTP header field name	None
value	Annotated[str | String, BeforeValidator] | None	HTTP headerfield value	None

TestScriptTeardown

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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.R5.core.test_script.TestScriptTeardownAction

Bases: BackboneElement

The teardown action will only contain an operation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.core.test_script.TestScriptTest

Bases: BackboneElement

A test in this script.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Tracking/logging name of this test	None
description	Annotated[str | String, BeforeValidator] | None	Tracking/reporting short description of the test	None
action	List[TestScriptTestAction] | None	A test operation or assert to perform	None

TestScriptTestAction

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptTestAction

Bases: BackboneElement

Action would contain either an operation or an assertion.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Tracking/logging assertion label	None
description	Annotated[str | String, BeforeValidator] | None	Tracking/reporting assertion description	None
direction	Annotated[str | Code, BeforeValidator] | None	response | request	None
compareToSourceId	Annotated[str | String, BeforeValidator] | None	id_ of the source fixture to be evaluated	None
compareToSourceExpression	Annotated[str | String, BeforeValidator] | None	The FHIRPath expression to evaluate against the source fixture	None
compareToSourcePath	Annotated[str | String, BeforeValidator] | None	XPath or JSONPath expression to evaluate against the source fixture	None
contentType	Annotated[str | Code, BeforeValidator] | None	Mime type to compare against the 'Content-Type' header	None
defaultManualCompletion	Annotated[str | Code, BeforeValidator] | None	fail | pass | skip | stop	None
expression	Annotated[str | String, BeforeValidator] | None	The FHIRPath expression to be evaluated	None
headerField	Annotated[str | String, BeforeValidator] | None	HTTP header field name	None
minimumId	Annotated[str | String, BeforeValidator] | None	Fixture id_ of minimum content resource	None
navigationLinks	Annotated[bool | Boolean, BeforeValidator] | None	Perform validation on navigation links?	None
operator	Annotated[str | Code, BeforeValidator] | None	equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval | manualEval	None
path	Annotated[str | String, BeforeValidator] | None	XPath or JSONPath expression	None
requestMethod	Annotated[str | Code, BeforeValidator] | None	delete | get | options | patch | post | put | head	None
requestURL	Annotated[str | String, BeforeValidator] | None	Request URL comparison value	None
resource	Annotated[str | Uri, BeforeValidator] | None	Resource type	None
response	Annotated[str | Code, BeforeValidator] | None	continue | switchingProtocols | okay | created | accepted | nonAuthoritativeInformation | noContent | resetContent | partialContent | multipleChoices | movedPermanently | found | seeOther | notModified | useProxy | temporaryRedirect | permanentRedirect | badRequest | unauthorized | paymentRequired | forbidden | notFound | methodNotAllowed | notAcceptable | proxyAuthenticationRequired | requestTimeout | conflict | gone | lengthRequired | preconditionFailed | contentTooLarge | uriTooLong | unsupportedMediaType | rangeNotSatisfiable | expectationFailed | misdirectedRequest | unprocessableContent | upgradeRequired | internalServerError | notImplemented | badGateway | serviceUnavailable | gatewayTimeout | httpVersionNotSupported	None
responseCode	Annotated[str | String, BeforeValidator] | None	HTTP response code to test	None
sourceId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of source expression or headerField	None
stopTestOnFail	Annotated[bool | Boolean, BeforeValidator] | None	If this assert fails, will the current test execution stop?	None
validateProfileId	Annotated[str | Id, BeforeValidator] | None	Profile id_ of validation profile reference	None
value	Annotated[str | String, BeforeValidator] | None	The value to compare to	None
warningOnly	Annotated[bool | Boolean, BeforeValidator] | None	Will this assert produce a warning only on error?	None
requirement	List[TestScriptSetupActionAssertRequirement] | None	Links or references to the testing requirements	None

TestScriptTestActionOperation

Path: fhircraft.fhir.resources.datatypes.R5.core.test_script.TestScriptTestActionOperation

Bases: BackboneElement

An operation would involve a REST request to a server.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	Resource type	None
label	Annotated[str | String, BeforeValidator] | None	Tracking/logging operation label	None
description	Annotated[str | String, BeforeValidator] | None	Tracking/reporting operation description	None
accept	Annotated[str | Code, BeforeValidator] | None	Mime type to accept in the payload of the response, with charset etc	None
contentType	Annotated[str | Code, BeforeValidator] | None	Mime type of the request payload contents, with charset etc	None
destination	Annotated[int | Integer, BeforeValidator] | None	Server responding to the request	None
encodeRequestUrl	Annotated[bool | Boolean, BeforeValidator] | None	Whether or not to send the request url in encoded format	None
method	Annotated[str | Code, BeforeValidator] | None	delete | get | options | patch | post | put | head	None
origin	Annotated[int | Integer, BeforeValidator] | None	Server initiating the request	None
params	Annotated[str | String, BeforeValidator] | None	Explicitly defined path parameters	None
requestHeader	List[TestScriptSetupActionOperationRequestHeader] | None	Each operation can have one or more header elements	None
requestId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of mapped request	None
responseId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of mapped response	None
sourceId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of body for PUT and POST requests	None
targetId	Annotated[str | Id, BeforeValidator] | None	id_ of fixture used for extracting the [id], [type], and [vid] for GET requests	None
url	Annotated[str | String, BeforeValidator] | None	Request URL	None

TestScriptVariable

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Descriptive name for this variable	None
defaultValue	Annotated[str | String, BeforeValidator] | None	Default, hard-coded, or user-defined value for this variable	None
description	Annotated[str | String, BeforeValidator] | None	Natural language description of the variable	None
expression	Annotated[str | String, BeforeValidator] | None	The FHIRPath expression against the fixture body	None
headerField	Annotated[str | String, BeforeValidator] | None	HTTP header field name for source	None
hint	Annotated[str | String, BeforeValidator] | None	Hint help text for default value to enter	None
path	Annotated[str | String, BeforeValidator] | None	XPath or JSONPath against the fixture body	None
sourceId	Annotated[str | Id, BeforeValidator] | None	Fixture id_ of source expression or headerField within this variable	None

Transport

Path: fhircraft.fhir.resources.datatypes.R5.core.transport.Transport

Bases: DomainResource

Record of transport.

Parameters:

Name	Type	Description	Default
id	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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
instantiatesCanonical	Annotated[str | Canonical, BeforeValidator] | None	Formal definition of transport	None
instantiatesUri	Annotated[str | Uri, BeforeValidator] | None	Formal definition of transport	None
basedOn	List[Reference] | None	Request fulfilled by this transport	None
groupIdentifier	Identifier | None	Requisition or grouper id	None
partOf	List[Reference] | None	Part of referenced event	None
status	Annotated[str | Code, BeforeValidator] | None	in-progress | completed | abandoned | cancelled | planned | entered-in-error	None
statusReason	CodeableConcept | None	Reason for current status	None
intent	Annotated[str | Code, BeforeValidator] | None	unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option	None
priority	Annotated[str | Code, BeforeValidator] | None	routine | urgent | asap | stat	None
code	CodeableConcept | None	Transport Type	None
description	Annotated[str | String, BeforeValidator] | None	Human-readable explanation of transport	None
focus	Reference | None	What transport is acting on	None
for_	Reference | None	Beneficiary of the Transport	None
encounter	Reference | None	Healthcare event during which this transport originated	None
completionTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Completion time of the event (the occurrence)	None
authoredOn	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Transport Creation date	None
lastModified	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Transport Last Modified date	None
requester	Reference | None	Who is asking for transport to be done	None
performerType	List[CodeableConcept] | None	Requested performer	None
owner	Reference | None	Responsible individual	None
location	Reference | None	Where transport occurs	None
insurance	List[Reference] | None	Associated insurance coverage	None
note	List[Annotation] | None	Comments made about the transport	None
relevantHistory	List[Reference] | None	Key events in history of the Transport	None
restriction	TransportRestriction | None	Constraints on fulfillment transports	None
input	List[TransportInput] | None	Information used to perform transport	None
output	List[TransportOutput] | None	Information produced as part of transport	None
requestedLocation	Reference | None	The desired location	None
currentLocation	Reference | None	The entity current location	None
reason	CodeableReference | None	Why transport is needed	None
history	Reference | None	Parent (or preceding) transport	None

TransportInput

Path: fhircraft.fhir.resources.datatypes.R5.core.transport.TransportInput

Bases: BackboneElement

Additional information that may be needed in the execution of the transport.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Base64Binary, BeforeValidator] | None	Content to use in performing the transport	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Content to use in performing the transport	None
valueCanonical	Annotated[str | Canonical, BeforeValidator] | None	Content to use in performing the transport	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Content to use in performing the transport	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Content to use in performing the transport	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Content to use in performing the transport	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Content to use in performing the transport	None
valueId	Annotated[str | Id, BeforeValidator] | None	Content to use in performing the transport	None
valueInstant	Annotated[datetime | Instant, BeforeValidator] | None	Content to use in performing the transport	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Content to use in performing the transport	None
valueInteger64	Annotated[int | Integer64, BeforeValidator] | None	Content to use in performing the transport	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Content to use in performing the transport	None
valueOid	Annotated[str | Oid, BeforeValidator] | None	Content to use in performing the transport	None
valuePositiveInt	Annotated[int | PositiveInt, BeforeValidator] | None	Content to use in performing the transport	None
valueString	Annotated[str | String, BeforeValidator] | None	Content to use in performing the transport	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Content to use in performing the transport	None
valueUnsignedInt	Annotated[int | UnsignedInt, BeforeValidator] | None	Content to use in performing the transport	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	Content to use in performing the transport	None
valueUrl	Annotated[str | Url, BeforeValidator] | None	Content to use in performing the transport	None
valueUuid	Annotated[str | Uuid, BeforeValidator] | None	Content to use in performing the transport	None
valueAddress	Address | None	Content to use in performing the transport	None
valueAge	Age | None	Content to use in performing the transport	None
valueAnnotation	Annotation | None	Content to use in performing the transport	None
valueAttachment	Attachment | None	Content to use in performing the transport	None
valueCodeableConcept	CodeableConcept | None	Content to use in performing the transport	None
valueCodeableReference	CodeableReference | None	Content to use in performing the transport	None
valueCoding	Coding | None	Content to use in performing the transport	None
valueContactPoint	ContactPoint | None	Content to use in performing the transport	None
valueCount	Count | None	Content to use in performing the transport	None
valueDistance	Distance | None	Content to use in performing the transport	None
valueDuration	Duration | None	Content to use in performing the transport	None
valueHumanName	HumanName | None	Content to use in performing the transport	None
valueIdentifier	Identifier | None	Content to use in performing the transport	None
valueMoney	Money | None	Content to use in performing the transport	None
valuePeriod	Period | None	Content to use in performing the transport	None
valueQuantity	Quantity | None	Content to use in performing the transport	None
valueRange	Range | None	Content to use in performing the transport	None
valueRatio	Ratio | None	Content to use in performing the transport	None
valueRatioRange	RatioRange | None	Content to use in performing the transport	None
valueReference	Reference | None	Content to use in performing the transport	None
valueSampledData	SampledData | None	Content to use in performing the transport	None
valueSignature	Signature | None	Content to use in performing the transport	None
valueTiming	Timing | None	Content to use in performing the transport	None
valueContactDetail	ContactDetail | None	Content to use in performing the transport	None
valueDataRequirement	DataRequirement | None	Content to use in performing the transport	None
valueExpression	Expression | None	Content to use in performing the transport	None
valueParameterDefinition	ParameterDefinition | None	Content to use in performing the transport	None
valueRelatedArtifact	RelatedArtifact | None	Content to use in performing the transport	None
valueTriggerDefinition	TriggerDefinition | None	Content to use in performing the transport	None
valueUsageContext	UsageContext | None	Content to use in performing the transport	None
valueAvailability	Availability | None	Content to use in performing the transport	None
valueExtendedContactDetail	ExtendedContactDetail | None	Content to use in performing the transport	None
valueDosage	Dosage | None	Content to use in performing the transport	None
valueMeta	Meta | None	Content to use in performing the transport	None

TransportOutput

Path: fhircraft.fhir.resources.datatypes.R5.core.transport.TransportOutput

Bases: BackboneElement

Outputs produced by the Transport.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Base64Binary, BeforeValidator] | None	Result of output	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Result of output	None
valueCanonical	Annotated[str | Canonical, BeforeValidator] | None	Result of output	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Result of output	None
valueDate	Annotated[date | str | Date, BeforeValidator] | None	Result of output	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Result of output	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Result of output	None
valueId	Annotated[str | Id, BeforeValidator] | None	Result of output	None
valueInstant	Annotated[datetime | Instant, BeforeValidator] | None	Result of output	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Result of output	None
valueInteger64	Annotated[int | Integer64, BeforeValidator] | None	Result of output	None
valueMarkdown	Annotated[str | Markdown, BeforeValidator] | None	Result of output	None
valueOid	Annotated[str | Oid, BeforeValidator] | None	Result of output	None
valuePositiveInt	Annotated[int | PositiveInt, BeforeValidator] | None	Result of output	None
valueString	Annotated[str | String, BeforeValidator] | None	Result of output	None
valueTime	Annotated[time | Time, BeforeValidator] | None	Result of output	None
valueUnsignedInt	Annotated[int | UnsignedInt, BeforeValidator] | None	Result of output	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	Result of output	None
valueUrl	Annotated[str | Url, BeforeValidator] | None	Result of output	None
valueUuid	Annotated[str | Uuid, BeforeValidator] | None	Result of output	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
valueCodeableReference	CodeableReference | 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
valueRatioRange	RatioRange | 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
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
valueAvailability	Availability | None	Result of output	None
valueExtendedContactDetail	ExtendedContactDetail | None	Result of output	None
valueDosage	Dosage | None	Result of output	None
valueMeta	Meta | None	Result of output	None

TransportRestriction

Path: fhircraft.fhir.resources.datatypes.R5.core.transport.TransportRestriction

Bases: BackboneElement

If the Transport.focus is a request resource and the transport 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	str | None	Unique id for inter-element referencing	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	Annotated[int | PositiveInt, BeforeValidator] | None	How many times to repeat	None
period	Period | None	When fulfillment sought	None
recipient	List[Reference] | None	For whom is fulfillment sought?	None

ValueSet

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Uri, BeforeValidator] | None	canonical identifier for this value set, represented as a URI (globally unique)	None
identifier	List[Identifier] | None	Additional identifier for the value set (business identifier)	None
version	Annotated[str | String, BeforeValidator] | None	Business version of the value set	None
versionAlgorithmString	Annotated[str | String, BeforeValidator] | None	How to compare versions	None
versionAlgorithmCoding	Coding | None	How to compare versions	None
name	Annotated[str | String, BeforeValidator] | None	Name for this value set (computer friendly)	None
title	Annotated[str | String, BeforeValidator] | None	Name for this value set (human friendly)	None
status	Annotated[str | Code, BeforeValidator] | None	draft | active | retired | unknown	None
experimental	Annotated[bool | Boolean, BeforeValidator] | None	For testing purposes, not real usage	None
date	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Date last changed	None
publisher	Annotated[str | String, BeforeValidator] | None	Name of the publisher/steward (organization or individual)	None
contact	List[ContactDetail] | None	Contact details for the publisher	None
description	Annotated[str | Markdown, BeforeValidator] | None	Natural language description of the value set	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	Annotated[bool | Boolean, BeforeValidator] | None	Indicates whether or not any change to the content logical definition may occur	None
purpose	Annotated[str | Markdown, BeforeValidator] | None	Why this value set is defined	None
copyright	Annotated[str | Markdown, BeforeValidator] | None	Use and/or publishing restrictions	None
copyrightLabel	Annotated[str | String, BeforeValidator] | None	Copyright holder and year(s)	None
approvalDate	Annotated[date | str | Date, BeforeValidator] | None	When the ValueSet was approved by publisher	None
lastReviewDate	Annotated[date | str | Date, BeforeValidator] | None	When the ValueSet was last reviewed by the publisher	None
effectivePeriod	Period | None	When the ValueSet is expected to be used	None
topic	List[CodeableConcept] | None	E.g. Education, Treatment, Assessment, etc	None
author	List[ContactDetail] | None	Who authored the ValueSet	None
editor	List[ContactDetail] | None	Who edited the ValueSet	None
reviewer	List[ContactDetail] | None	Who reviewed the ValueSet	None
endorser	List[ContactDetail] | None	Who endorsed the ValueSet	None
relatedArtifact	List[RelatedArtifact] | None	Additional documentation, citations, etc	None
compose	ValueSetCompose | None	Content logical definition of the value set (CLD)	None
expansion	ValueSetExpansion | None	Used when the value set is "expanded"	None
scope	ValueSetScope | None	Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description	None

ValueSetCompose

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[date | str | Date, BeforeValidator] | None	Fixed date for references with no specified version (transitive)	None
inactive	Annotated[bool | Boolean, BeforeValidator] | None	Whether inactive codes are in the value set	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
property_	List[Annotated[str | String, BeforeValidator]] | None	Property to return if client doesn't override	None

ValueSetComposeExclude

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	The system the codes come from	None
version	Annotated[str | String, BeforeValidator] | None	Specific version of the code system referred to	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[Annotated[str | Canonical, BeforeValidator]] | None	Select the contents included in this value set	None
copyright	Annotated[str | String, BeforeValidator] | None	A copyright statement for the specific code system included in the value set	None

ValueSetComposeInclude

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	The system the codes come from	None
version	Annotated[str | String, BeforeValidator] | None	Specific version of the code system referred to	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[Annotated[str | Canonical, BeforeValidator]] | None	Select the contents included in this value set	None
copyright	Annotated[str | String, BeforeValidator] | None	A copyright statement for the specific code system included in the value set	None

ValueSetComposeIncludeConcept

Path: fhircraft.fhir.resources.datatypes.R5.core.value_set.ValueSetComposeIncludeConcept

Bases: BackboneElement

Specifies a concept to be included or excluded.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	code or expression from system	None
display	Annotated[str | String, BeforeValidator] | None	Text to display for this code for this value set in this valueset	None
designation	List[ValueSetComposeIncludeConceptDesignation] | None	Additional representations for this concept	None

ValueSetComposeIncludeConceptDesignation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Human language of the designation	None
use	Coding | None	Types of uses of designations	None
additionalUse	List[Coding] | None	Additional ways how this designation would be used	None
value	Annotated[str | String, BeforeValidator] | None	The text value for this designation	None

ValueSetComposeIncludeFilter

Path: fhircraft.fhir.resources.datatypes.R5.core.value_set.ValueSetComposeIncludeFilter

Bases: BackboneElement

Select concepts by specifying 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 within the include, they SHALL all be true.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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_	Annotated[str | Code, BeforeValidator] | None	A property/filter defined by the code system	None
op	Annotated[str | Code, BeforeValidator] | None	= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists	None
value	Annotated[str | String, BeforeValidator] | None	code from the system, or regex criteria, or boolean value for exists	None

ValueSetExpansion

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	Identifies the value set expansion (business identifier)	None
next	Annotated[str | Uri, BeforeValidator] | None	Opaque urls for paging through expansion results	None
timestamp	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	time ValueSet expansion happened	None
total	Annotated[int | Integer, BeforeValidator] | None	Total number of codes in the expansion	None
offset	Annotated[int | Integer, BeforeValidator] | None	Offset at which this resource starts	None
parameter	List[ValueSetExpansionParameter] | None	Parameter that controlled the expansion process	None
property_	List[ValueSetExpansionProperty] | None	Additional information supplied about each concept	None
contains	List[ValueSetExpansionContains] | None	Codes in the value set	None

ValueSetExpansionContains

Path: fhircraft.fhir.resources.datatypes.R5.core.value_set.ValueSetExpansionContains

Bases: BackboneElement

The codes that are contained in the value set expansion.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Uri, BeforeValidator] | None	System value for the code	None
abstract	Annotated[bool | Boolean, BeforeValidator] | None	If user cannot select this entry	None
inactive	Annotated[bool | Boolean, BeforeValidator] | None	If concept is inactive in the code system	None
version	Annotated[str | String, BeforeValidator] | None	Version in which this code/display is defined	None
code	Annotated[str | Code, BeforeValidator] | None	code - if blank, this is not a selectable code	None
display	Annotated[str | String, BeforeValidator] | None	User display for the concept	None
designation	List[ValueSetExpansionContainsDesignation] | None	Additional representations for this item	None
property_	List[ValueSetExpansionContainsProperty] | None	Property value for the concept	None
contains	List[ValueSetExpansionContains] | None	Codes contained under this entry	None

ValueSetExpansionContainsDesignation

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Human language of the designation	None
use	Coding | None	Types of uses of designations	None
additionalUse	List[Coding] | None	Additional ways how this designation would be used	None
value	Annotated[str | String, BeforeValidator] | None	The text value for this designation	None

ValueSetExpansionContainsProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.value_set.ValueSetExpansionContainsProperty

Bases: BackboneElement

A property value for this concept.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Reference to ValueSet.expansion.property.code	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Value of the property for this concept	None
valueCoding	Coding | None	Value of the property for this concept	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the property for this concept	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Value of the property for this concept	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the property for this concept	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Value of the property for this concept	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Value of the property for this concept	None
subProperty	List[ValueSetExpansionContainsPropertySubProperty] | None	SubProperty value for the concept	None

ValueSetExpansionContainsPropertySubProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.value_set.ValueSetExpansionContainsPropertySubProperty

Bases: BackboneElement

A subproperty value for this concept.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Reference to ValueSet.expansion.property.code	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Value of the subproperty for this concept	None
valueCoding	Coding | None	Value of the subproperty for this concept	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the subproperty for this concept	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Value of the subproperty for this concept	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the subproperty for this concept	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Value of the subproperty for this concept	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Value of the subproperty for this concept	None

ValueSetExpansionParameter

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	Name as assigned by the client or server	None
valueString	Annotated[str | String, BeforeValidator] | None	Value of the named parameter	None
valueBoolean	Annotated[bool | Boolean, BeforeValidator] | None	Value of the named parameter	None
valueInteger	Annotated[int | Integer, BeforeValidator] | None	Value of the named parameter	None
valueDecimal	Annotated[float | Decimal, BeforeValidator] | None	Value of the named parameter	None
valueUri	Annotated[str | Uri, BeforeValidator] | None	Value of the named parameter	None
valueCode	Annotated[str | Code, BeforeValidator] | None	Value of the named parameter	None
valueDateTime	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Value of the named parameter	None

ValueSetExpansionProperty

Path: fhircraft.fhir.resources.datatypes.R5.core.value_set.ValueSetExpansionProperty

Bases: BackboneElement

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

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	Identifies the property on the concepts, and when referred to in operations	None
uri	Annotated[str | Uri, BeforeValidator] | None	Formal identifier for the property	None

ValueSetScope

Path: fhircraft.fhir.resources.datatypes.R5.core.value_set.ValueSetScope

Bases: BackboneElement

Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	None
extension	List[Extension] | None	Additional content defined by implementations	None
modifierExtension	List[Extension] | None	Extensions that cannot be ignored even if unrecognized	None
inclusionCriteria	Annotated[str | String, BeforeValidator] | None	Criteria describing which concepts or codes should be included and why	None
exclusionCriteria	Annotated[str | String, BeforeValidator] | None	Criteria describing which concepts or codes should be excluded and why	None

VerificationResult

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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[Annotated[str | String, BeforeValidator]] | None	The fhirpath location(s) within the resource that was validated	None
need	CodeableConcept | None	none | initial | periodic	None
status	Annotated[str | Code, BeforeValidator] | None	attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error	None
statusDate	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the validation status was updated	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	The date/time validation was last completed (including failed validations)	None
nextScheduled	Annotated[date | str | Date, BeforeValidator] | None	The date when target is next validated, if appropriate	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

VerificationResultAttestation

Path: fhircraft.fhir.resources.datatypes.R5.core.verification_result.VerificationResultAttestation

Bases: BackboneElement

Information about the entity attesting to information.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[date | str | Date, BeforeValidator] | None	The date the information was attested to	None
sourceIdentityCertificate	Annotated[str | String, BeforeValidator] | None	A digital identity certificate associated with the attestation source	None
proxyIdentityCertificate	Annotated[str | String, BeforeValidator] | None	A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source	None
proxySignature	Signature | None	Proxy signature (digital or image)	None
sourceSignature	Signature | None	Attester signature (digital or image)	None

VerificationResultPrimarySource

Path: fhircraft.fhir.resources.datatypes.R5.core.verification_result.VerificationResultPrimarySource

Bases: BackboneElement

Information about the primary source(s) involved in validation.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When the target was validated against the primary source	None
canPushUpdates	CodeableConcept | None	yes | no | undetermined	None
pushTypeAvailable	List[CodeableConcept] | None	specific | any | source	None

VerificationResultValidator

Path: fhircraft.fhir.resources.datatypes.R5.core.verification_result.VerificationResultValidator

Bases: BackboneElement

Information about the entity validating information.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[str | String, BeforeValidator] | None	A digital identity certificate associated with the validator	None
attestationSignature	Signature | None	Validator signature (digital or image)	None

VisionPrescription

Path: fhircraft.fhir.resources.datatypes.R5.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	Annotated[str | Id, BeforeValidator] | None	Logical id of this artifact	None
meta	Meta | None	Metadata about the resource	None
implicitRules	Annotated[str | Uri, BeforeValidator] | None	A set of rules under which this content was created	None
language	Annotated[str | Code, BeforeValidator] | None	Language of the resource content	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	Annotated[str | Code, BeforeValidator] | None	active | cancelled | draft | entered-in-error	None
created	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	Response creation date	None
patient	Reference | None	Who prescription is for	None
encounter	Reference | None	Created during encounter / admission / stay	None
dateWritten	Annotated[datetime | date | str | DateTime, BeforeValidator] | None	When prescription was authorized	None
prescriber	Reference | None	Who authorized the vision prescription	None
lensSpecification	List[VisionPrescriptionLensSpecification] | None	Vision lens authorization	None

VisionPrescriptionLensSpecification

Path: fhircraft.fhir.resources.datatypes.R5.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	str | None	Unique id for inter-element referencing	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	Annotated[str | Code, BeforeValidator] | None	right | left	None
sphere	Annotated[float | Decimal, BeforeValidator] | None	Power of the lens	None
cylinder	Annotated[float | Decimal, BeforeValidator] | None	Lens power for astigmatism	None
axis	Annotated[int | Integer, BeforeValidator] | None	Lens meridian which contain no power for astigmatism	None
prism	List[VisionPrescriptionLensSpecificationPrism] | None	Eye alignment compensation	None
add	Annotated[float | Decimal, BeforeValidator] | None	Added power for multifocal levels	None
power	Annotated[float | Decimal, BeforeValidator] | None	Contact lens power	None
backCurve	Annotated[float | Decimal, BeforeValidator] | None	Contact lens back curvature	None
diameter	Annotated[float | Decimal, BeforeValidator] | None	Contact lens diameter	None
duration	Quantity | None	Lens wear duration	None
color	Annotated[str | String, BeforeValidator] | None	Color required	None
brand	Annotated[str | String, BeforeValidator] | None	Brand required	None
note	List[Annotation] | None	Notes for coatings	None

VisionPrescriptionLensSpecificationPrism

Path: fhircraft.fhir.resources.datatypes.R5.core.vision_prescription.VisionPrescriptionLensSpecificationPrism

Bases: BackboneElement

Allows for adjustment on two axis.

Parameters:

Name	Type	Description	Default
id	str | None	Unique id for inter-element referencing	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	Annotated[float | Decimal, BeforeValidator] | None	Amount of adjustment	None
base	Annotated[str | Code, BeforeValidator] | None	up | down | in | out	None