@medplum/fhirtypes 2.2.10 → 3.0.0

package/dist/RequestGroup.d.ts

@@ -156,13 +156,13 @@ export interface RequestGroup {
    * The current state of the request. For request groups, the status
    * reflects the status of all the requests in the group.
    */
-  status?: 'draft' | 'active' | 'on-hold' | 'revoked' | 'completed' | 'entered-in-error' | 'unknown';
+  status: 'draft' | 'active' | 'on-hold' | 'revoked' | 'completed' | 'entered-in-error' | 'unknown';
 
   /**
    * Indicates the level of authority/intentionality associated with the
    * request and where the request fits into the workflow chain.
    */
-  intent?: 'proposal' | 'plan' | 'directive' | 'order' | 'original-order' | 'reflex-order' | 'filler-order' | 'instance-order' | 'option';
+  intent: 'proposal' | 'plan' | 'directive' | 'order' | 'original-order' | 'reflex-order' | 'filler-order' | 'instance-order' | 'option';
 
   /**
    * Indicates how quickly the request should be addressed with respect to
@@ -435,7 +435,7 @@ export interface RequestGroupActionCondition {
   /**
    * The kind of condition.
    */
-  kind?: 'applicability' | 'start' | 'stop';
+  kind: 'applicability' | 'start' | 'stop';
 
   /**
    * An expression that returns true or false, indicating whether or not
@@ -488,12 +488,12 @@ export interface RequestGroupActionRelatedAction {
   /**
    * The element id of the action this is related to.
    */
-  actionId?: string;
+  actionId: string;
 
   /**
    * The relationship of this action to the related action.
    */
-  relationship?: 'before-start' | 'before' | 'before-end' | 'concurrent-with-start' | 'concurrent' |
+  relationship: 'before-start' | 'before' | 'before-end' | 'concurrent-with-start' | 'concurrent' |
       'concurrent-with-end' | 'after-start' | 'after' | 'after-end';
 
   /**

package/dist/ResearchDefinition.d.ts

@@ -162,7 +162,7 @@ export interface ResearchDefinition {
    * The status of this research 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 research definition is authored
@@ -319,7 +319,7 @@ export interface ResearchDefinition {
    * A reference to a ResearchElementDefinition resource that defines the
    * population for the research.
    */
-  population?: Reference<ResearchElementDefinition>;
+  population: Reference<ResearchElementDefinition>;
 
   /**
    * A reference to a ResearchElementDefinition resource that defines the

package/dist/ResearchElementDefinition.d.ts

@@ -166,7 +166,7 @@ export interface ResearchElementDefinition {
    * The status of this research element 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 research element definition is
@@ -326,7 +326,7 @@ export interface ResearchElementDefinition {
    * The type of research element, a population, an exposure, or an
    * outcome.
    */
-  type?: 'population' | 'exposure' | 'outcome';
+  type: 'population' | 'exposure' | 'outcome';
 
   /**
    * The type of the outcome (e.g. Dichotomous, Continuous, or
@@ -338,7 +338,7 @@ export interface ResearchElementDefinition {
    * A characteristic that defines the members of the research element.
    * Multiple characteristics are applied with "and" semantics.
    */
-  characteristic?: ResearchElementDefinitionCharacteristic[];
+  characteristic: ResearchElementDefinitionCharacteristic[];
 }
 
 /**

package/dist/ResearchStudy.d.ts

@@ -134,7 +134,7 @@ export interface ResearchStudy {
   /**
    * The current state of the study.
    */
-  status?: 'active' | 'administratively-completed' | 'approved' | 'closed-to-accrual' |
+  status: 'active' | 'administratively-completed' | 'approved' | 'closed-to-accrual' |
       'closed-to-accrual-and-intervention' | 'completed' | 'disapproved' | 'in-review' | 'temporarily-closed-to-accrual' |
       'temporarily-closed-to-accrual-and-intervention' | 'withdrawn';
 
@@ -303,7 +303,7 @@ export interface ResearchStudyArm {
   /**
    * Unique, human-readable label for this arm of the study.
    */
-  name?: string;
+  name: string;
 
   /**
    * Categorization of study arm, e.g. experimental, active comparator,

package/dist/ResearchSubject.d.ts

@@ -104,7 +104,7 @@ export interface ResearchSubject {
   /**
    * The current state of the subject.
    */
-  status?: 'candidate' | 'eligible' | 'follow-up' | 'ineligible' | 'not-registered' | 'off-study' | 'on-study' |
+  status: 'candidate' | 'eligible' | 'follow-up' | 'ineligible' | 'not-registered' | 'off-study' | 'on-study' |
       'on-study-intervention' | 'on-study-observation' | 'pending-on-study' | 'potential-candidate' | 'screening' |
       'withdrawn';
 
@@ -117,12 +117,12 @@ export interface ResearchSubject {
   /**
    * Reference to the study the subject is participating in.
    */
-  study?: Reference<ResearchStudy>;
+  study: Reference<ResearchStudy>;
 
   /**
    * The record of the person or animal who is involved in the study.
    */
-  individual?: Reference<Patient>;
+  individual: Reference<Patient>;
 
   /**
    * The name of the arm in the study the subject is expected to follow as

package/dist/RiskAssessment.d.ts

@@ -126,7 +126,7 @@ export interface RiskAssessment {
    * The status of the RiskAssessment, using the same statuses as an
    * Observation.
    */
-  status?: 'registered' | 'preliminary' | 'final' | 'amended' | 'corrected' | 'cancelled' | 'entered-in-error' | 'unknown';
+  status: 'registered' | 'preliminary' | 'final' | 'amended' | 'corrected' | 'cancelled' | 'entered-in-error' | 'unknown';
 
   /**
    * The algorithm, process or mechanism used to evaluate the risk.
@@ -141,7 +141,7 @@ export interface RiskAssessment {
   /**
    * The patient or group the risk assessment applies to.
    */
-  subject?: Reference<Patient | Group>;
+  subject: Reference<Patient | Group>;
 
   /**
    * The encounter where the assessment was performed.

package/dist/RiskEvidenceSynthesis.d.ts

@@ -147,7 +147,7 @@ export interface RiskEvidenceSynthesis {
    * The status of this risk evidence synthesis. Enables tracking the
    * life-cycle of the content.
    */
-  status?: 'draft' | 'active' | 'retired' | 'unknown';
+  status: 'draft' | 'active' | 'retired' | 'unknown';
 
   /**
    * The date  (and optionally time) when the risk evidence synthesis was
@@ -277,7 +277,7 @@ export interface RiskEvidenceSynthesis {
    * A reference to a EvidenceVariable resource that defines the population
    * for the research.
    */
-  population?: Reference<EvidenceVariable>;
+  population: Reference<EvidenceVariable>;
 
   /**
    * A reference to a EvidenceVariable resource that defines the exposure
@@ -289,7 +289,7 @@ export interface RiskEvidenceSynthesis {
    * A reference to a EvidenceVariable resomece that defines the outcome
    * for the research.
    */
-  outcome?: Reference<EvidenceVariable>;
+  outcome: Reference<EvidenceVariable>;
 
   /**
    * A description of the size of the sample involved in the synthesis.

package/dist/SampledData.d.ts

@@ -32,12 +32,12 @@ export interface SampledData {
    * The base quantity that a measured value of zero represents. In
    * addition, this provides the units of the entire measurement series.
    */
-  origin?: Quantity;
+  origin: Quantity;
 
   /**
    * The length of time between sampling times, measured in milliseconds.
    */
-  period?: number;
+  period: number;
 
   /**
    * A correction factor that is applied to the sampled data points before
@@ -64,7 +64,7 @@ export interface SampledData {
    * greater than one, then the dimensions will be interlaced - all the
    * sample points for a point in time will be recorded at once.
    */
-  dimensions?: number;
+  dimensions: number;
 
   /**
    * A series of data points which are decimal values separated by a single

package/dist/Schedule.d.ts

@@ -133,7 +133,7 @@ export interface Schedule {
    * Slots that reference this schedule resource provide the availability
    * details to these referenced resource(s).
    */
-  actor?: Reference<Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location>[];
+  actor: Reference<Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location>[];
 
   /**
    * The period of time that the slots that reference this Schedule

package/dist/SearchParameter.d.ts

@@ -103,7 +103,7 @@ export interface SearchParameter {
    * can be the target of a canonical reference. It SHALL remain the same
    * when the search parameter is stored on different servers.
    */
-  url?: string;
+  url: string;
 
   /**
    * The identifier that is used to identify this version of the search
@@ -121,7 +121,7 @@ export interface SearchParameter {
    * should be usable as an identifier for the module by machine processing
    * applications such as code generation.
    */
-  name?: string;
+  name: string;
 
   /**
    * Where this search parameter is originally defined. If a derivedFrom is
@@ -136,7 +136,7 @@ export interface SearchParameter {
    * The status of this search parameter. 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 search parameter is authored for
@@ -168,7 +168,7 @@ export interface SearchParameter {
   /**
    * And how it used.
    */
-  description?: string;
+  description: string;
 
   /**
    * The content was developed with a focus and intent of supporting the
@@ -195,19 +195,19 @@ export interface SearchParameter {
    * The code used in the URL or the parameter name in a parameters
    * resource for this search parameter.
    */
-  code?: string;
+  code: string;
 
   /**
    * The base resource type(s) that this search parameter can be used
    * against.
    */
-  base?: ResourceType[];
+  base: ResourceType[];
 
   /**
    * The type of value that a search parameter may contain, and how the
    * content is interpreted.
    */
-  type?: 'number' | 'date' | 'string' | 'token' | 'reference' | 'composite' | 'quantity' | 'uri' | 'special';
+  type: 'number' | 'date' | 'string' | 'token' | 'reference' | 'composite' | 'quantity' | 'uri' | 'special';
 
   /**
    * A FHIRPath expression that returns a set of elements for the search
@@ -315,11 +315,11 @@ export interface SearchParameterComponent {
   /**
    * The definition of the search parameter that describes this part.
    */
-  definition?: string;
+  definition: string;
 
   /**
    * A sub-expression that defines how to extract values for this component
    * from the output of the main SearchParameter.expression.
    */
-  expression?: string;
+  expression: string;
 }

package/dist/ServiceRequest.d.ts

@@ -161,13 +161,13 @@ export interface ServiceRequest {
   /**
    * The status of the order.
    */
-  status?: 'draft' | 'active' | 'on-hold' | 'revoked' | 'completed' | 'entered-in-error' | 'unknown';
+  status: 'draft' | 'active' | 'on-hold' | 'revoked' | 'completed' | 'entered-in-error' | 'unknown';
 
   /**
    * Whether the request is a proposal, plan, an original order or a reflex
    * order.
    */
-  intent?: 'proposal' | 'plan' | 'directive' | 'order' | 'original-order' | 'reflex-order' | 'filler-order' | 'instance-order' | 'option';
+  intent: 'proposal' | 'plan' | 'directive' | 'order' | 'original-order' | 'reflex-order' | 'filler-order' | 'instance-order' | 'option';
 
   /**
    * A code that classifies the service for searching, sorting and display
@@ -230,7 +230,7 @@ export interface ServiceRequest {
    * or animals, devices such as dialysis machines, or even locations
    * (typically for environmental scans).
    */
-  subject?: Reference<Patient | Group | Location | Device>;
+  subject: Reference<Patient | Group | Location | Device>;
 
   /**
    * An encounter that provides additional information about the healthcare

package/dist/Signature.d.ts

@@ -45,18 +45,18 @@ export interface Signature {
    * can be used when determining accountability for various actions
    * concerning the document.
    */
-  type?: Coding[];
+  type: Coding[];
 
   /**
    * When the digital signature was signed.
    */
-  when?: string;
+  when: string;
 
   /**
    * A reference to an application-usable description of the identity that
    * signed  (e.g. the signature used their private key).
    */
-  who?: Reference<Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization>;
+  who: Reference<Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization>;
 
   /**
    * A reference to an application-usable description of the identity that

package/dist/Slot.d.ts

@@ -129,22 +129,22 @@ export interface Slot {
    * The schedule resource that this slot defines an interval of status
    * information.
    */
-  schedule?: Reference<Schedule>;
+  schedule: Reference<Schedule>;
 
   /**
    * busy | free | busy-unavailable | busy-tentative | entered-in-error.
    */
-  status?: 'busy' | 'free' | 'busy-unavailable' | 'busy-tentative' | 'entered-in-error';
+  status: 'busy' | 'free' | 'busy-unavailable' | 'busy-tentative' | 'entered-in-error';
 
   /**
    * Date/Time that the slot is to begin.
    */
-  start?: string;
+  start: string;
 
   /**
    * Date/Time that the slot is to conclude.
    */
-  end?: string;
+  end: string;
 
   /**
    * This slot has already been overbooked, appointments are unlikely to be

package/dist/SpecimenDefinition.d.ts

@@ -182,7 +182,7 @@ export interface SpecimenDefinitionTypeTested {
   /**
    * The preference for this type of conditioned specimen.
    */
-  preference?: 'preferred' | 'alternate';
+  preference: 'preferred' | 'alternate';
 
   /**
    * The specimen's container.

package/dist/StructureDefinition.d.ts

@@ -107,7 +107,7 @@ export interface StructureDefinition {
    * SHALL remain the same when the structure definition is stored on
    * different servers.
    */
-  url?: string;
+  url: string;
 
   /**
    * A formal identifier that is used to identify this structure definition
@@ -132,7 +132,7 @@ export interface StructureDefinition {
    * name should be usable as an identifier for the module by machine
    * processing applications such as code generation.
    */
-  name?: string;
+  name: string;
 
   /**
    * A short, descriptive, user-friendly title for the structure
@@ -144,7 +144,7 @@ export interface StructureDefinition {
    * The status of this structure 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 structure definition is authored
@@ -232,7 +232,7 @@ export interface StructureDefinition {
   /**
    * Defines the kind of structure that this definition is describing.
    */
-  kind?: 'primitive-type' | 'complex-type' | 'resource' | 'logical';
+  kind: 'primitive-type' | 'complex-type' | 'resource' | 'logical';
 
   /**
    * Whether structure this definition describes is abstract or not  - that
@@ -240,7 +240,7 @@ export interface StructureDefinition {
    * Resources and Data types, abstract types will never be exchanged
    * between systems.
    */
-  abstract?: boolean;
+  abstract: boolean;
 
   /**
    * Identifies the types of resource or data type elements to which the
@@ -266,7 +266,7 @@ export interface StructureDefinition {
    * to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are
    * only allowed in logical models.
    */
-  type?: string;
+  type: string;
 
   /**
    * An absolute URI that is the base structure from which this type is
@@ -337,13 +337,13 @@ export interface StructureDefinitionContext {
    * Defines how to interpret the expression that defines what the context
    * of the extension is.
    */
-  type?: 'fhirpath' | 'element' | 'extension';
+  type: 'fhirpath' | 'element' | 'extension';
 
   /**
    * An expression that defines where an extension can be used in
    * resources.
    */
-  expression?: string;
+  expression: string;
 }
 
 /**
@@ -390,7 +390,7 @@ export interface StructureDefinitionDifferential {
   /**
    * Captures constraints on each element within the resource.
    */
-  element?: ElementDefinition[];
+  element: ElementDefinition[];
 }
 
 /**
@@ -437,7 +437,7 @@ export interface StructureDefinitionMapping {
    * An Internal id that is used to identify this mapping set when specific
    * mappings are made.
    */
-  identity?: string;
+  identity: string;
 
   /**
    * An absolute URI that identifies the specification that this mapping is
@@ -501,5 +501,5 @@ export interface StructureDefinitionSnapshot {
   /**
    * Captures constraints on each element within the resource.
    */
-  element?: ElementDefinition[];
+  element: ElementDefinition[];
 }

package/dist/StructureMap.d.ts

@@ -129,7 +129,7 @@ export interface StructureMap {
    * be the target of a canonical reference. It SHALL remain the same when
    * the structure map is stored on different servers.
    */
-  url?: string;
+  url: string;
 
   /**
    * A formal identifier that is used to identify this structure map when
@@ -154,7 +154,7 @@ export interface StructureMap {
    * should be usable as an identifier for the module by machine processing
    * applications such as code generation.
    */
-  name?: string;
+  name: string;
 
   /**
    * A short, descriptive, user-friendly title for the structure map.
@@ -165,7 +165,7 @@ export interface StructureMap {
    * The status of this structure map. 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 structure map is authored for
@@ -244,7 +244,7 @@ export interface StructureMap {
    * Organizes the mapping into manageable chunks for human review/ease of
    * maintenance.
    */
-  group?: StructureMapGroup[];
+  group: StructureMapGroup[];
 }
 
 /**
@@ -291,7 +291,7 @@ export interface StructureMapGroup {
   /**
    * A unique name for the group for the convenience of human readers.
    */
-  name?: string;
+  name: string;
 
   /**
    * Another group that this group adds rules to.
@@ -302,7 +302,7 @@ export interface StructureMapGroup {
    * If this is the default rule set to apply for the source type or this
    * combination of types.
    */
-  typeMode?: 'none' | 'types' | 'type-and-types';
+  typeMode: 'none' | 'types' | 'type-and-types';
 
   /**
    * Additional supporting documentation that explains the purpose of the
@@ -314,12 +314,12 @@ export interface StructureMapGroup {
    * A name assigned to an instance of data. The instance must be provided
    * when the mapping is invoked.
    */
-  input?: StructureMapGroupInput[];
+  input: StructureMapGroupInput[];
 
   /**
    * Transform Rule from source to target.
    */
-  rule?: StructureMapGroupRule[];
+  rule: StructureMapGroupRule[];
 }
 
 /**
@@ -366,7 +366,7 @@ export interface StructureMapGroupInput {
   /**
    * Name for this instance of data.
    */
-  name?: string;
+  name: string;
 
   /**
    * Type for this instance of data.
@@ -376,7 +376,7 @@ export interface StructureMapGroupInput {
   /**
    * Mode for this instance of data.
    */
-  mode?: 'source' | 'target';
+  mode: 'source' | 'target';
 
   /**
    * Documentation for this instance of data.
@@ -427,12 +427,12 @@ export interface StructureMapGroupRule {
   /**
    * Name of the rule for internal references.
    */
-  name?: string;
+  name: string;
 
   /**
    * Source inputs to the mapping.
    */
-  source?: StructureMapGroupRuleSource[];
+  source: StructureMapGroupRuleSource[];
 
   /**
    * Content to create because of this mapping rule.
@@ -498,12 +498,12 @@ export interface StructureMapGroupRuleDependent {
   /**
    * Name of a rule or group to apply.
    */
-  name?: string;
+  name: string;
 
   /**
    * Variable to pass to the rule or group.
    */
-  variable?: string[];
+  variable: string[];
 }
 
 /**
@@ -549,7 +549,7 @@ export interface StructureMapGroupRuleSource {
   /**
    * Type or variable this rule applies to.
    */
-  context?: string;
+  context: string;
 
   /**
    * Specified minimum cardinality for the element. This is optional; if
@@ -1046,12 +1046,12 @@ export interface StructureMapStructure {
   /**
    * The canonical reference to the structure.
    */
-  url?: string;
+  url: string;
 
   /**
    * How the referenced structure is used in this mapping.
    */
-  mode?: 'source' | 'queried' | 'target' | 'produced';
+  mode: 'source' | 'queried' | 'target' | 'produced';
 
   /**
    * The name used for this type in the map.

package/dist/Subscription.d.ts

@@ -99,7 +99,7 @@ export interface Subscription {
    * The status of the subscription, which marks the server state for
    * managing the subscription.
    */
-  status?: 'requested' | 'active' | 'error' | 'off';
+  status: 'requested' | 'active' | 'error' | 'off';
 
   /**
    * Contact details for a human to contact about the subscription. The
@@ -115,13 +115,13 @@ export interface Subscription {
   /**
    * A description of why this subscription is defined.
    */
-  reason?: string;
+  reason: string;
 
   /**
    * The rules that the server should use to determine when to generate
    * notifications for this subscription.
    */
-  criteria?: string;
+  criteria: string;
 
   /**
    * A record of the last error that occurred when the server processed a
@@ -133,7 +133,7 @@ export interface Subscription {
    * Details where to send notifications when resources are received that
    * meet the criteria.
    */
-  channel?: SubscriptionChannel;
+  channel: SubscriptionChannel;
 }
 
 /**
@@ -180,7 +180,7 @@ export interface SubscriptionChannel {
   /**
    * The type of channel to send notifications on.
    */
-  type?: 'rest-hook' | 'websocket' | 'email' | 'sms' | 'message';
+  type: 'rest-hook' | 'websocket' | 'email' | 'sms' | 'message';
 
   /**
    * The url that describes the actual end-point to send messages to.

package/dist/SubscriptionStatus.d.ts

@@ -102,7 +102,7 @@ export interface SubscriptionStatus {
   /**
    * The type of event being conveyed with this notificaiton.
    */
-  type?: string;
+  type: string;
 
   /**
    * The total number of actual events which have been generated since the
@@ -121,7 +121,7 @@ export interface SubscriptionStatus {
   /**
    * The reference to the Subscription which generated this notification.
    */
-  subscription?: Reference<Subscription>;
+  subscription: Reference<Subscription>;
 
   /**
    * The reference to the SubscriptionTopic for the Subscription which
@@ -181,7 +181,7 @@ export interface SubscriptionStatusNotificationEvent {
    * The sequential number of this event in this subscription context. Note
    * that this value is a 64-bit integer value, encoded as a string.
    */
-  eventNumber?: string;
+  eventNumber: string;
 
   /**
    * The actual time this event occured on the server.