@medplum/fhirtypes 2.2.10 → 3.0.0

package/dist/AccessPolicy.d.ts

@@ -84,13 +84,13 @@ export interface AccessPolicyIpAccessRule {
    * An IP Access rule will apply a certain action to incoming traffic
    * based on the visitor IP address or IP range.
    */
-  value?: string;
+  value: string;
 
   /**
    * Access rule can perform one of the following actions: "allow" |
    * "block".
    */
-  action?: 'allow' | 'block';
+  action: 'allow' | 'block';
 }
 
 /**
@@ -101,7 +101,7 @@ export interface AccessPolicyResource {
   /**
    * The resource type.
    */
-  resourceType?: string;
+  resourceType: string;
 
   /**
    * DEPRECATED Optional compartment restriction for the resource type.

package/dist/Account.d.ts

@@ -113,7 +113,7 @@ export interface Account {
   /**
    * Indicates whether the account is presently used/usable or not.
    */
-  status?: 'active' | 'inactive' | 'entered-in-error' | 'on-hold' | 'unknown';
+  status: 'active' | 'inactive' | 'entered-in-error' | 'on-hold' | 'unknown';
 
   /**
    * Categorizes the account for reporting and searching purposes.
@@ -218,7 +218,7 @@ export interface AccountCoverage {
    * the sequence of the coverages in the account could be important when
    * processing billing.
    */
-  coverage?: Reference<Coverage>;
+  coverage: Reference<Coverage>;
 
   /**
    * The priority of the coverage in the context of this account.
@@ -270,7 +270,7 @@ export interface AccountGuarantor {
   /**
    * The entity who is responsible.
    */
-  party?: Reference<Patient | RelatedPerson | Organization>;
+  party: Reference<Patient | RelatedPerson | Organization>;
 
   /**
    * A guarantor may be placed on credit hold or otherwise have their role

package/dist/ActivityDefinition.d.ts

@@ -166,7 +166,7 @@ export interface ActivityDefinition {
    * The status of this activity 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 activity definition is authored
@@ -521,12 +521,12 @@ export interface ActivityDefinitionDynamicValue {
    * multiple-cardinality sub-elements (see the [Simple FHIRPath
    * Profile](fhirpath.html#simple) for full details).
    */
-  path?: string;
+  path: string;
 
   /**
    * An expression specifying the value of the customized element.
    */
-  expression?: Expression;
+  expression: Expression;
 }
 
 /**
@@ -572,7 +572,7 @@ export interface ActivityDefinitionParticipant {
   /**
    * The type of participant in the action.
    */
-  type?: 'patient' | 'practitioner' | 'related-person' | 'device';
+  type: 'patient' | 'practitioner' | 'related-person' | 'device';
 
   /**
    * The role the participant should play in performing the described

package/dist/AdverseEvent.d.ts

@@ -128,7 +128,7 @@ export interface AdverseEvent {
    * Note that this is independent of whether anyone was affected or harmed
    * or how severely.
    */
-  actuality?: 'actual' | 'potential';
+  actuality: 'actual' | 'potential';
 
   /**
    * The overall type of event, intended for search and filtering purposes.
@@ -144,7 +144,7 @@ export interface AdverseEvent {
   /**
    * This subject or group impacted by the event.
    */
-  subject?: Reference<Patient | Group | Practitioner | RelatedPerson>;
+  subject: Reference<Patient | Group | Practitioner | RelatedPerson>;
 
   /**
    * The Encounter during which AdverseEvent was created or to which the
@@ -283,7 +283,7 @@ export interface AdverseEventSuspectEntity {
    * be a substance, medication, medication administration, medication
    * statement or a device.
    */
-  instance?: Reference<Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device>;
+  instance: Reference<Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device>;
 
   /**
    * Information on the possible cause of the event.

package/dist/Agent.d.ts

@@ -55,12 +55,12 @@ export interface Agent {
   /**
    * The human readable friendly name of the agent.
    */
-  name?: string;
+  name: string;
 
   /**
    * The status of the agent.
    */
-  status?: 'active' | 'off' | 'error';
+  status: 'active' | 'off' | 'error';
 
   /**
    * Optional device resource representing the device running the agent.
@@ -88,13 +88,13 @@ export interface AgentChannel {
   /**
    * The channel name.
    */
-  name?: string;
+  name: string;
 
   /**
    * The channel endpoint definition including protocol and network binding
    * details.
    */
-  endpoint?: Reference<Endpoint>;
+  endpoint: Reference<Endpoint>;
 
   /**
    * The target resource where channel messages will be delivered.
@@ -115,7 +115,7 @@ export interface AgentSetting {
   /**
    * The setting name.
    */
-  name?: string;
+  name: string;
 
   /**
    * The setting value.

package/dist/AllergyIntolerance.d.ts

@@ -162,7 +162,7 @@ export interface AllergyIntolerance {
   /**
    * The patient who has the allergy or intolerance.
    */
-  patient?: Reference<Patient>;
+  patient: Reference<Patient>;
 
   /**
    * The encounter when the allergy or intolerance was asserted.
@@ -296,7 +296,7 @@ export interface AllergyIntoleranceReaction {
    * Clinical symptoms and/or signs that are observed or associated with
    * the adverse reaction event.
    */
-  manifestation?: CodeableConcept[];
+  manifestation: CodeableConcept[];
 
   /**
    * Text description about the reaction as a whole, including details of

package/dist/Annotation.d.ts

@@ -50,5 +50,5 @@ export interface Annotation {
   /**
    * The text of the annotation in markdown format.
    */
-  text?: string;
+  text: string;
 }

package/dist/Appointment.d.ts

@@ -121,7 +121,7 @@ export interface Appointment {
    * their own participation status which indicates their involvement in
    * the process, however this status indicates the shared status.
    */
-  status?: 'proposed' | 'pending' | 'booked' | 'arrived' | 'fulfilled' | 'cancelled' | 'noshow' | 'entered-in-error' | 'checked-in' | 'waitlist';
+  status: 'proposed' | 'pending' | 'booked' | 'arrived' | 'fulfilled' | 'cancelled' | 'noshow' | 'entered-in-error' | 'checked-in' | 'waitlist';
 
   /**
    * The coded reason for the appointment being cancelled. This is often
@@ -245,7 +245,7 @@ export interface Appointment {
   /**
    * List of participants involved in the appointment.
    */
-  participant?: AppointmentParticipant[];
+  participant: AppointmentParticipant[];
 
   /**
    * A set of date ranges (potentially including times) that the
@@ -321,7 +321,7 @@ export interface AppointmentParticipant {
   /**
    * Participation status of the actor.
    */
-  status?: 'accepted' | 'declined' | 'tentative' | 'needs-action';
+  status: 'accepted' | 'declined' | 'tentative' | 'needs-action';
 
   /**
    * Participation period of the actor.

package/dist/AppointmentResponse.d.ts

@@ -112,7 +112,7 @@ export interface AppointmentResponse {
   /**
    * Appointment that this response is replying to.
    */
-  appointment?: Reference<Appointment>;
+  appointment: Reference<Appointment>;
 
   /**
    * Date/Time that the appointment is to take place, or requested new
@@ -145,7 +145,7 @@ export interface AppointmentResponse {
    * When the status is accepted, the times can either be the time of the
    * appointment (as a confirmation of the time) or can be empty.
    */
-  participantStatus?: 'accepted' | 'declined' | 'tentative' | 'needs-action';
+  participantStatus: 'accepted' | 'declined' | 'tentative' | 'needs-action';
 
   /**
    * Additional comments about the appointment.

package/dist/AsyncJob.d.ts

@@ -44,12 +44,12 @@ export interface AsyncJob {
   /**
    * The status of the request.
    */
-  status?: 'accepted' | 'active' | 'completed' | 'error';
+  status: 'accepted' | 'active' | 'completed' | 'error';
 
   /**
    * Indicates the server's time when the query is requested.
    */
-  requestTime?: string;
+  requestTime: string;
 
   /**
    * Indicates the server's time when the query is run. The response SHOULD
@@ -63,5 +63,5 @@ export interface AsyncJob {
    * The full URL of the original kick-off request. In the case of a POST
    * request, this URL will not include the request parameters.
    */
-  request?: string;
+  request: string;
 }

package/dist/AuditEvent.d.ts

@@ -107,7 +107,7 @@ export interface AuditEvent {
    * program, rule, policy, function code, application name or URL. It
    * identifies the performed function.
    */
-  type?: Coding;
+  type: Coding;
 
   /**
    * Identifier for the category of event.
@@ -128,7 +128,7 @@ export interface AuditEvent {
   /**
    * The time when the event was recorded.
    */
-  recorded?: string;
+  recorded: string;
 
   /**
    * Indicates whether the event succeeded or failed.
@@ -150,12 +150,12 @@ export interface AuditEvent {
    * An actor taking an active role in the event or activity that is
    * logged.
    */
-  agent?: AuditEventAgent[];
+  agent: AuditEventAgent[];
 
   /**
    * The system that is reporting the event.
    */
-  source?: AuditEventSource;
+  source: AuditEventSource;
 
   /**
    * Specific instances of data or objects that have been accessed.
@@ -239,7 +239,7 @@ export interface AuditEventAgent {
    * Indicator that the user is or is not the requestor, or initiator, for
    * the event being audited.
    */
-  requestor?: boolean;
+  requestor: boolean;
 
   /**
    * Where the event occurred.
@@ -460,7 +460,7 @@ export interface AuditEventEntityDetail {
   /**
    * The type of extra detail provided in the value.
    */
-  type?: string;
+  type: string;
 
   /**
    * The  value of the extra detail.
@@ -523,7 +523,7 @@ export interface AuditEventSource {
   /**
    * Identifier of the source where the event was detected.
    */
-  observer?: Reference<PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson>;
+  observer: Reference<PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson>;
 
   /**
    * Code specifying the type of source where event originated.

package/dist/Basic.d.ts

@@ -110,7 +110,7 @@ export interface Basic {
    * Identifies the 'type' of resource - equivalent to the resource name
    * for other resources.
    */
-  code?: CodeableConcept;
+  code: CodeableConcept;
 
   /**
    * Identifies the patient, practitioner, device or any other resource

package/dist/Binary.d.ts

@@ -49,7 +49,7 @@ export interface Binary {
    * MimeType of the binary content represented as a standard MimeType (BCP
    * 13).
    */
-  contentType?: string;
+  contentType: string;
 
   /**
    * This element identifies another resource that can be used as a proxy

package/dist/BodyStructure.d.ts

@@ -138,5 +138,5 @@ export interface BodyStructure {
   /**
    * The person to which the body site belongs.
    */
-  patient?: Reference<Patient>;
+  patient: Reference<Patient>;
 }

package/dist/BulkDataExport.d.ts

@@ -45,12 +45,12 @@ export interface BulkDataExport {
   /**
    * The status of the request.
    */
-  status?: 'accepted' | 'active' | 'completed' | 'error';
+  status: 'accepted' | 'active' | 'completed' | 'error';
 
   /**
    * Indicates the server's time when the query is requested.
    */
-  requestTime?: string;
+  requestTime: string;
 
   /**
    * Indicates the server's time when the query is run. The response SHOULD
@@ -64,7 +64,7 @@ export interface BulkDataExport {
    * The full URL of the original Bulk Data kick-off request. In the case
    * of a POST request, this URL will not include the request parameters.
    */
-  request?: string;
+  request: string;
 
   /**
    * Indicates whether downloading the generated files requires the same
@@ -101,14 +101,14 @@ export interface BulkDataExportDeleted {
   /**
    * The FHIR resource type that is contained in the file.
    */
-  type?: ResourceType;
+  type: ResourceType;
 
   /**
    * The absolute path to the file. The format of the file SHOULD reflect
    * that requested in the _outputFormat parameter of the initial kick-off
    * request.
    */
-  url?: string;
+  url: string;
 }
 
 /**
@@ -120,14 +120,14 @@ export interface BulkDataExportError {
   /**
    * The FHIR resource type that is contained in the file.
    */
-  type?: ResourceType;
+  type: ResourceType;
 
   /**
    * The absolute path to the file. The format of the file SHOULD reflect
    * that requested in the _outputFormat parameter of the initial kick-off
    * request.
    */
-  url?: string;
+  url: string;
 }
 
 /**
@@ -140,12 +140,12 @@ export interface BulkDataExportOutput {
   /**
    * The FHIR resource type that is contained in the file.
    */
-  type?: ResourceType;
+  type: ResourceType;
 
   /**
    * The absolute path to the file. The format of the file SHOULD reflect
    * that requested in the _outputFormat parameter of the initial kick-off
    * request.
    */
-  url?: string;
+  url: string;
 }

package/dist/Bundle.d.ts

@@ -55,7 +55,7 @@ export interface Bundle<T extends Resource = Resource> {
   /**
    * Indicates the purpose of this bundle - how it is intended to be used.
    */
-  type?: 'document' | 'message' | 'transaction' | 'transaction-response' | 'batch' | 'batch-response' | 'history' | 'searchset' | 'collection';
+  type: 'document' | 'message' | 'transaction' | 'transaction-response' | 'batch' | 'batch-response' | 'history' | 'searchset' | 'collection';
 
   /**
    * The date/time that the bundle was assembled - i.e. when the resources
@@ -221,13 +221,13 @@ export interface BundleEntryRequest {
    * this entry. In a history bundle, this indicates the HTTP action that
    * occurred.
    */
-  method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  method: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
 
   /**
    * The URL for this entry, relative to the root (the address to which the
    * request is posted).
    */
-  url?: string;
+  url: string;
 
   /**
    * If the ETag values match, return a 304 Not Modified status. See the
@@ -304,7 +304,7 @@ export interface BundleEntryResponse {
    * start with a 3 digit HTTP code (e.g. 404) and may contain the standard
    * HTTP description associated with the status code.
    */
-  status?: string;
+  status: string;
 
   /**
    * The location header created by processing this operation, populated if
@@ -430,10 +430,10 @@ export interface BundleLink {
    * A name which details the functional use for this link - see
    * [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
    */
-  relation?: string;
+  relation: string;
 
   /**
    * The reference details for the link.
    */
-  url?: string;
+  url: string;
 }

package/dist/CapabilityStatement.d.ts

@@ -139,7 +139,7 @@ export interface CapabilityStatement {
    * The status of this capability statement. 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 capability statement is authored
@@ -155,7 +155,7 @@ export interface CapabilityStatement {
    * change when the substantive content of the capability statement
    * changes.
    */
-  date?: string;
+  date: string;
 
   /**
    * The name of the organization or individual that published the
@@ -212,7 +212,7 @@ export interface CapabilityStatement {
    * instance of software) or a class of implementation (e.g. a desired
    * purchase).
    */
-  kind?: 'instance' | 'capability' | 'requirements';
+  kind: 'instance' | 'capability' | 'requirements';
 
   /**
    * Reference to a canonical URL of another CapabilityStatement that this
@@ -252,14 +252,14 @@ export interface CapabilityStatement {
    * describes (which SHALL be the same as the FHIR version of the
    * CapabilityStatement itself). There is no default value.
    */
-  fhirVersion?: '0.01' | '0.05' | '0.06' | '0.11' | '0.0.80' | '0.0.81' | '0.0.82' | '0.4.0' | '0.5.0' | '1.0.0' |
+  fhirVersion: '0.01' | '0.05' | '0.06' | '0.11' | '0.0.80' | '0.0.81' | '0.0.82' | '0.4.0' | '0.5.0' | '1.0.0' |
       '1.0.1' | '1.0.2' | '1.1.0' | '1.4.0' | '1.6.0' | '1.8.0' | '3.0.0' | '3.0.1' | '3.3.0' | '3.5.0' | '4.0.0' | '4.0.1';
 
   /**
    * A list of the formats supported by this implementation using their
    * content types.
    */
-  format?: string[];
+  format: string[];
 
   /**
    * A list of the patch formats supported by this implementation using
@@ -333,7 +333,7 @@ export interface CapabilityStatementDocument {
    * Mode of this document declaration - whether an application is a
    * producer or consumer.
    */
-  mode?: 'producer' | 'consumer';
+  mode: 'producer' | 'consumer';
 
   /**
    * A description of how the application supports or uses the specified
@@ -346,7 +346,7 @@ export interface CapabilityStatementDocument {
    * A profile on the document Bundle that constrains which resources are
    * present, and their contents.
    */
-  profile?: string;
+  profile: string;
 }
 
 /**
@@ -395,7 +395,7 @@ export interface CapabilityStatementImplementation {
    * Information about the specific installation that this capability
    * statement relates to.
    */
-  description?: string;
+  description: string;
 
   /**
    * An absolute base URL for the implementation.  This forms the base for
@@ -523,13 +523,13 @@ export interface CapabilityStatementMessagingEndpoint {
    * A list of the messaging transport protocol(s) identifiers, supported
    * by this endpoint.
    */
-  protocol?: Coding;
+  protocol: Coding;
 
   /**
    * The network address of the endpoint. For solutions that do not use
    * network addresses for routing, it can be just an identifier.
    */
-  address?: string;
+  address: string;
 }
 
 /**
@@ -577,13 +577,13 @@ export interface CapabilityStatementMessagingSupportedMessage {
    * The mode of this event declaration - whether application is sender or
    * receiver.
    */
-  mode?: 'sender' | 'receiver';
+  mode: 'sender' | 'receiver';
 
   /**
    * Points to a message definition that identifies the messaging event,
    * message structure, allowed responses, etc.
    */
-  definition?: string;
+  definition: string;
 }
 
 /**
@@ -630,7 +630,7 @@ export interface CapabilityStatementRest {
    * Identifies whether this portion of the statement is describing the
    * ability to initiate or receive restful operations.
    */
-  mode?: 'client' | 'server';
+  mode: 'client' | 'server';
 
   /**
    * Information about the system's restful capabilities that apply across
@@ -720,7 +720,7 @@ export interface CapabilityStatementRestInteraction {
   /**
    * A coded identifier of the operation, supported by the system.
    */
-  code?: 'transaction' | 'batch' | 'search-system' | 'history-system';
+  code: 'transaction' | 'batch' | 'search-system' | 'history-system';
 
   /**
    * Guidance specific to the implementation of this operation, such as
@@ -774,7 +774,7 @@ export interface CapabilityStatementRestResource {
   /**
    * A type of resource exposed via the restful interface.
    */
-  type?: ResourceType;
+  type: ResourceType;
 
   /**
    * A specification of the profile that describes the solution's overall
@@ -926,7 +926,7 @@ export interface CapabilityStatementRestResourceInteraction {
   /**
    * Coded identifier of the operation, supported by the system resource.
    */
-  code?: 'read' | 'vread' | 'update' | 'patch' | 'delete' | 'history-instance' | 'history-type' | 'create' | 'search-type';
+  code: 'read' | 'vread' | 'update' | 'patch' | 'delete' | 'history-instance' | 'history-type' | 'create' | 'search-type';
 
   /**
    * Guidance specific to the implementation of this operation, such as
@@ -984,7 +984,7 @@ export interface CapabilityStatementRestResourceOperation {
    * prefixed with $ and used in the URL. For a query, this is the name
    * used in the _query parameter when the query is called.
    */
-  name?: string;
+  name: string;
 
   /**
    * Where the formal definition can be found. If a server references the
@@ -997,7 +997,7 @@ export interface CapabilityStatementRestResourceOperation {
    * 'base' of the original OperationDefinition.  The custom definition
    * would describe the specific subset of functionality supported.
    */
-  definition?: string;
+  definition: string;
 
   /**
    * Documentation that describes anything special about the operation
@@ -1052,7 +1052,7 @@ export interface CapabilityStatementRestResourceSearchParam {
   /**
    * The name of the search parameter used in the interface.
    */
-  name?: string;
+  name: string;
 
   /**
    * An absolute URI that is a formal reference to where this parameter was
@@ -1069,7 +1069,7 @@ export interface CapabilityStatementRestResourceSearchParam {
    * The type of value a search parameter refers to, 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';
 
   /**
    * This allows documentation of any distinct behaviors about how the
@@ -1181,7 +1181,7 @@ export interface CapabilityStatementSoftware {
   /**
    * Name the software is known by.
    */
-  name?: string;
+  name: string;
 
   /**
    * The version identifier for the software covered by this statement.

package/dist/CarePlan.d.ts

@@ -168,13 +168,13 @@ export interface CarePlan {
    * Indicates whether the plan is currently being acted upon, represents
    * future intentions or is now a historical record.
    */
-  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
    * care plan and where the care plan fits into the workflow chain.
    */
-  intent?: 'proposal' | 'plan' | 'order' | 'option';
+  intent: 'proposal' | 'plan' | 'order' | 'option';
 
   /**
    * Identifies what "kind" of plan this is to support differentiation
@@ -197,7 +197,7 @@ export interface CarePlan {
    * Identifies the patient or group whose intended care is described by
    * the plan.
    */
-  subject?: Reference<Patient | Group>;
+  subject: Reference<Patient | Group>;
 
   /**
    * The Encounter during which this CarePlan was created or to which the
@@ -439,7 +439,7 @@ export interface CarePlanActivityDetail {
   /**
    * Identifies what progress is being made for the specific activity.
    */
-  status?: 'not-started' | 'scheduled' | 'in-progress' | 'on-hold' | 'completed' | 'cancelled' | 'stopped' | 'unknown' | 'entered-in-error';
+  status: 'not-started' | 'scheduled' | 'in-progress' | 'on-hold' | 'completed' | 'cancelled' | 'stopped' | 'unknown' | 'entered-in-error';
 
   /**
    * Provides reason why the activity isn't yet started, is on hold, was