@medplum/fhirtypes 3.1.6 → 3.1.7

package/dist/Dosage.d.ts

@@ -130,6 +130,13 @@ export interface Dosage {
   maxDosePerLifetime?: Quantity;
 }
 
+/**
+ * Indicates whether the Medication is only taken when needed within a
+ * specific dosing schedule (Boolean option), or it indicates the
+ * precondition for taking the Medication (CodeableConcept).
+ */
+export type DosageAsNeeded = boolean | CodeableConcept;
+
 /**
  * The amount of medication administered.
  */
@@ -182,3 +189,13 @@ export interface DosageDoseAndRate {
    */
   rateQuantity?: Quantity;
 }
+
+/**
+ * Amount of medication per dose.
+ */
+export type DosageDoseAndRateDose = Quantity | Range;
+
+/**
+ * Amount of medication per unit of time.
+ */
+export type DosageDoseAndRateRate = Quantity | Range | Ratio;

package/dist/ElementDefinition.d.ts

@@ -2316,6 +2316,67 @@ export interface ElementDefinition {
   mapping?: ElementDefinitionMapping[];
 }
 
+/**
+ * The value that should be used if there is no value stated in the
+ * instance (e.g. 'if not otherwise specified, the abstract is false').
+ */
+export type ElementDefinitionDefaultValue = Address | Age | Annotation | Attachment | boolean | CodeableConcept | Coding
+    | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | Distance | Dosage | Duration | Expression |
+    HumanName | Identifier | Meta | Money | number | ParameterDefinition | Period | Quantity | Range | Ratio | Reference |
+    RelatedArtifact | SampledData | Signature | string | Timing | TriggerDefinition | UsageContext;
+
+/**
+ * Specifies a value that SHALL be exactly the value  for this element in
+ * the instance. For purposes of comparison, non-significant whitespace
+ * is ignored, and all values must be an exact match (case and accent
+ * sensitive). Missing elements/attributes must also be missing.
+ */
+export type ElementDefinitionFixed = Address | Age | Annotation | Attachment | boolean | CodeableConcept | Coding |
+    ContactDetail | ContactPoint | Contributor | Count | DataRequirement | Distance | Dosage | Duration | Expression |
+    HumanName | Identifier | Meta | Money | number | ParameterDefinition | Period | Quantity | Range | Ratio | Reference |
+    RelatedArtifact | SampledData | Signature | string | Timing | TriggerDefinition | UsageContext;
+
+/**
+ * Specifies a value that the value in the instance SHALL follow - that
+ * is, any value in the pattern must be found in the instance. Other
+ * additional values may be found too. This is effectively constraint by
+ * example.
+ *
+ * When pattern[x] is used to constrain a primitive, it means that the
+ * value provided in the pattern[x] must match the instance value
+ * exactly.
+ *
+ * When pattern[x] is used to constrain an array, it means that each
+ * element provided in the pattern[x] array must (recursively) match at
+ * least one element from the instance array.
+ *
+ * When pattern[x] is used to constrain a complex object, it means that
+ * each property in the pattern must be present in the complex object,
+ * and its value must recursively match -- i.e.,
+ *
+ * 1. If primitive: it must match exactly the pattern value
+ * 2. If a complex object: it must match (recursively) the pattern value
+ * 3. If an array: it must match (recursively) the pattern value.
+ */
+export type ElementDefinitionPattern = Address | Age | Annotation | Attachment | boolean | CodeableConcept | Coding |
+    ContactDetail | ContactPoint | Contributor | Count | DataRequirement | Distance | Dosage | Duration | Expression |
+    HumanName | Identifier | Meta | Money | number | ParameterDefinition | Period | Quantity | Range | Ratio | Reference |
+    RelatedArtifact | SampledData | Signature | string | Timing | TriggerDefinition | UsageContext;
+
+/**
+ * The minimum allowed value for the element. The value is inclusive.
+ * This is allowed for the types date, dateTime, instant, time, decimal,
+ * integer, and Quantity.
+ */
+export type ElementDefinitionMinValue = number | Quantity | string;
+
+/**
+ * The maximum allowed value for the element. The value is inclusive.
+ * This is allowed for the types date, dateTime, instant, time, decimal,
+ * integer, and Quantity.
+ */
+export type ElementDefinitionMaxValue = number | Quantity | string;
+
 /**
  * Information about the base definition of the element, provided to make
  * it unnecessary for tools to trace the deviation of the element through
@@ -2798,6 +2859,15 @@ export interface ElementDefinitionExample {
   valueMeta?: Meta;
 }
 
+/**
+ * The actual value for the element, which must be one of the types
+ * allowed for this element.
+ */
+export type ElementDefinitionExampleValue = Address | Age | Annotation | Attachment | boolean | CodeableConcept | Coding
+    | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | Distance | Dosage | Duration | Expression |
+    HumanName | Identifier | Meta | Money | number | ParameterDefinition | Period | Quantity | Range | Ratio | Reference |
+    RelatedArtifact | SampledData | Signature | string | Timing | TriggerDefinition | UsageContext;
+
 /**
  * Identifies a concept from an external specification that roughly
  * corresponds to this element.

package/dist/EventDefinition.d.ts

@@ -295,3 +295,9 @@ export interface EventDefinition {
    */
   trigger: TriggerDefinition[];
 }
+
+/**
+ * A code or group definition that describes the intended subject of the
+ * event definition.
+ */
+export type EventDefinitionSubject = CodeableConcept | Reference<Group>;

package/dist/EvidenceVariable.d.ts

@@ -429,3 +429,16 @@ export interface EvidenceVariableCharacteristic {
    */
   groupMeasure?: 'mean' | 'median' | 'mean-of-mean' | 'mean-of-median' | 'median-of-mean' | 'median-of-median';
 }
+
+/**
+ * Define members of the evidence element using Codes (such as condition,
+ * medication, or observation), Expressions ( using an expression
+ * language such as FHIRPath or CQL) or DataRequirements (such as
+ * Diabetes diagnosis onset in the last year).
+ */
+export type EvidenceVariableCharacteristicDefinition = CodeableConcept | DataRequirement | Expression | Reference<Group> | string | TriggerDefinition;
+
+/**
+ * Indicates what effective period the study covers.
+ */
+export type EvidenceVariableCharacteristicParticipantEffective = Duration | Period | string | Timing;

package/dist/ExplanationOfBenefit.d.ts

@@ -432,6 +432,11 @@ export interface ExplanationOfBenefitAccident {
   locationReference?: Reference<Location>;
 }
 
+/**
+ * The physical location of the accident event.
+ */
+export type ExplanationOfBenefitAccidentLocation = Address | Reference<Location>;
+
 /**
  * The first-tier service adjudications for payor added product or
  * service lines.
@@ -595,6 +600,17 @@ export interface ExplanationOfBenefitAddItem {
   detail?: ExplanationOfBenefitAddItemDetail[];
 }
 
+/**
+ * The date or dates when the service or product was supplied, performed
+ * or completed.
+ */
+export type ExplanationOfBenefitAddItemServiced = Period | string;
+
+/**
+ * Where the product or service was provided.
+ */
+export type ExplanationOfBenefitAddItemLocation = Address | CodeableConcept | Reference<Location>;
+
 /**
  * The second-tier service adjudications for payor added services.
  */
@@ -939,6 +955,16 @@ export interface ExplanationOfBenefitBenefitBalanceFinancial {
   usedMoney?: Money;
 }
 
+/**
+ * The quantity of the benefit which is permitted under the coverage.
+ */
+export type ExplanationOfBenefitBenefitBalanceFinancialAllowed = Money | number | string;
+
+/**
+ * The quantity of the benefit which have been consumed to date.
+ */
+export type ExplanationOfBenefitBenefitBalanceFinancialUsed = Money | number;
+
 /**
  * The members of the team who provided the products and services.
  */
@@ -1084,6 +1110,12 @@ export interface ExplanationOfBenefitDiagnosis {
   packageCode?: CodeableConcept;
 }
 
+/**
+ * The nature of illness or problem in a coded form or as a reference to
+ * an external defined Condition.
+ */
+export type ExplanationOfBenefitDiagnosisDiagnosis = CodeableConcept | Reference<Condition>;
+
 /**
  * Financial instruments for reimbursement for the health care products
  * and services specified on the claim.
@@ -1338,6 +1370,17 @@ export interface ExplanationOfBenefitItem {
   detail?: ExplanationOfBenefitItemDetail[];
 }
 
+/**
+ * The date or dates when the service or product was supplied, performed
+ * or completed.
+ */
+export type ExplanationOfBenefitItemServiced = Period | string;
+
+/**
+ * Where the product or service was provided.
+ */
+export type ExplanationOfBenefitItemLocation = Address | CodeableConcept | Reference<Location>;
+
 /**
  * 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
@@ -1852,6 +1895,12 @@ export interface ExplanationOfBenefitProcedure {
   udi?: Reference<Device>[];
 }
 
+/**
+ * The code or reference to a Procedure resource which identifies the
+ * clinical intervention performed.
+ */
+export type ExplanationOfBenefitProcedureProcedure = CodeableConcept | Reference<Procedure>;
+
 /**
  * A note that describes or explains adjudication results in a human
  * readable form.
@@ -2083,6 +2132,18 @@ export interface ExplanationOfBenefitSupportingInfo {
   reason?: Coding;
 }
 
+/**
+ * The date when or period to which this information refers.
+ */
+export type ExplanationOfBenefitSupportingInfoTiming = Period | string;
+
+/**
+ * Additional data or information such as resources, documents, images
+ * etc. including references to the data or the actual inclusion of the
+ * data.
+ */
+export type ExplanationOfBenefitSupportingInfoValue = Attachment | boolean | Quantity | Reference<Resource> | string;
+
 /**
  * Categorized monetary totals for the adjudication.
  */

package/dist/Extension.d.ts

@@ -362,3 +362,12 @@ export interface Extension {
    */
   valueMeta?: Meta;
 }
+
+/**
+ * Value of extension - must be one of a constrained set of the data
+ * types (see [Extensibility](extensibility.html) for a list).
+ */
+export type ExtensionValue = Address | Age | Annotation | Attachment | boolean | CodeableConcept | Coding |
+    ContactDetail | ContactPoint | Contributor | Count | DataRequirement | Distance | Dosage | Duration | Expression |
+    HumanName | Identifier | Meta | Money | number | ParameterDefinition | Period | Quantity | Range | Ratio | Reference |
+    RelatedArtifact | SampledData | Signature | string | Timing | TriggerDefinition | UsageContext;

package/dist/FamilyMemberHistory.d.ts

@@ -260,6 +260,23 @@ export interface FamilyMemberHistory {
   condition?: FamilyMemberHistoryCondition[];
 }
 
+/**
+ * The actual or approximate date of birth of the relative.
+ */
+export type FamilyMemberHistoryBorn = Period | string;
+
+/**
+ * The age of the relative at the time the family member history is
+ * recorded.
+ */
+export type FamilyMemberHistoryAge = Age | Range | string;
+
+/**
+ * Deceased flag or the actual or approximate age of the relative at the
+ * time of death for the family member history record.
+ */
+export type FamilyMemberHistoryDeceased = Age | boolean | Range | string;
+
 /**
  * The significant Conditions (or condition) that the family member had.
  * This is a repeating section to allow a system to represent more than
@@ -357,3 +374,10 @@ export interface FamilyMemberHistoryCondition {
    */
   note?: Annotation[];
 }
+
+/**
+ * Either the age of onset, range of approximate age or descriptive
+ * string can be recorded.  For conditions with multiple occurrences,
+ * this describes the first known occurrence.
+ */
+export type FamilyMemberHistoryConditionOnset = Age | Period | Range | string;

package/dist/Goal.d.ts

@@ -208,6 +208,11 @@ export interface Goal {
   outcomeReference?: Reference<Observation>[];
 }
 
+/**
+ * The date or event after which the goal should begin being pursued.
+ */
+export type GoalStart = CodeableConcept | string;
+
 /**
  * Indicates what should be done by when.
  */
@@ -343,3 +348,20 @@ export interface GoalTarget {
    */
   dueDuration?: Duration;
 }
+
+/**
+ * The target value of the focus to be achieved to signify the
+ * fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low
+ * or both values of the range can be specified. When a low value is
+ * missing, it indicates that the goal is achieved at any focus value at
+ * or below the high value. Similarly, if the high value is missing, it
+ * indicates that the goal is achieved at any focus value at or above the
+ * low value.
+ */
+export type GoalTargetDetail = boolean | CodeableConcept | number | Quantity | Range | Ratio | string;
+
+/**
+ * Indicates either the date or the duration after start by which the
+ * goal should be met.
+ */
+export type GoalTargetDue = Duration | string;

package/dist/Group.d.ts

@@ -255,6 +255,12 @@ export interface GroupCharacteristic {
   period?: Period;
 }
 
+/**
+ * The value of the trait that holds (or does not hold - see 'exclude')
+ * for members of the group.
+ */
+export type GroupCharacteristicValue = boolean | CodeableConcept | Quantity | Range | Reference;
+
 /**
  * Identifies the resource instances that are members of the group.
  */

package/dist/GuidanceResponse.d.ts

@@ -226,3 +226,9 @@ export interface GuidanceResponse {
    */
   dataRequirement?: DataRequirement[];
 }
+
+/**
+ * An identifier, CodeableConcept or canonical reference to the guidance
+ * that was requested.
+ */
+export type GuidanceResponseModule = CodeableConcept | string;

package/dist/Immunization.d.ts

@@ -267,6 +267,11 @@ export interface Immunization {
   protocolApplied?: ImmunizationProtocolApplied[];
 }
 
+/**
+ * Date vaccine administered or was to be administered.
+ */
+export type ImmunizationOccurrence = string;
+
 /**
  * Educational material presented to the patient (or guardian) at the
  * time of vaccine administration.
@@ -462,6 +467,16 @@ export interface ImmunizationProtocolApplied {
   seriesDosesString?: string;
 }
 
+/**
+ * Nominal position in a series.
+ */
+export type ImmunizationProtocolAppliedDoseNumber = number | string;
+
+/**
+ * The recommended number of doses to achieve immunity.
+ */
+export type ImmunizationProtocolAppliedSeriesDoses = number | string;
+
 /**
  * Categorical data indicating that an adverse event is associated in
  * time to an immunization.

package/dist/ImmunizationEvaluation.d.ts

@@ -177,3 +177,13 @@ export interface ImmunizationEvaluation {
    */
   seriesDosesString?: string;
 }
+
+/**
+ * Nominal position in a series.
+ */
+export type ImmunizationEvaluationDoseNumber = number | string;
+
+/**
+ * The recommended number of doses to achieve immunity.
+ */
+export type ImmunizationEvaluationSeriesDoses = number | string;

package/dist/ImmunizationRecommendation.d.ts

@@ -244,6 +244,17 @@ export interface ImmunizationRecommendationRecommendation {
   supportingPatientInformation?: Reference<Resource>[];
 }
 
+/**
+ * Nominal position of the recommended dose in a series (e.g. dose 2 is
+ * the next recommended dose).
+ */
+export type ImmunizationRecommendationRecommendationDoseNumber = number | string;
+
+/**
+ * The recommended number of doses to achieve immunity.
+ */
+export type ImmunizationRecommendationRecommendationSeriesDoses = number | string;
+
 /**
  * Vaccine date recommendations.  For example, earliest date to
  * administer, latest date to administer, etc.

package/dist/ImplementationGuide.d.ts

@@ -483,6 +483,11 @@ export interface ImplementationGuideDefinitionPage {
   page?: ImplementationGuideDefinitionPage[];
 }
 
+/**
+ * The source address for the page.
+ */
+export type ImplementationGuideDefinitionPageName = Reference<Binary> | string;
+
 /**
  * Defines how IG is built by tools.
  */
@@ -627,6 +632,13 @@ export interface ImplementationGuideDefinitionResource {
   groupingId?: string;
 }
 
+/**
+ * If true or a reference, indicates the resource is an example instance.
+ * If a reference is present, indicates that the example is an example
+ * of the specified profile.
+ */
+export type ImplementationGuideDefinitionResourceExample = boolean | string;
+
 /**
  * A template for building resources.
  */
@@ -991,3 +1003,10 @@ export interface ImplementationGuideManifestResource {
    */
   relativePath?: string;
 }
+
+/**
+ * If true or a reference, indicates the resource is an example instance.
+ * If a reference is present, indicates that the example is an example
+ * of the specified profile.
+ */
+export type ImplementationGuideManifestResourceExample = boolean | string;

package/dist/Invoice.d.ts

@@ -274,6 +274,14 @@ export interface InvoiceLineItem {
   priceComponent?: InvoiceLineItemPriceComponent[];
 }
 
+/**
+ * The ChargeItem contains information such as the billing code, date,
+ * amount etc. If no further details are required for the lineItem,
+ * inline billing codes can be added using the CodeableConcept data type
+ * instead of the Reference.
+ */
+export type InvoiceLineItemChargeItem = CodeableConcept | Reference<ChargeItem>;
+
 /**
  * The price for a ChargeItem may be calculated as a base price with
  * surcharges/deductions that apply in certain conditions. A

package/dist/Library.d.ts

@@ -322,3 +322,9 @@ export interface Library {
    */
   content?: Attachment[];
 }
+
+/**
+ * A code or group definition that describes the intended subject of the
+ * contents of the library.
+ */
+export type LibrarySubject = CodeableConcept | Reference<Group>;

package/dist/Measure.d.ts

@@ -383,6 +383,13 @@ export interface Measure {
   supplementalData?: MeasureSupplementalData[];
 }
 
+/**
+ * The intended subjects for the measure. If this element is not
+ * provided, a Patient subject is assumed, but the subject of the measure
+ * can be anything.
+ */
+export type MeasureSubject = CodeableConcept | Reference<Group>;
+
 /**
  * A group of population criteria for the measure.
  */

package/dist/Media.d.ts

@@ -241,3 +241,8 @@ export interface Media {
    */
   note?: Annotation[];
 }
+
+/**
+ * The date and time(s) at which the media was collected.
+ */
+export type MediaCreated = Period | string;

package/dist/Medication.d.ts

@@ -265,3 +265,9 @@ export interface MedicationIngredient {
    */
   strength?: Ratio;
 }
+
+/**
+ * The actual ingredient - either a substance (simple ingredient) or
+ * another medication of a medication.
+ */
+export type MedicationIngredientItem = CodeableConcept | Reference<Substance | Medication>;

package/dist/MedicationAdministration.d.ts

@@ -252,6 +252,22 @@ export interface MedicationAdministration {
   eventHistory?: Reference<Provenance>[];
 }
 
+/**
+ * Identifies the medication that was administered. This is either a link
+ * to a resource representing the details of the medication or a simple
+ * attribute carrying a code that identifies the medication from a known
+ * list of medications.
+ */
+export type MedicationAdministrationMedication = CodeableConcept | Reference<Medication>;
+
+/**
+ * A specific date/time or interval of time during which the
+ * administration took place (or did not take place, when the 'notGiven'
+ * attribute is true). For many administrations, such as swallowing a
+ * tablet the use of dateTime is more appropriate.
+ */
+export type MedicationAdministrationEffective = Period | string;
+
 /**
  * Describes the medication dosage information details e.g. dose, rate,
  * site, route, etc.
@@ -349,6 +365,15 @@ export interface MedicationAdministrationDosage {
   rateQuantity?: Quantity;
 }
 
+/**
+ * Identifies the speed with which the medication was or will be
+ * introduced into the patient.  Typically, the rate for an infusion e.g.
+ * 100 ml per 1 hour or 100 ml/hr.  May also be expressed as a rate per
+ * unit of time, e.g. 500 ml per 2 hours.  Other examples:  200 mcg/min
+ * or 200 mcg/1 minute; 1 liter/8 hours.
+ */
+export type MedicationAdministrationDosageRate = Quantity | Ratio;
+
 /**
  * Indicates who or what performed the medication administration and how
  * they were involved.

package/dist/MedicationDispense.d.ts

@@ -275,6 +275,19 @@ export interface MedicationDispense {
   eventHistory?: Reference<Provenance>[];
 }
 
+/**
+ * Indicates the reason why a dispense was not performed.
+ */
+export type MedicationDispenseStatusReason = CodeableConcept | Reference<DetectedIssue>;
+
+/**
+ * Identifies the medication being administered. This is either a link to
+ * a resource representing the details of the medication or a simple
+ * attribute carrying a code that identifies the medication from a known
+ * list of medications.
+ */
+export type MedicationDispenseMedication = CodeableConcept | Reference<Medication>;
+
 /**
  * Indicates who or what performed the event.
  */

package/dist/MedicationKnowledge.d.ts

@@ -301,6 +301,12 @@ export interface MedicationKnowledgeAdministrationGuidelines {
   patientCharacteristics?: MedicationKnowledgeAdministrationGuidelinesPatientCharacteristics[];
 }
 
+/**
+ * Indication for use that apply to the specific administration
+ * guidelines.
+ */
+export type MedicationKnowledgeAdministrationGuidelinesIndication = CodeableConcept | Reference<ObservationDefinition>;
+
 /**
  * Dosage for the medication for the specific guidelines.
  */
@@ -412,6 +418,12 @@ export interface MedicationKnowledgeAdministrationGuidelinesPatientCharacteristi
   value?: string[];
 }
 
+/**
+ * Specific characteristic that is relevant to the administration
+ * guideline (e.g. height, weight, gender).
+ */
+export type MedicationKnowledgeAdministrationGuidelinesPatientCharacteristicsCharacteristic = CodeableConcept | Quantity;
+
 /**
  * The price of the medication.
  */
@@ -537,6 +549,11 @@ export interface MedicationKnowledgeDrugCharacteristic {
   valueBase64Binary?: string;
 }
 
+/**
+ * Description of the characteristic.
+ */
+export type MedicationKnowledgeDrugCharacteristicValue = CodeableConcept | Quantity | string;
+
 /**
  * Identifies a particular constituent of interest in the product.
  */
@@ -603,6 +620,12 @@ export interface MedicationKnowledgeIngredient {
   strength?: Ratio;
 }
 
+/**
+ * The actual ingredient - either a substance (simple ingredient) or
+ * another medication.
+ */
+export type MedicationKnowledgeIngredientItem = CodeableConcept | Reference<Substance>;
+
 /**
  * The time course of drug absorption, distribution, metabolism and
  * excretion of a medication from the body.

package/dist/MedicationRequest.d.ts

@@ -346,6 +346,21 @@ export interface MedicationRequest {
   eventHistory?: Reference<Provenance>[];
 }
 
+/**
+ * Indicates if this record was captured as a secondary 'reported' record
+ * rather than as an original primary source-of-truth record.  It may
+ * also indicate the source of the report.
+ */
+export type MedicationRequestReported = boolean | Reference<Patient | Practitioner | PractitionerRole | RelatedPerson | Organization>;
+
+/**
+ * Identifies the medication being requested. This is a link to a
+ * resource that represents the medication which may be the details of
+ * the medication or simply an attribute carrying a code that identifies
+ * the medication from a known list of medications.
+ */
+export type MedicationRequestMedication = CodeableConcept | Reference<Medication>;
+
 /**
  * Indicates the specific details for the dispense or medication supply
  * part of a medication request (also known as a Medication Prescription
@@ -552,3 +567,9 @@ export interface MedicationRequestSubstitution {
    */
   reason?: CodeableConcept;
 }
+
+/**
+ * True if the prescriber allows a different drug to be dispensed from
+ * what was prescribed.
+ */
+export type MedicationRequestSubstitutionAllowed = boolean | CodeableConcept;

package/dist/MedicationStatement.d.ts

@@ -260,3 +260,18 @@ export interface MedicationStatement {
    */
   dosage?: Dosage[];
 }
+
+/**
+ * Identifies the medication being administered. This is either a link to
+ * a resource representing the details of the medication or a simple
+ * attribute carrying a code that identifies the medication from a known
+ * list of medications.
+ */
+export type MedicationStatementMedication = CodeableConcept | Reference<Medication>;
+
+/**
+ * The interval of time during which it is being asserted that the
+ * patient is/was/will be taking the medication (or was not taking, when
+ * the MedicationStatement.taken element is No).
+ */
+export type MedicationStatementEffective = Period | string;