com.babylonhealth.lit.ukcore.model
Type members
Classlikes
Defines the UK Core constraints and extensions on the AllergyIntolerance resource for the minimal set of data to query and retrieve allergy information.
Defines the UK Core constraints and extensions on the AllergyIntolerance resource for the minimal set of data to query and retrieve allergy information.
Subclass of hl7.model.AllergyIntolerance (Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.)
- Value parameters:
- `type`
- Identification of the underlying physiological mechanism for the reaction risk.
- asserter
- The source of the information about the allergy that is recorded.
- category
- Category of the identified substance.
- clinicalStatus
- The clinical status of the allergy or intolerance.
- code
- Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
- contained
- 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.
- criticality
- Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
- encounter
- The encounter when the allergy or intolerance was asserted.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- lastOccurrence
- Represents the date and/or time of the last known occurrence of a reaction event.
- meta
- 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.
- modifierExtension
- 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).
- note
- Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
- onset
- Estimated or actual date, date-time, or age when allergy or intolerance was identified.
- patient
- The patient who has the allergy or intolerance.
- reaction
- Details about each adverse reaction event linked to exposure to the identified substance.
- recordedDate
- The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
- recorder
- Individual who recorded the record and takes responsibility for its content.
- text
- 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.
- verificationStatus
- Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
- Constructor:
Inherits all params from parent. Requires the following fields which were optional in the parent: code.
- Companion:
- object
Defines the UK Core constraints and extensions on the AuditEvent resource for the minimal set of data to query and retrieve information about an event created to maintain a security log.
Defines the UK Core constraints and extensions on the AuditEvent resource for the minimal set of data to query and retrieve information about an event created to maintain a security log.
Subclass of hl7.model.AuditEvent (A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.)
- Value parameters:
- `type`
- Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
- action
- Indicator for type of action performed during the event that generated the audit.
- agent
- An actor taking an active role in the event or activity that is logged.
- contained
- 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.
- entity
- Specific instances of data or objects that have been accessed.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- outcome
- Indicates whether the event succeeded or failed.
- outcomeDesc
- A free text description of the outcome of the event.
- period
- The period during which the activity occurred.
- purposeOfEvent
- The purposeOfUse (reason) that was used during the event being recorded.
- recorded
- The time when the event was recorded.
- source
- The system that is reporting the event.
- subtype
- Identifier for the category of event.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines a UK Core profile of a container for a collection of resources.
Defines a UK Core profile of a container for a collection of resources.
Subclass of hl7.model.Bundle (A container for a collection of resources.)
- Value parameters:
- `type`
- Indicates the purpose of this bundle - how it is intended to be used.
- entry
- An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- link
- A series of links that provide context to this bundle.
- meta
- 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.
- signature
- Digital Signature - base64 encoded. XML-DSig or a JWT.
- timestamp
- The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
- total
- If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the CarePlan resource for the minimal set of data to query and retrieve a patient’s Care Plan.
Defines the UK Core constraints and extensions on the CarePlan resource for the minimal set of data to query and retrieve a patient’s Care Plan.
Subclass of hl7.model.CarePlan (Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.)
- Value parameters:
- activity
- Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
- addresses
- Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
- author
- When populated, the author is responsible for the care plan. The care plan is attributed to the author.
- basedOn
- A care plan that is fulfilled in whole or in part by this care plan.
- careTeam
- Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
- category
- Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
- contained
- 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.
- contributor
- Identifies the individual(s) or organization who provided the contents of the care plan.
- created
- Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
- description
- A description of the scope and nature of the plan.
- encounter
- The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
- extension
- 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.
- goal
- Describes the intended objective(s) of carrying out the care plan.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- instantiatesCanonical
- The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
- instantiatesUri
- The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
- intent
- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- note
- General notes about the care plan not covered elsewhere.
- partOf
- A larger care plan of which this particular care plan is a component or step.
- period
- Indicates when the plan did (or is intended to) come into effect and end.
- replaces
- Completed or terminated care plan whose function is taken by this new care plan.
- status
- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
- subject
- Identifies the patient or group whose intended care is described by the plan.
- supportingInfo
- Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
- text
- 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.
- title
- Human-friendly name for the care plan.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve an individual’s care team.
Defines the UK Core constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve an individual’s care team.
Subclass of hl7.model.CareTeam (The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.)
- Value parameters:
- category
- Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.
- contained
- 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.
- encounter
- The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- managingOrganization
- The organization responsible for the care team.
- meta
- 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.
- modifierExtension
- 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).
- name
- A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
- note
- Comments made about the CareTeam.
- participant
- Identifies all people and organizations who are expected to be involved in the care team.
- period
- Indicates when the team did (or is intended to) come into effect and end.
- reasonCode
- Describes why the care team exists.
- reasonReference
- Condition(s) that this care team addresses.
- status
- Indicates the current state of the care team.
- subject
- Identifies the patient or group whose intended care is handled by the team.
- telecom
- A central contact detail for the care team (that applies to all members).
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Communication resource for the minimal set of data to query and retrieve communication information.
Defines the UK Core constraints and extensions on the Communication resource for the minimal set of data to query and retrieve communication information.
Subclass of hl7.model.Communication (An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.)
- Value parameters:
- about
- Other resources that pertain to this communication and to which this communication should be associated.
- basedOn
- An order, proposal or plan fulfilled in whole or in part by this Communication.
- category
- The type of message conveyed such as alert, notification, reminder, instruction, etc.
- contained
- 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.
- encounter
- The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- inResponseTo
- Prior communication that this communication is in response to.
- instantiatesCanonical
- The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
- instantiatesUri
- The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
- language
- The base language in which the resource is written.
- medium
- A channel that was used for this communication (e.g. email, fax).
- meta
- 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.
- modifierExtension
- 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).
- note
- Additional notes or commentary about the communication by the sender, receiver or other interested parties.
- partOf
- Part of this action.
- payload
- Text, attachment(s), or resource(s) that was communicated to the recipient.
- priority
- Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
- reasonCode
- The reason or justification for the communication.
- reasonReference
- Indicates another resource whose existence justifies this communication.
- received
- The time when this communication arrived at the destination.
- recipient
- The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
- sender
- The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
- sent
- The time when this communication was sent.
- status
- The status of the transmission.
- statusReason
- Captures the reason for the current state of the Communication.
- subject
- The patient or group that was the focus of this communication.
- text
- 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.
- topic
- Description of the purpose/content, similar to a subject line in an email.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Composition resource to enable a generic and flexible approach to FHIR document structures.
Defines the UK Core constraints and extensions on the Composition resource to enable a generic and flexible approach to FHIR document structures.
Subclass of hl7.model.Composition (A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).)
- Value parameters:
- `type`
- Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
- attester
- A participant who has attested to the accuracy of the composition/document.
- author
- Identifies who is responsible for the information in the composition, not necessarily who typed it in.
- category
- A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. Further investgation is required about the usage of this element for UK Core.
- confidentiality
- The code specifying the level of confidentiality of the Composition.
- contained
- 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.
- custodian
- Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
- date
- The composition editing time, when the composition was last logically changed by the author.
- encounter
- Describes the clinical encounter or type of care this documentation is associated with.
- event
- The clinical service, such as a colonoscopy or an appendectomy, being documented.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- relatesTo
- Relationships that this composition has with other compositions or documents that already exist.
- section
- The root of the sections that make up the composition.
- status
- The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
- subject
- Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
- text
- 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.
- title
- Official human-readable label for the composition.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Condition resource for the minimal set of data to query and retrieve problems and health concerns information.
Defines the UK Core constraints and extensions on the Condition resource for the minimal set of data to query and retrieve problems and health concerns information.
Subclass of hl7.model.Condition (A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.)
- Value parameters:
- abatement
- The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.
- asserter
- Individual who is making the condition statement.
- bodySite
- The anatomical location where this condition manifests itself.
- category
- A category assigned to the condition.
- clinicalStatus
- The clinical status of the condition.
- code
- Identification of the condition, problem or diagnosis.
- contained
- 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.
- encounter
- The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
- evidence
- Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- note
- Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
- onset
- Estimated or actual date or date-time the condition began, in the opinion of the clinician.
- recordedDate
- The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
- recorder
- Individual who recorded the record and takes responsibility for its content.
- severity
- A subjective assessment of the severity of the condition as evaluated by the clinician.
- stage
- Clinical stage or grade of a condition. May include formal severity assessments.
- subject
- Indicates the patient or group who the condition record is associated with.
- text
- 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.
- verificationStatus
- The verification status to support the clinical status of the condition.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Consent resource for the minimal set of data to query and retrieve consent information.
Defines the UK Core constraints and extensions on the Consent resource for the minimal set of data to query and retrieve consent information.
Subclass of hl7.model.Consent (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.)
- Value parameters:
- category
- A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
- contained
- 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.
- dateTime
- When this Consent was issued / created / indexed.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Unique identifier for this copy of the Consent Statement.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- organization
- The organization that manages the consent, and the framework within which it is executed.
- patient
- The patient/healthcare consumer to whom this consent applies.
- performer
- 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.
- policy
- The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
- policyRule
- A reference to the specific base computable regulation or policy.
- provision
- An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
- scope
- A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
- source
- 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.
- status
- Indicates the current state of this consent.
- text
- 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.
- verification
- Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Device resource for the minimal set of data to query and retrieve information relating to a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Defines the UK Core constraints and extensions on the Device resource for the minimal set of data to query and retrieve information relating to a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Subclass of hl7.model.Device (A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.)
- Value parameters:
- `type`
- The kind or type of device.
- contact
- Contact details for an organization or a particular human that is responsible for the device.
- contained
- 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.
- definition
- The reference to the definition for the device.
- deviceName
- This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
- distinctIdentifier
- The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
- expirationDate
- The date and time beyond which this device is no longer valid or should not be used (if applicable).
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- location
- The place where the device can be found.
- lotNumber
- Lot number assigned by the manufacturer.
- manufactureDate
- The date and time when the device was manufactured.
- manufacturer
- A name of the manufacturer.
- meta
- 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.
- modelNumber
- The model number for the device.
- modifierExtension
- 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).
- note
- Descriptive information, usage information or implantation information that is not captured in an existing element.
- owner
- An organization that is responsible for the provision and ongoing maintenance of the device.
- parent
- The parent device.
- partNumber
- The part number of the device.
- patient
- Patient information, If the device is affixed to a person.
- property
- The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
- safety
- Provides additional safety characteristics about a medical device. For example devices containing latex.
- serialNumber
- The serial number assigned by the organization when the device was manufactured.
- specialization
- The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
- status
- Status of the Device availability.
- statusReason
- Reason for the dtatus of the Device availability.
- text
- 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.
- udiCarrier
- Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
- url
- A network address on which the device may be contacted directly.
- version
- The actual design of the device or software version running on the device.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the DiagnosticReport resource for the minimal set of data to query and retrieve diagnostic report information.
Defines the UK Core constraints and extensions on the DiagnosticReport resource for the minimal set of data to query and retrieve diagnostic report information.
Subclass of hl7.model.DiagnosticReport (The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.)
- Value parameters:
- basedOn
- Details concerning a service requested.
- category
- A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
- code
- A code or name that describes this diagnostic report.
- conclusion
- Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
- conclusionCode
- One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
- contained
- 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.
- effective
- The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
- encounter
- The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifiers assigned to this report by the performer or other systems.
- imagingStudy
- One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
- implicitRules
- 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.
- issued
- The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
- language
- The base language in which the resource is written.
- media
- A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
- meta
- 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.
- modifierExtension
- 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).
- performer
- The diagnostic service that is responsible for issuing the report.
- presentedForm
- Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
- result
- Observations that are part of this diagnostic report.
- resultsInterpreter
- The practitioner or organization that is responsible for the report's conclusions and interpretations.
- specimen
- Details about the specimens on which this diagnostic report is based.
- status
- The status of the diagnostic report.
- subject
- The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the DocumentReference resource.
Defines the UK Core constraints and extensions on the DocumentReference resource.
Subclass of hl7.model.DocumentReference (A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.)
- Value parameters:
- `type`
- Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
- authenticator
- Which person or organization authenticates that this document is valid.
- author
- Identifies who is responsible for adding the information to the document.
- category
- A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
- contained
- 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.
- content
- The document and format referenced. There may be multiple content element repetitions, each with a different format.
- context
- The clinical context in which the document was prepared.
- custodian
- Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
- date
- When the document reference was created.
- description
- Human-readable description of the source document.
- docStatus
- The status of the underlying document.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Other identifiers associated with the document, including version independent identifiers.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- masterIdentifier
- Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
- meta
- 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.
- modifierExtension
- 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).
- relatesTo
- Relationships that this document has with other document references that already exist.
- securityLabel
- A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
- status
- The status of this document reference.
- subject
- Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Encounter resource for the minimal set of data to query and retrieve encounter information.
Defines the UK Core constraints and extensions on the Encounter resource for the minimal set of data to query and retrieve encounter information.
Subclass of hl7.model.Encounter (An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.)
- Value parameters:
- `class`
- Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
- `type`
- Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
- account
- The set of accounts that may be used for billing for this Encounter.
- appointment
- The appointment that scheduled this encounter.
- basedOn
- The request this encounter satisfies (e.g. incoming referral or procedure request).
- classHistory
- The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
- contained
- 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.
- diagnosis
- The list of diagnosis relevant to this encounter.
- episodeOfCare
- Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
- extension
- 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.
- hospitalization
- Details about the admission to a healthcare service.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifier(s) by which this encounter is known.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- length
- Quantity of time the encounter lasted. This excludes the time during leaves of absence.
- location
- List of locations where the patient has been during this encounter.
- meta
- 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.
- modifierExtension
- 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).
- partOf
- Another Encounter of which this encounter is a part of (administratively or in time).
- participant
- The list of people responsible for providing the service.
- period
- The start and end time of the encounter.
- priority
- Indicates the urgency of the encounter.
- reasonCode
- Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- reasonReference
- Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
- serviceProvider
- The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
- serviceType
- Broad categorization of the service that is to be provided (e.g. cardiology).
- status
- planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
- statusHistory
- The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
- subject
- The patient or group present at the encounter.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the EpisodeOfCare resource for the minimal set of data to query and retrieve episode of care information.
Defines the UK Core constraints and extensions on the EpisodeOfCare resource for the minimal set of data to query and retrieve episode of care information.
Subclass of hl7.model.EpisodeOfCare (An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.)
- Value parameters:
- `type`
- A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
- account
- The set of accounts that may be used for billing for this EpisodeOfCare.
- careManager
- The practitioner that is the care manager/care coordinator for this patient.
- contained
- 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.
- diagnosis
- The list of diagnosis relevant to this episode of care.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- managingOrganization
- The organization that has assumed the specific responsibilities for the specified duration.
- meta
- 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.
- modifierExtension
- 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).
- patient
- The patient who is the focus of this episode of care.
- period
- The interval during which the managing organization assumes the defined responsibility.
- referralRequest
- Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
- status
- planned | waitlist | active | onhold | finished | cancelled.
- statusHistory
- The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
- team
- The list of practitioners that may be facilitating this episode of care for specific purposes.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve an individual’s immunisation information.
Defines the UK Core constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve an individual’s immunisation information.
Subclass of hl7.model.Immunization (Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.)
- Value parameters:
- contained
- 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.
- doseQuantity
- The quantity of vaccine product that was administered.
- education
- Educational material presented to the patient (or guardian) at the time of vaccine administration.
- encounter
- The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
- expirationDate
- Date vaccine batch expires.
- extension
- 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.
- fundingSource
- Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A unique identifier assigned to this immunization record.
- implicitRules
- 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.
- isSubpotent
- Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
- language
- The base language in which the resource is written.
- location
- The service delivery location where the vaccine administration occurred.
- lotNumber
- Lot number of the vaccine product.
- manufacturer
- Name of vaccine manufacturer.
- meta
- 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.
- modifierExtension
- 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).
- note
- Extra information about the immunization that is not conveyed by the other attributes.
- occurrence
- Date vaccine administered or was to be administered.
- patient
- The patient who either received or did not receive the immunization.
- performer
- Indicates who performed the immunization event.
- primarySource
- An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
- programEligibility
- Indicates a patient's eligibility for a funding program.
- protocolApplied
- The protocol (set of recommendations) being followed by the provider who administered the dose.
- reaction
- Categorical data indicating that an adverse event is associated in time to an immunization.
- reasonCode
- Reasons why the vaccine was administered.
- reasonReference
- Condition, Observation or DiagnosticReport that supports why the immunization was administered.
- recorded
- The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
- reportOrigin
- The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
- route
- The path by which the vaccine product is taken into the body.
- site
- Body site where vaccine was administered.
- status
- Indicates the current status of the immunization event.
- statusReason
- Indicates the reason the immunization event was not performed.
- subpotentReason
- Reason why a dose is considered to be subpotent.
- text
- 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.
- vaccineCode
- Vaccine that was administered or was to be administered.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the List resource for the minimal set of data to query and retrieve a list of information.
Defines the UK Core constraints and extensions on the List resource for the minimal set of data to query and retrieve a list of information.
Subclass of hl7.model.FHIRList (A list is a curated collection of resources.)
- Value parameters:
- code
- This code defines the purpose of the list - why it was created.
- contained
- 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.
- date
- The date that the list was prepared.
- emptyReason
- If the list is empty, why the list is empty.
- encounter
- The encounter that is the context in which this list was created.
- entry
- Entries in this list.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifier for the List assigned for business purposes outside the context of FHIR.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- mode
- How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
- modifierExtension
- 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).
- note
- Comments that apply to the overall list.
- orderedBy
- What order applies to the items in the list.
- source
- The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
- status
- Indicates the current state of this list.
- subject
- The common subject (or patient) of the resources that are in the list if there is one.
- text
- 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.
- title
- A label for the list assigned by the author.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information.
Defines the UK Core constraints and extensions on the Location resource for the minimal set of data to query and retrieve location information.
Subclass of hl7.model.Location (Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.)
- Value parameters:
- `type`
- Indicates the type of function performed at the location.
- address
- Physical location.
- alias
- A list of alternate names that the location is known as, or was known as, in the past.
- availabilityExceptions
- A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
- contained
- 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.
- description
- Description of the Location, which helps in finding or referencing the place.
- endpoint
- Technical endpoints providing access to services operated for the location.
- extension
- 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.
- hoursOfOperation
- What days/times during a week is this location usually open.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Unique code or number identifying the location to its users.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- managingOrganization
- The organization responsible for the provisioning and upkeep of the location.
- meta
- 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.
- mode
- Indicates whether a resource instance represents a specific location or a class of locations.
- modifierExtension
- 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).
- name
- Name of the location as used by humans. Does not need to be unique.
- operationalStatus
- The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
- partOf
- Another Location of which this Location is physically a part of.
- physicalType
- Physical form of the location, e.g. building, room, vehicle, road.
- position
- The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
- status
- The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
- telecom
- The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Medication resource for the minimal set of data to query and retrieve medication information.
Defines the UK Core constraints and extensions on the Medication resource for the minimal set of data to query and retrieve medication information.
Subclass of hl7.model.Medication (This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.)
- Value parameters:
- amount
- Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
- batch
- Information that only applies to packages (not products).
- code
- A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
- contained
- 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.
- extension
- 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.
- form
- Describes the form of the item. Powder; tablets; capsule.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Business identifier for this medication.
- implicitRules
- 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.
- ingredient
- Identifies a particular constituent of interest in the product.
- language
- The base language in which the resource is written.
- manufacturer
- Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
- meta
- 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.
- modifierExtension
- 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).
- status
- A code to indicate if the medication is in active use.
- text
- 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.
- Constructor:
Inherits all params from parent. Requires the following fields which were optional in the parent: code.
- Companion:
- object
Defines the UK Core constraints and extensions on the MedicationAdministration resource for the minimal set of data to query and retrieve medication administration information.
Defines the UK Core constraints and extensions on the MedicationAdministration resource for the minimal set of data to query and retrieve medication administration information.
Subclass of hl7.model.MedicationAdministration (Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.)
- Value parameters:
- category
- Indicates where the medication is expected to be consumed or administered.
- contained
- 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.
- context
- The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
- device
- The device used in administering the medication to the patient. For example, a particular infusion pump.
- dosage
- Describes the medication dosage information details e.g. dose, rate, site, route, etc.
- effective
- A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
- eventHistory
- A summary of the events of interest that have occurred, such as when the administration was verified.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- instantiates
- A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
- language
- The base language in which the resource is written.
- medication
- Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- meta
- 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.
- modifierExtension
- 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).
- note
- Extra information about the medication administration that is not conveyed by the other attributes.
- partOf
- A larger event of which this particular event is a component or step.
- performer
- Indicates who or what performed the medication administration and how they were involved.
- reasonCode
- A code indicating why the medication was given.
- reasonReference
- Condition or observation that supports why the medication was administered.
- request
- The original request, instruction or authority to perform the administration.
- status
- Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
- statusReason
- A code indicating why the administration was not performed.
- subject
- The person or animal or group receiving the medication.
- supportingInformation
- Additional information (for example, patient height and weight) that supports the administration of the medication.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the MedicationDispense resource for the minimal set of data to query and retrieve dispensed medication information.
Defines the UK Core constraints and extensions on the MedicationDispense resource for the minimal set of data to query and retrieve dispensed medication information.
Subclass of hl7.model.MedicationDispense (Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.)
- Value parameters:
- `type`
- Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
- authorizingPrescription
- Indicates the medication order that is being dispensed against.
- category
- Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- contained
- 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.
- context
- The encounter or episode of care that establishes the context for this event.
- daysSupply
- The amount of medication expressed as a timing amount.
- destination
- Identification of the facility/location where the medication was shipped to, as part of the dispense event.
- detectedIssue
- Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
- dosageInstruction
- Indicates how the medication is to be used by the patient.
- eventHistory
- A summary of the events of interest that have occurred, such as when the dispense was verified.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- location
- The principal physical location where the dispense was performed.
- medication
- Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- meta
- 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.
- modifierExtension
- 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).
- note
- Extra information about the dispense that could not be conveyed in the other attributes.
- partOf
- The procedure that trigger the dispense.
- performer
- Indicates who or what performed the event.
- quantity
- The amount of medication that has been dispensed. Includes unit of measure.
- receiver
- Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
- status
- A code specifying the state of the set of dispense events.
- statusReason
- Indicates the reason why a dispense was not performed.
- subject
- A link to a resource representing the person or the group to whom the medication will be given.
- substitution
- Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
- supportingInformation
- Additional information that supports the medication being dispensed.
- text
- 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.
- whenHandedOver
- The time the dispensed product was provided to the patient or their representative.
- whenPrepared
- The time when the dispensed product was packaged and reviewed.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the MedicationRequest resource for the minimal set of data to query and retrieve prescription information.
Defines the UK Core constraints and extensions on the MedicationRequest resource for the minimal set of data to query and retrieve prescription information.
Subclass of hl7.model.MedicationRequest (An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.)
- Value parameters:
- authoredOn
- The date (and perhaps time) when the prescription was initially written or authored on.
- basedOn
- A plan or request that is fulfilled in whole or in part by this medication request.
- category
- Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
- contained
- 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.
- courseOfTherapyType
- The description of the course of therapy for a medication request.
- detectedIssue
- Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
- dispenseRequest
- Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
- doNotPerform
- If true indicates that the provider is asking for the medication request not to occur.
- dosageInstruction
- Indicates how the medication is to be used by the patient.
- encounter
- The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
- eventHistory
- Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
- extension
- 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.
- groupIdentifier
- A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- instantiatesCanonical
- The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
- instantiatesUri
- The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.
- insurance
- Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
- intent
- Whether the request is a proposal, plan, or an original order.
- language
- The base language in which the resource is written.
- medication
- Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- meta
- 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.
- modifierExtension
- 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).
- note
- Extra information about the prescription that could not be conveyed by the other attributes.
- performer
- The specified desired performer of the medication treatment (e.g. the performer of the medication administration).
- performerType
- Indicates the type of performer of the administration of the medication.
- priorPrescription
- A link to a resource representing an earlier order related order or prescription.
- priority
- Indicates how quickly the Medication Request should be addressed with respect to other requests.
- reasonCode
- The reason or the indication for ordering or not ordering the medication.
- reasonReference
- Condition or observation that supports why the medication was ordered.
- recorder
- The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
- reported
- Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
- requester
- The individual, organization, or device that initiated the request and has responsibility for its activation.
- status
- A code specifying the current state of the order. Generally, this will be active or completed state.
- statusReason
- Captures the reason for the current state of the MedicationRequest.
- subject
- A link to a resource representing the person or set of individuals to whom the medication will be given.
- substitution
- Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
- supportingInformation
- Include additional information (for example, patient height and weight) that supports the ordering of the medication.
- text
- 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.
- Constructor:
Inherits all params from parent. Requires the following fields which were optional in the parent: substitution.
- Companion:
- object
Defines the UK Core constraints and extensions on the MedicationStatement resource for the minimal set of data to query and retrieve medication statement information.
Defines the UK Core constraints and extensions on the MedicationStatement resource for the minimal set of data to query and retrieve medication statement information.
Subclass of hl7.model.MedicationStatement (A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.)
- Value parameters:
- basedOn
- A plan, proposal or order that is fulfilled in whole or in part by this event.
- category
- Indicates where the medication is expected to be consumed or administered.
- contained
- 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.
- context
- The encounter or episode of care that establishes the context for this MedicationStatement.
- dateAsserted
- The date when the medication statement was asserted by the information source.
- derivedFrom
- Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
- dosage
- Indicates how the medication is/was or should be taken by the patient.
- effective
- The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
- implicitRules
- 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.
- informationSource
- The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.
- language
- The base language in which the resource is written.
- medication
- Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
- meta
- 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.
- modifierExtension
- 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).
- note
- Provides extra information about the medication statement that is not conveyed by the other attributes.
- partOf
- A larger event of which this particular event is a component or step.
- reasonCode
- A reason for why the medication is being/was taken.
- reasonReference
- Condition or observation that supports why the medication is being/was taken.
- status
- A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.
- statusReason
- Captures the reason for the current state of the MedicationStatement.
- subject
- The person, animal or group who is/was taking the medication.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the MessageHeader resource for the minimal set of data to be present in a message header.
Defines the UK Core constraints and extensions on the MessageHeader resource for the minimal set of data to be present in a message header.
Subclass of hl7.model.MessageHeader (The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.)
- Value parameters:
- author
- The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
- contained
- 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.
- definition
- Permanent link to the MessageDefinition for this message.
- destination
- The destination application which the message is intended for.
- enterer
- The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
- event
- Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.
- extension
- 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.
- focus
- The actual data of the message - a reference to the root/focus class of the event.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- reason
- Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
- response
- Information about the message that this message is a response to. Only present if this message is a response.
- responsible
- The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
- sender
- Identifies the sending system to allow the use of a trust relationship.
- source
- The source application from which this message originated.
- text
- 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.
- Constructor:
Inherits all params from parent. Refines the types of: event.
- Companion:
- object
Defines the UK Core constraints and extensions on the observation resource for the minimal set of data to query and retrieve generic observation information.
Defines the UK Core constraints and extensions on the observation resource for the minimal set of data to query and retrieve generic observation information.
Subclass of hl7.model.Observation (Measurements and simple assertions made about a patient, device or other subject.)
- Value parameters:
- basedOn
- A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- bodySite
- Indicates the site on the subject's body where the observation was made (i.e. the target site).
- category
- A code that classifies the general type of observation being made.
- code
- Describes what was observed. Sometimes this is called the observation "name".
- component
- Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
- contained
- 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.
- dataAbsentReason
- Provides a reason why the expected value in the element Observation.value[x] is missing.
- derivedFrom
- The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- device
- The device used to generate the observation data.
- effective
- The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- encounter
- The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- extension
- 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.
- focus
- The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- hasMember
- This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A unique identifier assigned to this observation.
- implicitRules
- 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.
- interpretation
- A categorical assessment of an observation value. For example, high, low, normal.
- issued
- The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- language
- The base language in which the resource is written.
- meta
- 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.
- method
- Indicates the mechanism used to perform the observation.
- modifierExtension
- 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).
- note
- Comments about the observation or the results.
- partOf
- A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- performer
- Who was responsible for asserting the observed value as "true".
- referenceRange
- Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two
referenceRangeelements would be used.- specimen
- The specimen that was used when this observation was made.
- status
- The status of the result value.
- subject
- The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focuselement or thecodeitself specifies the actual focus of the observation.- text
- 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.
- value
- The information determined as a result of making the observation, if the information has a simple value.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the OperationOutcome resource for the minimal set of data to query and retrieve information about the outcome of an attempted system operation.
Defines the UK Core constraints and extensions on the OperationOutcome resource for the minimal set of data to query and retrieve information about the outcome of an attempted system operation.
Subclass of hl7.model.OperationOutcome (A collection of error, warning, or information messages that result from a system action.)
- Value parameters:
- contained
- 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.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- implicitRules
- 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.
- issue
- An error, warning, or information message that results from a system action.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information.
Defines the UK Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information.
Subclass of hl7.model.Organization (A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.)
- Value parameters:
- `type`
- The kind(s) of organization that this is.
- active
- Whether the organization's record is still in active use.
- address
- An address for the organization.
- alias
- A list of alternate names that the organization is known as, or was known as in the past.
- contact
- Contact for the organization for a certain purpose.
- contained
- 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.
- endpoint
- Technical endpoints providing access to services operated for the organization.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifier for the organization that is used to identify the organization across multiple disparate systems.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- name
- A name associated with the organization.
- partOf
- The organization of which this organization forms a part.
- telecom
- A contact detail for the organization.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information.
Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information.
Subclass of hl7.model.Patient (Demographics and other administrative information about an individual or animal receiving care or other health-related services.)
- Value parameters:
- active
- Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
- address
- An address for the individual
- birthDate
- The date of birth for the individual.
- communication
- A language which may be used to communicate with the patient about his or her health.
- contact
- A contact party (e.g. guardian, partner, friend) for the patient.
- contained
- 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.
- deceased
- Indicates if the individual is deceased or not.
- extension
- 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.
- gender
- Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
- generalPractitioner
- Patient's nominated care provider.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- An identifier for this patient.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- link
- Link to another patient resource that concerns the same actual patient.
- managingOrganization
- Organization that is the custodian of the patient record.
- maritalStatus
- This field contains a patient's most recent marital (civil) status.
- meta
- 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.
- modifierExtension
- 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).
- multipleBirth
- Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
- name
- A name associated with the individual.
- photo
- Image of the patient.
- telecom
- A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information.
Defines the UK Core constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information.
Subclass of hl7.model.Practitioner (A person who is directly or indirectly involved in the provisioning of healthcare.)
- Value parameters:
- active
- Whether this practitioner's record is in active use.
- address
- Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
- birthDate
- The date of birth for the practitioner.
- communication
- A language the practitioner can use in patient communication.
- contained
- 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.
- extension
- 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.
- gender
- Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- An identifier that applies to this person in this role.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- name
- The name(s) associated with the practitioner.
- photo
- Image of the person.
- qualification
- The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
- telecom
- A contact detail for the practitioner, e.g. a telephone number or an email address.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the PractitionerRole resource for the minimal set of data to query and retrieve practitioner role information.
Defines the UK Core constraints and extensions on the PractitionerRole resource for the minimal set of data to query and retrieve practitioner role information.
Subclass of hl7.model.PractitionerRole (A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.)
- Value parameters:
- active
- Whether this practitioner role record is in active use.
- availabilityExceptions
- A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
- availableTime
- A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
- code
- Roles which this practitioner is authorized to perform for the organization.
- contained
- 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.
- endpoint
- Technical endpoints providing access to services operated for the practitioner with this role.
- extension
- 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.
- healthcareService
- The list of healthcare services that this worker provides for this role's Organization/Location(s).
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- An identifier that applies to this person in this role.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- location
- The location(s) at which this practitioner provides care.
- meta
- 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.
- modifierExtension
- 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).
- notAvailable
- The practitioner is not available or performing this role during this period of time due to the provided reason.
- organization
- The organization where the Practitioner performs the roles associated.
- period
- The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
- practitioner
- Practitioner that is able to provide the defined services for the organization.
- specialty
- Specific specialty of the practitioner.
- telecom
- Contact details that are specific to the role/location/service.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Procedure resource for the minimal set of data to query and retrieve the patient’s procedure information.
Defines the UK Core constraints and extensions on the Procedure resource for the minimal set of data to query and retrieve the patient’s procedure information.
Subclass of hl7.model.Procedure (An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.)
- Value parameters:
- asserter
- Individual who is making the procedure statement.
- basedOn
- A reference to a resource that contains details of the request for this procedure.
- bodySite
- Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
- category
- A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
- code
- The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
- complication
- Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
- complicationDetail
- Any complications that occurred during the procedure, or in the immediate post-performance period.
- contained
- 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.
- encounter
- The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
- extension
- 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.
- focalDevice
- A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
- followUp
- If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
- implicitRules
- 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.
- instantiatesCanonical
- The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- instantiatesUri
- The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
- language
- The base language in which the resource is written.
- location
- The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
- meta
- 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.
- modifierExtension
- 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).
- note
- Any other notes and comments about the procedure.
- outcome
- The outcome of the procedure - did it resolve the reasons for the procedure being performed?
- partOf
- A larger event of which this particular procedure is a component or step.
- performed
- Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
- performer
- Limited to "real" people rather than equipment.
- reasonCode
- The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.
- reasonReference
- The justification of why the procedure was performed.
- recorder
- Individual who recorded the record and takes responsibility for its content.
- report
- This could be a histology result, pathology report, surgical report, etc.
- status
- A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
- statusReason
- Captures the reason for the current state of the procedure.
- subject
- The person, animal or group on which the procedure was performed.
- text
- 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.
- usedCode
- Identifies coded items that were used as part of the procedure.
- usedReference
- Identifies medications, devices and any other substance used as part of the procedure.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the provenance resource for the minimal set of data to query and retrieve generic provenance information.
Defines the UK Core constraints and extensions on the provenance resource for the minimal set of data to query and retrieve generic provenance information.
Subclass of hl7.model.Provenance (Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.)
- Value parameters:
- activity
- An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
- agent
- An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
- contained
- 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.
- entity
- An entity used in this activity.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- location
- Where the activity occurred, if relevant.
- meta
- 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.
- modifierExtension
- 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).
- occurred
- The period during which the activity occurred.
- policy
- Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
- reason
- The reason that the activity was taking place.
- recorded
- The instant of time at which the activity was recorded.
- signature
- A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
- target
- The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Questionnaire resource for the minimal set of data to query and retrieve the questionnaire information.
Defines the UK Core constraints and extensions on the Questionnaire resource for the minimal set of data to query and retrieve the questionnaire information.
Subclass of hl7.model.Questionnaire (A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.)
- Value parameters:
- approvalDate
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
- code
- An identifier for this question or group of questions in a particular terminology such as LOINC.
- contact
- Contact details to assist a user in finding and communicating with the publisher.
- contained
- 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.
- copyright
- A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
- date
- The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
- derivedFrom
- The URL of a Questionnaire that this Questionnaire is based on.
- description
- A free text natural language description of the questionnaire from a consumer's perspective.
- effectivePeriod
- The period during which the questionnaire content was or is planned to be in active use.
- experimental
- A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
- implicitRules
- 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.
- item
- A particular question, question grouping or display text that is part of the questionnaire.
- jurisdiction
- A legal or geographic region in which the questionnaire is intended to be used.
- language
- The base language in which the resource is written.
- lastReviewDate
- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
- meta
- 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.
- modifierExtension
- 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).
- name
- A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- publisher
- The name of the organization or individual that published the questionnaire.
- purpose
- Explanation of why this questionnaire is needed and why it has been designed as it has.
- status
- The status of this questionnaire. Enables tracking the life-cycle of the content.
- subjectType
- The types of subjects that can be the subject of responses created for the questionnaire.
- text
- 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.
- title
- A short, descriptive, user-friendly title for the questionnaire.
- url
- An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.
- useContext
- The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.
- version
- The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the QuestionnaireResponse resource for the minimal set of data to query and retrieve a complete or partial list of answers to a set of questions completed when responding to a questionnaire.
Defines the UK Core constraints and extensions on the QuestionnaireResponse resource for the minimal set of data to query and retrieve a complete or partial list of answers to a set of questions completed when responding to a questionnaire.
Subclass of hl7.model.QuestionnaireResponse (A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.)
- Value parameters:
- author
- Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
- authored
- The date and/or time that this set of answers were last changed.
- basedOn
- The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
- contained
- 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.
- encounter
- The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A business identifier assigned to a particular completed (or partially completed) questionnaire.
- implicitRules
- 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.
- item
- A group or question item from the original questionnaire for which answers are provided.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- partOf
- A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
- questionnaire
- The Questionnaire that defines and organizes the questions for which answers are being provided.
- source
- The person who answered the questions about the subject.
- status
- The position of the questionnaire response within its overall lifecycle.
- subject
- The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the RelatedPerson resource for the minimal set of data to query and retrieve related person information.
Defines the UK Core constraints and extensions on the RelatedPerson resource for the minimal set of data to query and retrieve related person information.
Subclass of hl7.model.RelatedPerson (Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.)
- Value parameters:
- active
- Whether this related person record is in active use.
- address
- Address where the related person can be contacted or visited.
- birthDate
- The date on which the related person was born.
- communication
- A language which may be used to communicate with about the patient's health.
- contained
- 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.
- extension
- 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.
- gender
- Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifier for a person within a particular scope.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- name
- A name associated with the person.
- patient
- The patient this person is related to.
- period
- The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
- photo
- Image of the person.
- relationship
- The nature of the relationship between a patient and the related person.
- telecom
- A contact detail for the person, e.g. a telephone number or an email address.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the ServiceRequest resource for the minimal set of data to query and retrieve service request information.
Defines the UK Core constraints and extensions on the ServiceRequest resource for the minimal set of data to query and retrieve service request information.
Subclass of hl7.model.ServiceRequest (A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.)
- Value parameters:
- asNeeded
- If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
- authoredOn
- When the request transitioned to being actionable.
- basedOn
- Plan/proposal/order fulfilled by this request.
- bodySite
- Anatomic location where the procedure should be performed. This is the target site.
- category
- A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
- code
- A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
- contained
- 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.
- doNotPerform
- Set this to true if the record is saying that the service/procedure should NOT be performed.
- encounter
- An encounter that provides additional information about the healthcare context in which this request is made.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
- implicitRules
- 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.
- instantiatesCanonical
- The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
- instantiatesUri
- The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
- insurance
- Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
- intent
- Whether the request is a proposal, plan, an original order or a reflex order.
- language
- The base language in which the resource is written.
- locationCode
- The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
- locationReference
- A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
- meta
- 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.
- modifierExtension
- 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).
- note
- Any other notes and comments made about the service request. For example, internal billing notes.
- occurrence
- The date/time at which the requested service should occur.
- orderDetail
- Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
- patientInstruction
- Instructions in terms that are understood by the patient or consumer.
- performer
- The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
- performerType
- Desired type of performer for doing the requested service.
- priority
- Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
- quantity
- An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
- reasonCode
- An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in
supportingInfo.- reasonReference
- Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in
supportingInfo.- relevantHistory
- Key events in the history of the request.
- replaces
- The request takes the place of the referenced completed or terminated request(s).
- requester
- The individual who initiated the request and has responsibility for its activation.
- requisition
- A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
- specimen
- One or more specimens that the laboratory procedure will use.
- status
- The status of the order.
- subject
- On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
- supportingInfo
- Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the UK Core constraints and extensions on the Specimen resource for the minimal set of data to query and retrieve specimen information.
Defines the UK Core constraints and extensions on the Specimen resource for the minimal set of data to query and retrieve specimen information.
Subclass of hl7.model.Specimen (A sample to be used for analysis.)
- Value parameters:
- `type`
- The kind of material that forms the specimen.
- accessionIdentifier
- The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
- collection
- Details concerning the specimen collection.
- condition
- A mode or state of being that describes the nature of the specimen.
- contained
- 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.
- container
- The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
- extension
- 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.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- Id for specimen.
- implicitRules
- 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.
- language
- The base language in which the resource is written.
- meta
- 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.
- modifierExtension
- 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).
- note
- To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
- parent
- Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
- processing
- Details concerning processing and processing steps for the specimen.
- receivedTime
- Time when specimen was received for processing or testing.
- request
- Details concerning a service request that required a specimen to be collected.
- status
- The availability of the specimen.
- subject
- Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
- text
- 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.
- Constructor:
Inherits all params from parent.
- Companion:
- object
Defines the observation constraints and extensions on the UK Core observation resource for the minimal set of data to query and retrieve clinical vital signs observation information.
Defines the observation constraints and extensions on the UK Core observation resource for the minimal set of data to query and retrieve clinical vital signs observation information.
Subclass of ukcore.model.UKCore_Observation (Defines the UK Core constraints and extensions on the observation resource for the minimal set of data to query and retrieve generic observation information.)
- Value parameters:
- basedOn
- A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
- bodySite
- Indicates the site on the subject's body where the observation was made (i.e. the target site).
- category
- A code that classifies the general type of observation being made.
- code
- Describes what was observed. Sometimes this is called the observation "name".
- component
- Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
- contained
- 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.
- dataAbsentReason
- Provides a reason why the expected value in the element Observation.value[x] is missing.
- derivedFrom
- The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
- device
- The device used to generate the observation data.
- effective
- The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
- encounter
- The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
- extension
- 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.
- focus
- The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
- hasMember
- This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- identifier
- A unique identifier assigned to this observation.
- implicitRules
- 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.
- interpretation
- A categorical assessment of an observation value. For example, high, low, normal.
- issued
- The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
- language
- The base language in which the resource is written.
- meta
- 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.
- method
- Indicates the mechanism used to perform the observation.
- modifierExtension
- 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).
- note
- Comments about the observation or the results.
- partOf
- A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
- performer
- Who was responsible for asserting the observed value as "true".
- referenceRange
- Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two
referenceRangeelements would be used.- specimen
- The specimen that was used when this observation was made.
- status
- The status of the result value.
- subject
- The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the
focuselement or thecodeitself specifies the actual focus of the observation.- text
- 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.
- value
- The information determined as a result of making the observation, if the information has a simple value.
- Constructor:
Inherits all params from parent.
- Companion:
- object