@medplum/fhirtypes 2.2.10 → 3.0.0

package/dist/ExampleScenario.d.ts

@@ -134,7 +134,7 @@ export interface ExampleScenario {
    * The status of this example scenario. Enables tracking the life-cycle
    * of the content.
    */
-  status?: 'draft' | 'active' | 'retired' | 'unknown';
+  status: 'draft' | 'active' | 'retired' | 'unknown';
 
   /**
    * A Boolean value to indicate that this example scenario is authored for
@@ -257,12 +257,12 @@ export interface ExampleScenarioActor {
   /**
    * ID or acronym of actor.
    */
-  actorId?: string;
+  actorId: string;
 
   /**
    * The type of actor - person or system.
    */
-  type?: 'person' | 'entity';
+  type: 'person' | 'entity';
 
   /**
    * The name of the actor as shown in the page.
@@ -318,12 +318,12 @@ export interface ExampleScenarioInstance {
   /**
    * The id of the resource for referencing.
    */
-  resourceId?: string;
+  resourceId: string;
 
   /**
    * The type of the resource.
    */
-  resourceType?: ResourceType;
+  resourceType: ResourceType;
 
   /**
    * A short name for the resource instance.
@@ -391,7 +391,7 @@ export interface ExampleScenarioInstanceContainedInstance {
   /**
    * Each resource contained in the instance.
    */
-  resourceId?: string;
+  resourceId: string;
 
   /**
    * A specific version of a resource contained in the instance.
@@ -442,12 +442,12 @@ export interface ExampleScenarioInstanceVersion {
   /**
    * The identifier of a specific version of a resource.
    */
-  versionId?: string;
+  versionId: string;
 
   /**
    * The description of the resource version.
    */
-  description?: string;
+  description: string;
 }
 
 /**
@@ -493,7 +493,7 @@ export interface ExampleScenarioProcess {
   /**
    * The diagram title of the group of operations.
    */
-  title?: string;
+  title: string;
 
   /**
    * A longer description of the group of operations.
@@ -623,7 +623,7 @@ export interface ExampleScenarioProcessStepAlternative {
    * The label to display for the alternative that gives a sense of the
    * circumstance in which the alternative should be invoked.
    */
-  title?: string;
+  title: string;
 
   /**
    * A human-readable description of the alternative explaining when the
@@ -680,7 +680,7 @@ export interface ExampleScenarioProcessStepOperation {
   /**
    * The sequential number of the interaction, e.g. 1.2.5.
    */
-  number?: string;
+  number: string;
 
   /**
    * The type of operation - CRUD.

package/dist/ExplanationOfBenefit.d.ts

@@ -124,13 +124,13 @@ export interface ExplanationOfBenefit {
   /**
    * The status of the resource instance.
    */
-  status?: 'active' | 'cancelled' | 'draft' | 'entered-in-error';
+  status: 'active' | 'cancelled' | 'draft' | 'entered-in-error';
 
   /**
    * The category of claim, e.g. oral, pharmacy, vision, institutional,
    * professional.
    */
-  type?: CodeableConcept;
+  type: CodeableConcept;
 
   /**
    * A finer grained suite of claim type codes which may convey additional
@@ -146,14 +146,14 @@ export interface ExplanationOfBenefit {
    * or requesting the non-binding adjudication of the listed products and
    * services which could be provided in the future.
    */
-  use?: 'claim' | 'preauthorization' | 'predetermination';
+  use: 'claim' | 'preauthorization' | 'predetermination';
 
   /**
    * The party to whom the professional services and/or products have been
    * supplied or are being considered and for whom actual for forecast
    * reimbursement is sought.
    */
-  patient?: Reference<Patient>;
+  patient: Reference<Patient>;
 
   /**
    * The period for which charges are being submitted.
@@ -163,7 +163,7 @@ export interface ExplanationOfBenefit {
   /**
    * The date this resource was created.
    */
-  created?: string;
+  created: string;
 
   /**
    * Individual who created the claim, predetermination or
@@ -175,13 +175,13 @@ export interface ExplanationOfBenefit {
    * The party responsible for authorization, adjudication and
    * reimbursement.
    */
-  insurer?: Reference<Organization>;
+  insurer: Reference<Organization>;
 
   /**
    * The provider which is responsible for the claim, predetermination or
    * preauthorization.
    */
-  provider?: Reference<Practitioner | PractitionerRole | Organization>;
+  provider: Reference<Practitioner | PractitionerRole | Organization>;
 
   /**
    * The provider-required urgency of processing the request. Typical
@@ -252,7 +252,7 @@ export interface ExplanationOfBenefit {
    * The outcome of the claim, predetermination, or preauthorization
    * processing.
    */
-  outcome?: 'queued' | 'complete' | 'error' | 'partial';
+  outcome: 'queued' | 'complete' | 'error' | 'partial';
 
   /**
    * A human readable description of the status of the adjudication.
@@ -303,7 +303,7 @@ export interface ExplanationOfBenefit {
    * Financial instruments for reimbursement for the health care products
    * and services specified on the claim.
    */
-  insurance?: ExplanationOfBenefitInsurance[];
+  insurance: ExplanationOfBenefitInsurance[];
 
   /**
    * Details of a accident which resulted in injuries which required the
@@ -501,7 +501,7 @@ export interface ExplanationOfBenefitAddItem {
    * related claim details, otherwise this contains the product, service,
    * drug or other billing code for the item.
    */
-  productOrService?: CodeableConcept;
+  productOrService: CodeableConcept;
 
   /**
    * Item typification or modifiers codes to convey additional context for
@@ -640,7 +640,7 @@ export interface ExplanationOfBenefitAddItemDetail {
    * related claim details, otherwise this contains the product, service,
    * drug or other billing code for the item.
    */
-  productOrService?: CodeableConcept;
+  productOrService: CodeableConcept;
 
   /**
    * Item typification or modifiers codes to convey additional context for
@@ -736,7 +736,7 @@ export interface ExplanationOfBenefitAddItemDetailSubDetail {
    * related claim details, otherwise this contains the product, service,
    * drug or other billing code for the item.
    */
-  productOrService?: CodeableConcept;
+  productOrService: CodeableConcept;
 
   /**
    * Item typification or modifiers codes to convey additional context for
@@ -826,7 +826,7 @@ export interface ExplanationOfBenefitBenefitBalance {
    * Code to identify the general type of benefits under which products and
    * services are provided.
    */
-  category?: CodeableConcept;
+  category: CodeableConcept;
 
   /**
    * True if the indicated class of service is excluded from the plan,
@@ -911,7 +911,7 @@ export interface ExplanationOfBenefitBenefitBalanceFinancial {
   /**
    * Classification of benefit being provided.
    */
-  type?: CodeableConcept;
+  type: CodeableConcept;
 
   /**
    * The quantity of the benefit which is permitted under the coverage.
@@ -982,12 +982,12 @@ export interface ExplanationOfBenefitCareTeam {
   /**
    * A number to uniquely identify care team entries.
    */
-  sequence?: number;
+  sequence: number;
 
   /**
    * Member of the team who provided the product or service.
    */
-  provider?: Reference<Practitioner | PractitionerRole | Organization>;
+  provider: Reference<Practitioner | PractitionerRole | Organization>;
 
   /**
    * The party who is billing and/or responsible for the claimed products
@@ -1051,7 +1051,7 @@ export interface ExplanationOfBenefitDiagnosis {
   /**
    * A number to uniquely identify diagnosis entries.
    */
-  sequence?: number;
+  sequence: number;
 
   /**
    * The nature of illness or problem in a coded form or as a reference to
@@ -1129,7 +1129,7 @@ export interface ExplanationOfBenefitInsurance {
    * A flag to indicate that this Coverage is to be used for adjudication
    * of this claim when set to true.
    */
-  focal?: boolean;
+  focal: boolean;
 
   /**
    * Reference to the insurance card level information contained in the
@@ -1137,7 +1137,7 @@ export interface ExplanationOfBenefitInsurance {
    * to locate the patient's actual coverage within the insurer's
    * information system.
    */
-  coverage?: Reference<Coverage>;
+  coverage: Reference<Coverage>;
 
   /**
    * Reference numbers previously provided by the insurer to the provider
@@ -1191,7 +1191,7 @@ export interface ExplanationOfBenefitItem {
   /**
    * A number to uniquely identify item entries.
    */
-  sequence?: number;
+  sequence: number;
 
   /**
    * Care team members related to this service or product.
@@ -1231,7 +1231,7 @@ export interface ExplanationOfBenefitItem {
    * related claim details, otherwise this contains the product, service,
    * drug or other billing code for the item.
    */
-  productOrService?: CodeableConcept;
+  productOrService: CodeableConcept;
 
   /**
    * Item typification or modifiers codes to convey additional context for
@@ -1388,7 +1388,7 @@ export interface ExplanationOfBenefitItemAdjudication {
    * amounts paid by other coverages, and the benefit payable for this
    * item.
    */
-  category?: CodeableConcept;
+  category: CodeableConcept;
 
   /**
    * A code supporting the understanding of the adjudication result and
@@ -1452,7 +1452,7 @@ export interface ExplanationOfBenefitItemDetail {
    * A claim detail line. Either a simple (a product or service) or a
    * 'group' of sub-details which are simple items.
    */
-  sequence?: number;
+  sequence: number;
 
   /**
    * The type of revenue or cost center providing the product and/or
@@ -1471,7 +1471,7 @@ export interface ExplanationOfBenefitItemDetail {
    * related claim details, otherwise this contains the product, service,
    * drug or other billing code for the item.
    */
-  productOrService?: CodeableConcept;
+  productOrService: CodeableConcept;
 
   /**
    * Item typification or modifiers codes to convey additional context for
@@ -1576,7 +1576,7 @@ export interface ExplanationOfBenefitItemDetailSubDetail {
    * A claim detail line. Either a simple (a product or service) or a
    * 'group' of sub-details which are simple items.
    */
-  sequence?: number;
+  sequence: number;
 
   /**
    * The type of revenue or cost center providing the product and/or
@@ -1595,7 +1595,7 @@ export interface ExplanationOfBenefitItemDetailSubDetail {
    * related claim details, otherwise this contains the product, service,
    * drug or other billing code for the item.
    */
-  productOrService?: CodeableConcept;
+  productOrService: CodeableConcept;
 
   /**
    * Item typification or modifiers codes to convey additional context for
@@ -1822,7 +1822,7 @@ export interface ExplanationOfBenefitProcedure {
   /**
    * A number to uniquely identify procedure entries.
    */
-  sequence?: number;
+  sequence: number;
 
   /**
    * When the condition was observed or the relative ranking.
@@ -2016,13 +2016,13 @@ export interface ExplanationOfBenefitSupportingInfo {
   /**
    * A number to uniquely identify supporting information entries.
    */
-  sequence?: number;
+  sequence: number;
 
   /**
    * The general class of the information supplied: information; exception;
    * accident, employment; onset, etc.
    */
-  category?: CodeableConcept;
+  category: CodeableConcept;
 
   /**
    * System and code pertaining to the specific information regarding
@@ -2131,10 +2131,10 @@ export interface ExplanationOfBenefitTotal {
    * amounts paid by other coverages, and the benefit payable for this
    * item.
    */
-  category?: CodeableConcept;
+  category: CodeableConcept;
 
   /**
    * Monetary total amount associated with the category.
    */
-  amount?: Money;
+  amount: Money;
 }

package/dist/Expression.d.ts

@@ -44,7 +44,7 @@ export interface Expression {
   /**
    * The media type of the language for the expression.
    */
-  language?: 'text/cql' | 'text/fhirpath' | 'application/x-fhir-query';
+  language: 'text/cql' | 'text/fhirpath' | 'application/x-fhir-query';
 
   /**
    * An expression in the specified language that returns a value.

package/dist/Extension.d.ts

@@ -60,7 +60,7 @@ export interface Extension {
    * Source of the definition for the extension code - a logical name or a
    * URL.
    */
-  url?: string;
+  url: string;
 
   /**
    * Value of extension - must be one of a constrained set of the data

package/dist/FamilyMemberHistory.d.ts

@@ -129,7 +129,7 @@ export interface FamilyMemberHistory {
    * A code specifying the status of the record of the family history of a
    * specific family member.
    */
-  status?: 'partial' | 'completed' | 'entered-in-error' | 'health-unknown';
+  status: 'partial' | 'completed' | 'entered-in-error' | 'health-unknown';
 
   /**
    * Describes why the family member's history is not available.
@@ -139,7 +139,7 @@ export interface FamilyMemberHistory {
   /**
    * The person who this history concerns.
    */
-  patient?: Reference<Patient>;
+  patient: Reference<Patient>;
 
   /**
    * The date (and possibly time) when the family member history was
@@ -157,7 +157,7 @@ export interface FamilyMemberHistory {
    * The type of relationship this person has to the patient (father,
    * mother, brother etc.).
    */
-  relationship?: CodeableConcept;
+  relationship: CodeableConcept;
 
   /**
    * The birth sex of the family member.
@@ -309,7 +309,7 @@ export interface FamilyMemberHistoryCondition {
    * much is known about the condition and the capabilities of the creating
    * system.
    */
-  code?: CodeableConcept;
+  code: CodeableConcept;
 
   /**
    * Indicates what happened following the condition.  If the condition

package/dist/Flag.d.ts

@@ -115,7 +115,7 @@ export interface Flag {
   /**
    * Supports basic workflow.
    */
-  status?: 'active' | 'inactive' | 'entered-in-error';
+  status: 'active' | 'inactive' | 'entered-in-error';
 
   /**
    * Allows a flag to be divided into different categories like clinical,
@@ -128,13 +128,13 @@ export interface Flag {
    * The coded value or textual component of the flag to display to the
    * user.
    */
-  code?: CodeableConcept;
+  code: CodeableConcept;
 
   /**
    * The patient, location, group, organization, or practitioner etc. this
    * is about record this flag is associated with.
    */
-  subject?: Reference<Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure>;
+  subject: Reference<Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure>;
 
   /**
    * The period of time from the activation of the flag to inactivation of

package/dist/Goal.d.ts

@@ -122,7 +122,7 @@ export interface Goal {
   /**
    * The state of the goal throughout its lifecycle.
    */
-  lifecycleStatus?: 'proposed' | 'planned' | 'accepted' | 'active' | 'on-hold' | 'completed' | 'cancelled' | 'entered-in-error' | 'rejected';
+  lifecycleStatus: 'proposed' | 'planned' | 'accepted' | 'active' | 'on-hold' | 'completed' | 'cancelled' | 'entered-in-error' | 'rejected';
 
   /**
    * Describes the progression, or lack thereof, towards the goal against
@@ -146,13 +146,13 @@ export interface Goal {
    * objective of care, such as "control blood pressure" or "negotiate an
    * obstacle course" or "dance with child at wedding".
    */
-  description?: CodeableConcept;
+  description: CodeableConcept;
 
   /**
    * Identifies the patient, group or organization for whom the goal is
    * being established.
    */
-  subject?: Reference<Patient | Group | Organization>;
+  subject: Reference<Patient | Group | Organization>;
 
   /**
    * The date or event after which the goal should begin being pursued.

package/dist/GraphDefinition.d.ts

@@ -123,13 +123,13 @@ export interface GraphDefinition {
    * should be usable as an identifier for the module by machine processing
    * applications such as code generation.
    */
-  name?: string;
+  name: string;
 
   /**
    * The status of this graph definition. Enables tracking the life-cycle
    * of the content.
    */
-  status?: 'draft' | 'active' | 'retired' | 'unknown';
+  status: 'draft' | 'active' | 'retired' | 'unknown';
 
   /**
    * A Boolean value to indicate that this graph definition is authored for
@@ -188,7 +188,7 @@ export interface GraphDefinition {
   /**
    * The type of FHIR resource at which instances of this graph start.
    */
-  start?: ResourceType;
+  start: ResourceType;
 
   /**
    * The profile that describes the use of the base resource.
@@ -317,7 +317,7 @@ export interface GraphDefinitionLinkTarget {
   /**
    * Type of resource this link refers to.
    */
-  type?: ResourceType;
+  type: ResourceType;
 
   /**
    * A set of parameters to look up.
@@ -385,17 +385,17 @@ export interface GraphDefinitionLinkTargetCompartment {
    * test whether resources are subject to the rule, or whether it is a
    * rule that must be followed.
    */
-  use?: 'condition' | 'requirement';
+  use: 'condition' | 'requirement';
 
   /**
    * Identifies the compartment.
    */
-  code?: 'Patient' | 'Encounter' | 'RelatedPerson' | 'Practitioner' | 'Device';
+  code: 'Patient' | 'Encounter' | 'RelatedPerson' | 'Practitioner' | 'Device';
 
   /**
    * identical | matching | different | no-rule | custom.
    */
-  rule?: 'identical' | 'matching' | 'different' | 'custom';
+  rule: 'identical' | 'matching' | 'different' | 'custom';
 
   /**
    * Custom rule, as a FHIRPath expression.

package/dist/Group.d.ts

@@ -121,14 +121,14 @@ export interface Group {
    * Identifies the broad classification of the kind of resources the group
    * includes.
    */
-  type?: 'person' | 'animal' | 'practitioner' | 'device' | 'medication' | 'substance';
+  type: 'person' | 'animal' | 'practitioner' | 'device' | 'medication' | 'substance';
 
   /**
    * If true, indicates that the resource refers to a specific group of
    * real individuals.  If false, the group defines a set of intended
    * individuals.
    */
-  actual?: boolean;
+  actual: boolean;
 
   /**
    * Provides a specific type of resource the group includes; e.g. "cow",
@@ -210,7 +210,7 @@ export interface GroupCharacteristic {
   /**
    * A code that identifies the kind of trait being asserted.
    */
-  code?: CodeableConcept;
+  code: CodeableConcept;
 
   /**
    * The value of the trait that holds (or does not hold - see 'exclude')
@@ -246,7 +246,7 @@ export interface GroupCharacteristic {
    * If true, indicates the characteristic is one that is NOT held by
    * members of the group.
    */
-  exclude?: boolean;
+  exclude: boolean;
 
   /**
    * The period over which the characteristic is tested; e.g. the patient
@@ -300,7 +300,7 @@ export interface GroupMember {
    * consistent with Group.type. If the entity is another group, then the
    * type must be the same.
    */
-  entity?: Reference<Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group>;
+  entity: Reference<Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group>;
 
   /**
    * The period that the member was in the group, if known.

package/dist/GuidanceResponse.d.ts

@@ -151,7 +151,7 @@ export interface GuidanceResponse {
    * available, the status will be data-requested, and the response will
    * contain a description of the additional requested information.
    */
-  status?: 'success' | 'data-requested' | 'data-required' | 'in-progress' | 'failure' | 'entered-in-error';
+  status: 'success' | 'data-requested' | 'data-required' | 'in-progress' | 'failure' | 'entered-in-error';
 
   /**
    * The patient for which the request was processed.

package/dist/HealthcareService.d.ts

@@ -405,7 +405,7 @@ export interface HealthcareServiceNotAvailable {
    * The reason that can be presented to the user as to why this time is
    * not available.
    */
-  description?: string;
+  description: string;
 
   /**
    * Service is not available (seasonally or for a public holiday) from

package/dist/IdentityProvider.d.ts

@@ -11,12 +11,12 @@ export interface IdentityProvider {
   /**
    * Remote URL for the external Identity Provider authorize endpoint.
    */
-  authorizeUrl?: string;
+  authorizeUrl: string;
 
   /**
    * Remote URL for the external Identity Provider token endpoint.
    */
-  tokenUrl?: string;
+  tokenUrl: string;
 
   /**
    * Client Authentication method used by Clients to authenticate to the
@@ -28,17 +28,17 @@ export interface IdentityProvider {
   /**
    * Remote URL for the external Identity Provider userinfo endpoint.
    */
-  userInfoUrl?: string;
+  userInfoUrl: string;
 
   /**
    * External Identity Provider client ID.
    */
-  clientId?: string;
+  clientId: string;
 
   /**
    * External Identity Provider client secret.
    */
-  clientSecret?: string;
+  clientSecret: string;
 
   /**
    * Optional flag to use PKCE in the token request.

package/dist/ImagingStudy.d.ts

@@ -131,7 +131,7 @@ export interface ImagingStudy {
   /**
    * The current state of the ImagingStudy.
    */
-  status?: 'registered' | 'available' | 'cancelled' | 'entered-in-error' | 'unknown';
+  status: 'registered' | 'available' | 'cancelled' | 'entered-in-error' | 'unknown';
 
   /**
    * A list of all the series.modality values that are actual acquisition
@@ -143,7 +143,7 @@ export interface ImagingStudy {
   /**
    * The subject, typically a patient, of the imaging study.
    */
-  subject?: Reference<Patient | Device | Group>;
+  subject: Reference<Patient | Device | Group>;
 
   /**
    * The healthcare event (e.g. a patient and healthcare provider
@@ -286,7 +286,7 @@ export interface ImagingStudySeries {
   /**
    * The DICOM Series Instance UID for the series.
    */
-  uid?: string;
+  uid: string;
 
   /**
    * The numeric identifier of this series in the study.
@@ -296,7 +296,7 @@ export interface ImagingStudySeries {
   /**
    * The modality of this series sequence.
    */
-  modality?: Coding;
+  modality: Coding;
 
   /**
    * A description of the series.
@@ -402,12 +402,12 @@ export interface ImagingStudySeriesInstance {
   /**
    * The DICOM SOP Instance UID for this image or other DICOM content.
    */
-  uid?: string;
+  uid: string;
 
   /**
    * DICOM instance  type.
    */
-  sopClass?: Coding;
+  sopClass: Coding;
 
   /**
    * The number of instance in the series.
@@ -468,5 +468,5 @@ export interface ImagingStudySeriesPerformer {
   /**
    * Indicates who or what performed the series.
    */
-  actor?: Reference<Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson>;
+  actor: Reference<Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson>;
 }