@medplum/fhirtypes 0.3.0

package/dist/Consent.d.ts

@@ -0,0 +1,529 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Attachment } from './Attachment';
+import { CareTeam } from './CareTeam';
+import { CodeableConcept } from './CodeableConcept';
+import { Coding } from './Coding';
+import { Contract } from './Contract';
+import { Device } from './Device';
+import { DocumentReference } from './DocumentReference';
+import { Extension } from './Extension';
+import { Group } from './Group';
+import { Identifier } from './Identifier';
+import { Meta } from './Meta';
+import { Narrative } from './Narrative';
+import { Organization } from './Organization';
+import { Patient } from './Patient';
+import { Period } from './Period';
+import { Practitioner } from './Practitioner';
+import { PractitionerRole } from './PractitionerRole';
+import { QuestionnaireResponse } from './QuestionnaireResponse';
+import { Reference } from './Reference';
+import { RelatedPerson } from './RelatedPerson';
+import { Resource } from './Resource';
+
+/**
+ * A record of a healthcare consumer’s  choices, which permits or denies
+ * identified recipient(s) or recipient role(s) to perform one or more
+ * actions within a given policy context, for specific purposes and
+ * periods of time.
+ */
+export interface Consent {
+
+  /**
+   * This is a Consent resource
+   */
+  readonly resourceType: 'Consent';
+
+  /**
+   * The logical id of the resource, as used in the URL for the resource.
+   * Once assigned, this value never changes.
+   */
+  readonly id?: string;
+
+  /**
+   * The metadata about the resource. This is content that is maintained by
+   * the infrastructure. Changes to the content might not always be
+   * associated with version changes to the resource.
+   */
+  readonly meta?: Meta;
+
+  /**
+   * A reference to a set of rules that were followed when the resource was
+   * constructed, and which must be understood when processing the content.
+   * Often, this is a reference to an implementation guide that defines the
+   * special rules along with other profiles etc.
+   */
+  readonly implicitRules?: string;
+
+  /**
+   * The base language in which the resource is written.
+   */
+  readonly language?: string;
+
+  /**
+   * A human-readable narrative that contains a summary of the resource and
+   * can be used to represent the content of the resource to a human. The
+   * narrative need not encode all the structured data, but is required to
+   * contain sufficient detail to make it "clinically safe" for a human to
+   * just read the narrative. Resource definitions may define what content
+   * should be represented in the narrative to ensure clinical safety.
+   */
+  readonly text?: Narrative;
+
+  /**
+   * These resources do not have an independent existence apart from the
+   * resource that contains them - they cannot be identified independently,
+   * and nor can they have their own independent transaction scope.
+   */
+  readonly contained?: Resource[];
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the resource. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the resource and that modifies the
+   * understanding of the element that contains it and/or the understanding
+   * of the containing element's descendants. Usually modifier elements
+   * provide negation or qualification. To make the use of extensions safe
+   * and manageable, there is a strict set of governance applied to the
+   * definition and use of extensions. Though any implementer is allowed to
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension. Applications processing a
+   * resource are required to check for modifier extensions.
+   *
+   * Modifier extensions SHALL NOT change the meaning of any elements on
+   * Resource or DomainResource (including cannot change the meaning of
+   * modifierExtension itself).
+   */
+  readonly modifierExtension?: Extension[];
+
+  /**
+   * Unique identifier for this copy of the Consent Statement.
+   */
+  readonly identifier?: Identifier[];
+
+  /**
+   * Indicates the current state of this consent.
+   */
+  readonly status?: string;
+
+  /**
+   * A selector of the type of consent being presented: ADR, Privacy,
+   * Treatment, Research.  This list is now extensible.
+   */
+  readonly scope?: CodeableConcept;
+
+  /**
+   * A classification of the type of consents found in the statement. This
+   * element supports indexing and retrieval of consent statements.
+   */
+  readonly category?: CodeableConcept[];
+
+  /**
+   * The patient/healthcare consumer to whom this consent applies.
+   */
+  readonly patient?: Reference<Patient>;
+
+  /**
+   * When this  Consent was issued / created / indexed.
+   */
+  readonly dateTime?: string;
+
+  /**
+   * Either the Grantor, which is the entity responsible for granting the
+   * rights listed in a Consent Directive or the Grantee, which is the
+   * entity responsible for complying with the Consent Directive, including
+   * any obligations or limitations on authorizations and enforcement of
+   * prohibitions.
+   */
+  readonly performer?: Reference<Organization | Patient | Practitioner | RelatedPerson | PractitionerRole>[];
+
+  /**
+   * The organization that manages the consent, and the framework within
+   * which it is executed.
+   */
+  readonly organization?: Reference<Organization>[];
+
+  /**
+   * The source on which this consent statement is based. The source might
+   * be a scanned original paper form, or a reference to a consent that
+   * links back to such a source, a reference to a document repository
+   * (e.g. XDS) that stores the original consent document.
+   */
+  readonly sourceAttachment?: Attachment;
+
+  /**
+   * The source on which this consent statement is based. The source might
+   * be a scanned original paper form, or a reference to a consent that
+   * links back to such a source, a reference to a document repository
+   * (e.g. XDS) that stores the original consent document.
+   */
+  readonly sourceReference?: Reference<Consent | DocumentReference | Contract | QuestionnaireResponse>;
+
+  /**
+   * The references to the policies that are included in this consent
+   * scope. Policies may be organizational, but are often defined
+   * jurisdictionally, or in law.
+   */
+  readonly policy?: ConsentPolicy[];
+
+  /**
+   * A reference to the specific base computable regulation or policy.
+   */
+  readonly policyRule?: CodeableConcept;
+
+  /**
+   * Whether a treatment instruction (e.g. artificial respiration yes or
+   * no) was verified with the patient, his/her family or another
+   * authorized person.
+   */
+  readonly verification?: ConsentVerification[];
+
+  /**
+   * An exception to the base policy of this consent. An exception can be
+   * an addition or removal of access permissions.
+   */
+  readonly provision?: ConsentProvision;
+}
+
+/**
+ * The references to the policies that are included in this consent
+ * scope. Policies may be organizational, but are often defined
+ * jurisdictionally, or in law.
+ */
+export interface ConsentPolicy {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly id?: string;
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element and that modifies the
+   * understanding of the element in which it is contained and/or the
+   * understanding of the containing element's descendants. Usually
+   * modifier elements provide negation or qualification. To make the use
+   * of extensions safe and manageable, there is a strict set of governance
+   * applied to the definition and use of extensions. Though any
+   * implementer can define an extension, there is a set of requirements
+   * that SHALL be met as part of the definition of the extension.
+   * Applications processing a resource are required to check for modifier
+   * extensions.
+   *
+   * Modifier extensions SHALL NOT change the meaning of any elements on
+   * Resource or DomainResource (including cannot change the meaning of
+   * modifierExtension itself).
+   */
+  readonly modifierExtension?: Extension[];
+
+  /**
+   * Entity or Organization having regulatory jurisdiction or
+   * accountability for  enforcing policies pertaining to Consent
+   * Directives.
+   */
+  readonly authority?: string;
+
+  /**
+   * The references to the policies that are included in this consent
+   * scope. Policies may be organizational, but are often defined
+   * jurisdictionally, or in law.
+   */
+  readonly uri?: string;
+}
+
+/**
+ * An exception to the base policy of this consent. An exception can be
+ * an addition or removal of access permissions.
+ */
+export interface ConsentProvision {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly id?: string;
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element and that modifies the
+   * understanding of the element in which it is contained and/or the
+   * understanding of the containing element's descendants. Usually
+   * modifier elements provide negation or qualification. To make the use
+   * of extensions safe and manageable, there is a strict set of governance
+   * applied to the definition and use of extensions. Though any
+   * implementer can define an extension, there is a set of requirements
+   * that SHALL be met as part of the definition of the extension.
+   * Applications processing a resource are required to check for modifier
+   * extensions.
+   *
+   * Modifier extensions SHALL NOT change the meaning of any elements on
+   * Resource or DomainResource (including cannot change the meaning of
+   * modifierExtension itself).
+   */
+  readonly modifierExtension?: Extension[];
+
+  /**
+   * Action  to take - permit or deny - when the rule conditions are met.
+   * Not permitted in root rule, required in all nested rules.
+   */
+  readonly type?: string;
+
+  /**
+   * The timeframe in this rule is valid.
+   */
+  readonly period?: Period;
+
+  /**
+   * Who or what is controlled by this rule. Use group to identify a set of
+   * actors by some property they share (e.g. 'admitting officers').
+   */
+  readonly actor?: ConsentProvisionActor[];
+
+  /**
+   * Actions controlled by this Rule.
+   */
+  readonly action?: CodeableConcept[];
+
+  /**
+   * A security label, comprised of 0..* security label fields (Privacy
+   * tags), which define which resources are controlled by this exception.
+   */
+  readonly securityLabel?: Coding[];
+
+  /**
+   * The context of the activities a user is taking - why the user is
+   * accessing the data - that are controlled by this rule.
+   */
+  readonly purpose?: Coding[];
+
+  /**
+   * The class of information covered by this rule. The type can be a FHIR
+   * resource type, a profile on a type, or a CDA document, or some other
+   * type that indicates what sort of information the consent relates to.
+   */
+  readonly class?: Coding[];
+
+  /**
+   * If this code is found in an instance, then the rule applies.
+   */
+  readonly code?: CodeableConcept[];
+
+  /**
+   * Clinical or Operational Relevant period of time that bounds the data
+   * controlled by this rule.
+   */
+  readonly dataPeriod?: Period;
+
+  /**
+   * The resources controlled by this rule if specific resources are
+   * referenced.
+   */
+  readonly data?: ConsentProvisionData[];
+
+  /**
+   * Rules which provide exceptions to the base rule or subrules.
+   */
+  readonly provision?: ConsentProvision[];
+}
+
+/**
+ * Who or what is controlled by this rule. Use group to identify a set of
+ * actors by some property they share (e.g. 'admitting officers').
+ */
+export interface ConsentProvisionActor {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly id?: string;
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element and that modifies the
+   * understanding of the element in which it is contained and/or the
+   * understanding of the containing element's descendants. Usually
+   * modifier elements provide negation or qualification. To make the use
+   * of extensions safe and manageable, there is a strict set of governance
+   * applied to the definition and use of extensions. Though any
+   * implementer can define an extension, there is a set of requirements
+   * that SHALL be met as part of the definition of the extension.
+   * Applications processing a resource are required to check for modifier
+   * extensions.
+   *
+   * Modifier extensions SHALL NOT change the meaning of any elements on
+   * Resource or DomainResource (including cannot change the meaning of
+   * modifierExtension itself).
+   */
+  readonly modifierExtension?: Extension[];
+
+  /**
+   * How the individual is involved in the resources content that is
+   * described in the exception.
+   */
+  readonly role?: CodeableConcept;
+
+  /**
+   * The resource that identifies the actor. To identify actors by type,
+   * use group to identify a set of actors by some property they share
+   * (e.g. 'admitting officers').
+   */
+  readonly reference?: Reference<Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole>;
+}
+
+/**
+ * The resources controlled by this rule if specific resources are
+ * referenced.
+ */
+export interface ConsentProvisionData {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly id?: string;
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element and that modifies the
+   * understanding of the element in which it is contained and/or the
+   * understanding of the containing element's descendants. Usually
+   * modifier elements provide negation or qualification. To make the use
+   * of extensions safe and manageable, there is a strict set of governance
+   * applied to the definition and use of extensions. Though any
+   * implementer can define an extension, there is a set of requirements
+   * that SHALL be met as part of the definition of the extension.
+   * Applications processing a resource are required to check for modifier
+   * extensions.
+   *
+   * Modifier extensions SHALL NOT change the meaning of any elements on
+   * Resource or DomainResource (including cannot change the meaning of
+   * modifierExtension itself).
+   */
+  readonly modifierExtension?: Extension[];
+
+  /**
+   * How the resource reference is interpreted when testing consent
+   * restrictions.
+   */
+  readonly meaning?: string;
+
+  /**
+   * A reference to a specific resource that defines which resources are
+   * covered by this consent.
+   */
+  readonly reference?: Reference<Resource>;
+}
+
+/**
+ * Whether a treatment instruction (e.g. artificial respiration yes or
+ * no) was verified with the patient, his/her family or another
+ * authorized person.
+ */
+export interface ConsentVerification {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly id?: string;
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element and that modifies the
+   * understanding of the element in which it is contained and/or the
+   * understanding of the containing element's descendants. Usually
+   * modifier elements provide negation or qualification. To make the use
+   * of extensions safe and manageable, there is a strict set of governance
+   * applied to the definition and use of extensions. Though any
+   * implementer can define an extension, there is a set of requirements
+   * that SHALL be met as part of the definition of the extension.
+   * Applications processing a resource are required to check for modifier
+   * extensions.
+   *
+   * Modifier extensions SHALL NOT change the meaning of any elements on
+   * Resource or DomainResource (including cannot change the meaning of
+   * modifierExtension itself).
+   */
+  readonly modifierExtension?: Extension[];
+
+  /**
+   * Has the instruction been verified.
+   */
+  readonly verified?: boolean;
+
+  /**
+   * Who verified the instruction (Patient, Relative or other Authorized
+   * Person).
+   */
+  readonly verifiedWith?: Reference<Patient | RelatedPerson>;
+
+  /**
+   * Date verification was collected.
+   */
+  readonly verificationDate?: string;
+}

package/dist/ContactDetail.d.ts

@@ -0,0 +1,41 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { ContactPoint } from './ContactPoint';
+import { Extension } from './Extension';
+
+/**
+ * Base StructureDefinition for ContactDetail Type: Specifies contact
+ * information for a person or organization.
+ */
+export interface ContactDetail {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly id?: string;
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * The name of an individual to contact.
+   */
+  readonly name?: string;
+
+  /**
+   * The contact details for the individual (if a name was provided) or the
+   * organization.
+   */
+  readonly telecom?: ContactPoint[];
+}

package/dist/ContactPoint.d.ts

@@ -0,0 +1,60 @@
+/*
+ * Generated by @medplum/generator
+ * Do not edit manually.
+ */
+
+import { Extension } from './Extension';
+import { Period } from './Period';
+
+/**
+ * Base StructureDefinition for ContactPoint Type: Details for all kinds
+ * of technology mediated contact points for a person or organization,
+ * including telephone, email, etc.
+ */
+export interface ContactPoint {
+
+  /**
+   * Unique id for the element within a resource (for internal references).
+   * This may be any string value that does not contain spaces.
+   */
+  readonly id?: string;
+
+  /**
+   * May be used to represent additional information that is not part of
+   * the basic definition of the element. To make the use of extensions
+   * safe and manageable, there is a strict set of governance  applied to
+   * the definition and use of extensions. Though any implementer can
+   * define an extension, there is a set of requirements that SHALL be met
+   * as part of the definition of the extension.
+   */
+  readonly extension?: Extension[];
+
+  /**
+   * Telecommunications form for contact point - what communications system
+   * is required to make use of the contact.
+   */
+  readonly system?: string;
+
+  /**
+   * The actual contact point details, in a form that is meaningful to the
+   * designated communication system (i.e. phone number or email address).
+   */
+  readonly value?: string;
+
+  /**
+   * Identifies the purpose for the contact point.
+   */
+  readonly use?: string;
+
+  /**
+   * Specifies a preferred order in which to use a set of contacts.
+   * ContactPoints with lower rank values are more preferred than those
+   * with higher rank values.
+   */
+  readonly rank?: number;
+
+  /**
+   * Time period when the contact point was/is in use.
+   */
+  readonly period?: Period;
+}