--- title: "Create a new definition." method: POST path: "/caregaps/api/{quality_program}/definition/" tags: ["Definitions"] --- # Create a new definition. `POST /caregaps/api/{quality_program}/definition/` Create a new definition. ## Path parameters - `quality_program` string, required ## Request body - DefinitionAPIModel - `quality_program` string — Quality program this definition is associated with. - `name` string, required — Human readable name for the definition - `indicator` 'info' | 'warning' | 'critical', required — An enumeration. - `source` Source, required - `label` string, required — A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink. - `url` string — An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card. Note that this URL should not be used to supply a context-specific 'drill-down' view of the information on this card. For that, use link.url instead. - `icon` string — An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. - `topic` Coding - `code` string — The code for what is being represented - `display` string — A codesystem for this code. - `system` string — A short, human-readable label to display. - `context` CodingContext - `target` 'problem-list-item' | 'encounter-diagnosis' — An enumeration. - `selection_behavior` 'any' | 'at-most-one', required — An enumeration. - `closing_codes` Coding[] — List of closing codes. - `code` string — The code for what is being represented - `display` string — A codesystem for this code. - `system` string — A short, human-readable label to display. - `context` CodingContext - `target` 'problem-list-item' | 'encounter-diagnosis' — An enumeration. - `description` string — Sentence that describes the definition. Allowed HTML tags: a, abbr, acronym, b, blockquote, br, code, div, em, h1, h2, h3, h4, h5, h6, i, li, ol, p, strong, u, ul - `practice_id` string — Practice id this definition is authorized for. - `override_reasons` Coding[] — Override reasons written as codings for the definition - `code` string — The code for what is being represented - `display` string — A codesystem for this code. - `system` string — A short, human-readable label to display. - `context` CodingContext - `target` 'problem-list-item' | 'encounter-diagnosis' — An enumeration. - `links` Link[] — Relevant links for the definition - `label` string, required — Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link). - `url` string, required — URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash. - `type` string, required — The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters. - `app_context` string — An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it. - `start_date` string, date, required — Start date for period - `end_date` string, date, required — End date for period - `additional_documentation` DocSection[] — Additional documentation sections for reference in the EHR. Allowed HTML tags: a, abbr, acronym - `type` 'text' | 'footer' | 'subsection', required — An enumeration. - `paragraphs` string[] — List of paragraphs to render for a text type doc section - `subsections` SubSection[] — Mappings between subsection titles and content. Required for footer or subsection type sections - `label` string, required — TBD - `text` string, required — TBD - `subtitle` string, required — Documentation section heading - `external_id` string — Identifer for linking to external systems - `suggestions` Suggestion[], required — List of suggestions to take action on with this definition - `label` string, required — Human-readable label to display for this suggestion (e.g. the CDS Client might render this as the text on a button tied to this suggestion). - `is_recommended` boolean, required — When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card. CDS Hooks clients may choose to influence their UI based on this value, such as pre-selecting, or highlighting recommended suggestions. Multiple suggestions MAY be recommended, if card.selectionBehavior is any. - `actions` Action[] — Array of objects, each defining a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within it. - `type` 'create' | 'update' | 'delete', required — An enumeration. - `description` string, required — Human-readable description of the suggested action MAY be presented to the end-user. - `resource` union — A FHIR resource. When the type attribute is create, the resource attribute SHALL contain a new FHIR resource to be created. For update, this holds the updated resource in its entirety and not just the changed fields. Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead. - ValueSet — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A set of codes drawn from one or more code systems. A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html). - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `compose` string — A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD). - `contact` string[] — Contact details to assist a user in finding and communicating with the publisher. - `copyright` string — A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. - `_copyright` string - `date` string, date-time — The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition'). - `_date` string - `description` string — A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. - `_description` string - `expansion` string — A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. - `experimental` boolean — A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. - `_experimental` string - `identifier` integer[] — A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. - `immutable` boolean — If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. - `_immutable` string - `jurisdiction` string[] — A legal or geographic region in which the value set is intended to be used. - `name` string — A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. - `_name` string - `publisher` string — The name of the organization or individual that published the value set. - `_publisher` string - `purpose` string — Explanation of why this value set is needed and why it has been designed as it has. - `_purpose` string - `status` string — The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. - `_status` string - `title` string — A short, descriptive, user-friendly title for the value set. - `_title` string - `url` string — An absolute URI that is used to identify this value set 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 value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. - `_url` string - `useContext` string[] — 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 value set instances. - `version` string — The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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. - `_version` string - Observation — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Measurements and simple assertions. Measurements and simple assertions made about a patient, device or other subject. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `basedOn` string[] — 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` string — Indicates the site on the subject's body where the observation was made (i.e. the target site). - `category` string[] — A code that classifies the general type of observation being made. - `code` string, required — Describes what was observed. Sometimes this is called the observation "name". - `component` string[] — 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. - `dataAbsentReason` string — Provides a reason why the expected value in the element Observation.value[x] is missing. - `derivedFrom` string[] — 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` string — The device used to generate the observation data. - `effectiveDateTime` string, date-time — 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. - `_effectiveDateTime` string - `effectiveInstant` string, date-time — 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. - `_effectiveInstant` string - `effectivePeriod` string — 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. - `effectiveTiming` string — 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` string — The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. - `focus` string[] — 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` string[] — 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. - `identifier` integer[] — A unique identifier assigned to this observation. - `interpretation` string[] — A categorical assessment of an observation value. For example, high, low, normal. - `issued` string, date-time — The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. - `_issued` string - `method` string — Indicates the mechanism used to perform the observation. - `note` string[] — Comments about the observation or the results. - `partOf` string[] — A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. - `performer` string[] — Who was responsible for asserting the observed value as "true". - `referenceRange` string[] — 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 `referenceRange` elements would be used. - `specimen` string — The specimen that was used when this observation was made. - `status` string — The status of the result value. - `_status` string - `subject` string — 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 `focus` element or the `code` itself specifies the actual focus of the observation. - `valueBoolean` boolean — The information determined as a result of making the observation, if the information has a simple value. - `_valueBoolean` string - `valueCodeableConcept` string — The information determined as a result of making the observation, if the information has a simple value. - `valueDateTime` string, date-time — The information determined as a result of making the observation, if the information has a simple value. - `_valueDateTime` string - `valueInteger` integer — The information determined as a result of making the observation, if the information has a simple value. - `_valueInteger` string - `valuePeriod` string — The information determined as a result of making the observation, if the information has a simple value. - `valueQuantity` integer — The information determined as a result of making the observation, if the information has a simple value. - `valueRange` integer — The information determined as a result of making the observation, if the information has a simple value. - `valueRatio` string — The information determined as a result of making the observation, if the information has a simple value. - `valueSampledData` string — The information determined as a result of making the observation, if the information has a simple value. - `valueString` string — The information determined as a result of making the observation, if the information has a simple value. - `_valueString` string - `valueTime` string, time — The information determined as a result of making the observation, if the information has a simple value. - `_valueTime` string - Condition — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Detailed information about conditions, problems or diagnoses. A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `abatementAge` integer — 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. - `abatementDateTime` string, date-time — 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. - `_abatementDateTime` string - `abatementPeriod` string — 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. - `abatementRange` integer — 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. - `abatementString` string — 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. - `_abatementString` string - `asserter` string — Individual who is making the condition statement. - `bodySite` string[] — The anatomical location where this condition manifests itself. - `category` string[] — A category assigned to the condition. - `clinicalStatus` string — The clinical status of the condition. - `code` string - `encounter` string — The Encounter during which this Condition was created or to which the creation of this record is tightly associated. - `evidence` string[] — Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. - `identifier` integer[] — 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. - `note` string[] — Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. - `onsetAge` integer — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `onsetDateTime` string, date-time — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `_onsetDateTime` string - `onsetPeriod` string — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `onsetRange` integer — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `onsetString` string — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `_onsetString` string - `recordedDate` string, date-time — The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. - `_recordedDate` string - `recorder` string — Individual who recorded the record and takes responsibility for its content. - `severity` string — A subjective assessment of the severity of the condition as evaluated by the clinician. - `stage` string[] — Clinical stage or grade of a condition. May include formal severity assessments. - `subject` string, required — Indicates the patient or group who the condition record is associated with. - `verificationStatus` string — The verification status to support the clinical status of the condition. - ServiceRequest — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A request for a service to be performed. A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `asNeededBoolean` boolean — If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. - `_asNeededBoolean` string - `asNeededCodeableConcept` string — If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. - `authoredOn` string, date-time — When the request transitioned to being actionable. - `_authoredOn` string - `basedOn` string[] — Plan/proposal/order fulfilled by this request. - `bodySite` string[] — Anatomic location where the procedure should be performed. This is the target site. - `category` string[] — A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). - `code` string — A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. - `doNotPerform` boolean — Set this to true if the record is saying that the service/procedure should NOT be performed. - `_doNotPerform` string - `encounter` string — An encounter that provides additional information about the healthcare context in which this request is made. - `identifier` integer[] — Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. - `instantiatesCanonical` string[] — 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. - `_instantiatesCanonical` string[] - `instantiatesUri` string[] — 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. - `_instantiatesUri` string[] - `insurance` string[] — Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. - `intent` string — Whether the request is a proposal, plan, an original order or a reflex order. - `_intent` string - `locationCode` string[] — 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` string[] — A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. - `note` string[] — Any other notes and comments made about the service request. For example, internal billing notes. - `occurrenceDateTime` string, date-time — The date/time at which the requested service should occur. - `_occurrenceDateTime` string - `occurrencePeriod` string — The date/time at which the requested service should occur. - `occurrenceTiming` string — The date/time at which the requested service should occur. - `orderDetail` string[] — 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` string — Instructions in terms that are understood by the patient or consumer. - `_patientInstruction` string - `performer` string[] — The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. - `performerType` string — Desired type of performer for doing the requested service. - `priority` string — Indicates how quickly the ServiceRequest should be addressed with respect to other requests. - `_priority` string - `quantityQuantity` integer — 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). - `quantityRange` integer — 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). - `quantityRatio` string — 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` string[] — 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` string[] — Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. - `relevantHistory` string[] — Key events in the history of the request. - `replaces` string[] — The request takes the place of the referenced completed or terminated request(s). - `requester` string — The individual who initiated the request and has responsibility for its activation. - `requisition` integer — 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` string[] — One or more specimens that the laboratory procedure will use. - `status` string — The status of the order. - `_status` string - `subject` string, required — 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` string[] — 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. - Immunization — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Immunization event information. 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. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `doseQuantity` integer — The quantity of vaccine product that was administered. - `education` string[] — Educational material presented to the patient (or guardian) at the time of vaccine administration. - `encounter` string — The visit or admission or other contact between patient and health care provider the immunization was performed as part of. - `expirationDate` string, date — Date vaccine batch expires. - `_expirationDate` string - `fundingSource` string — 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). - `identifier` integer[] — A unique identifier assigned to this immunization record. - `isSubpotent` boolean — Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. - `_isSubpotent` string - `location` string — The service delivery location where the vaccine administration occurred. - `lotNumber` string — Lot number of the vaccine product. - `_lotNumber` string - `manufacturer` string — Name of vaccine manufacturer. - `note` string[] — Extra information about the immunization that is not conveyed by the other attributes. - `occurrenceDateTime` string, date-time — Date vaccine administered or was to be administered. - `_occurrenceDateTime` string - `occurrenceString` string — Date vaccine administered or was to be administered. - `_occurrenceString` string - `patient` string, required — The patient who either received or did not receive the immunization. - `performer` string[] — Indicates who performed the immunization event. - `primarySource` boolean — 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. - `_primarySource` string - `programEligibility` string[] — Indicates a patient's eligibility for a funding program. - `protocolApplied` string[] — The protocol (set of recommendations) being followed by the provider who administered the dose. - `reaction` string[] — Categorical data indicating that an adverse event is associated in time to an immunization. - `reasonCode` string[] — Reasons why the vaccine was administered. - `reasonReference` string[] — Condition, Observation or DiagnosticReport that supports why the immunization was administered. - `recorded` string, date-time — The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. - `_recorded` string - `reportOrigin` string — 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` string — The path by which the vaccine product is taken into the body. - `site` string — Body site where vaccine was administered. - `status` string — Indicates the current status of the immunization event. - `_status` string - `statusReason` string — Indicates the reason the immunization event was not performed. - `subpotentReason` string[] — Reason why a dose is considered to be subpotent. - `vaccineCode` string, required — Vaccine that was administered or was to be administered. - AllergyIntolerance — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Allergy or Intolerance (generally: Risk of adverse reaction to a substance). Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `asserter` string — The source of the information about the allergy that is recorded. - `category` string[] — Category of the identified substance. - `_category` string[] - `clinicalStatus` string — The clinical status of the allergy or intolerance. - `code` string — 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. - `criticality` string — Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. - `_criticality` string - `encounter` string — The encounter when the allergy or intolerance was asserted. - `identifier` integer[] — 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. - `lastOccurrence` string, date-time — Represents the date and/or time of the last known occurrence of a reaction event. - `_lastOccurrence` string - `note` string[] — Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. - `onsetAge` integer — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `onsetDateTime` string, date-time — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `_onsetDateTime` string - `onsetPeriod` string — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `onsetRange` integer — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `onsetString` string — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `_onsetString` string - `patient` string, required — The patient who has the allergy or intolerance. - `reaction` string[] — Details about each adverse reaction event linked to exposure to the identified substance. - `recordedDate` string, date-time — The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. - `_recordedDate` string - `recorder` string — Individual who recorded the record and takes responsibility for its content. - `type` string — Identification of the underlying physiological mechanism for the reaction risk. - `_type` string - `verificationStatus` string — Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). - Communication — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A record of information transmitted from a sender to a receiver. 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. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `about` string[] — Other resources that pertain to this communication and to which this communication should be associated. - `basedOn` string[] — An order, proposal or plan fulfilled in whole or in part by this Communication. - `category` string[] — The type of message conveyed such as alert, notification, reminder, instruction, etc. - `encounter` string — The Encounter during which this Communication was created or to which the creation of this record is tightly associated. - `identifier` integer[] — 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. - `inResponseTo` string[] — Prior communication that this communication is in response to. - `instantiatesCanonical` string[] — 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. - `_instantiatesCanonical` string[] - `instantiatesUri` string[] — 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. - `_instantiatesUri` string[] - `medium` string[] — A channel that was used for this communication (e.g. email, fax). - `note` string[] — Additional notes or commentary about the communication by the sender, receiver or other interested parties. - `partOf` string[] - `payload` string[] — Text, attachment(s), or resource(s) that was communicated to the recipient. - `priority` string — Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. - `_priority` string - `reasonCode` string[] — The reason or justification for the communication. - `reasonReference` string[] — Indicates another resource whose existence justifies this communication. - `received` string, date-time — The time when this communication arrived at the destination. - `_received` string - `recipient` string[] — 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` string — The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. - `sent` string, date-time — The time when this communication was sent. - `_sent` string - `status` string — The status of the transmission. - `_status` string - `statusReason` string — Captures the reason for the current state of the Communication. - `subject` string — The patient or group that was the focus of this communication. - `topic` string — Description of the purpose/content, similar to a subject line in an email. - Endpoint — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. The technical details of an endpoint that can be used for electronic services. The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `address` string, uri — The uri that describes the actual end-point to connect to. - `_address` string - `connectionType` string, required — A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). - `contact` string[] — Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. - `header` string[] — Additional headers / information to send as part of the notification. - `_header` string[] - `identifier` integer[] — Identifier for the organization that is used to identify the endpoint across multiple disparate systems. - `managingOrganization` string — The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). - `name` string — A friendly name that this endpoint can be referred to with. - `_name` string - `payloadMimeType` string[] — The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). - `_payloadMimeType` string[] - `payloadType` string[], required — The payload type describes the acceptable content that can be communicated on the endpoint. - `period` string — The interval during which the endpoint is expected to be operational. - `status` string — active | suspended | error | off | test. - `_status` string - DocumentReference — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A reference to a document. 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. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `authenticator` string — Which person or organization authenticates that this document is valid. - `author` string[] — Identifies who is responsible for adding the information to the document. - `category` string[] — 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. - `content` string[], required — The document and format referenced. There may be multiple content element repetitions, each with a different format. - `context` unknown - `custodian` string — Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. - `date` string, date-time — When the document reference was created. - `_date` string - `description` string — Human-readable description of the source document. - `_description` string - `docStatus` string — The status of the underlying document. - `_docStatus` string - `identifier` integer[] — Other identifiers associated with the document, including version independent identifiers. - `masterIdentifier` integer — 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. - `relatesTo` string[] — Relationships that this document has with other document references that already exist. - `securityLabel` string[] — 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` string — The status of this document reference. - `_status` string - `subject` string — 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). - `type` string — 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. - `resourceId` string — A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete. ## Response `200` Successful Response - DefinitionAPI - `quality_program` string — Quality program this definition is associated with. - `name` string, required — Human readable name for the definition - `indicator` 'info' | 'warning' | 'critical', required — An enumeration. - `source` Source, required - `label` string, required — A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink. - `url` string — An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card. Note that this URL should not be used to supply a context-specific 'drill-down' view of the information on this card. For that, use link.url instead. - `icon` string — An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. - `topic` Coding - `code` string — The code for what is being represented - `display` string — A codesystem for this code. - `system` string — A short, human-readable label to display. - `context` CodingContext - `target` 'problem-list-item' | 'encounter-diagnosis' — An enumeration. - `selection_behavior` 'any' | 'at-most-one', required — An enumeration. - `closing_codes` Coding[] — List of closing codes. - `code` string — The code for what is being represented - `display` string — A codesystem for this code. - `system` string — A short, human-readable label to display. - `context` CodingContext - `target` 'problem-list-item' | 'encounter-diagnosis' — An enumeration. - `description` string — Sentence that describes the definition. Allowed HTML tags: a, abbr, acronym, b, blockquote, br, code, div, em, h1, h2, h3, h4, h5, h6, i, li, ol, p, strong, u, ul - `practice_id` string — Practice id this definition is authorized for. - `override_reasons` Coding[] — Override reasons written as codings for the definition - `code` string — The code for what is being represented - `display` string — A codesystem for this code. - `system` string — A short, human-readable label to display. - `context` CodingContext - `target` 'problem-list-item' | 'encounter-diagnosis' — An enumeration. - `links` Link[] — Relevant links for the definition - `label` string, required — Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link). - `url` string, required — URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash. - `type` string, required — The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters. - `app_context` string — An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it. - `start_date` string, date, required — Start date for period - `end_date` string, date, required — End date for period - `additional_documentation` DocSection[] — Additional documentation sections for reference in the EHR. Allowed HTML tags: a, abbr, acronym - `type` 'text' | 'footer' | 'subsection', required — An enumeration. - `paragraphs` string[] — List of paragraphs to render for a text type doc section - `subsections` SubSection[] — Mappings between subsection titles and content. Required for footer or subsection type sections - `label` string, required — TBD - `text` string, required — TBD - `subtitle` string, required — Documentation section heading - `external_id` string — Identifer for linking to external systems - `suggestions` ExistingSuggestion[], required — List of suggestions to take action on with this definition that includes a uuid - `label` string, required — Human-readable label to display for this suggestion (e.g. the CDS Client might render this as the text on a button tied to this suggestion). - `is_recommended` boolean, required — When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card. CDS Hooks clients may choose to influence their UI based on this value, such as pre-selecting, or highlighting recommended suggestions. Multiple suggestions MAY be recommended, if card.selectionBehavior is any. - `actions` Action[] — Array of objects, each defining a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within it. - `type` 'create' | 'update' | 'delete', required — An enumeration. - `description` string, required — Human-readable description of the suggested action MAY be presented to the end-user. - `resource` union — A FHIR resource. When the type attribute is create, the resource attribute SHALL contain a new FHIR resource to be created. For update, this holds the updated resource in its entirety and not just the changed fields. Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead. - ValueSet — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A set of codes drawn from one or more code systems. A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html). - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `compose` string — A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD). - `contact` string[] — Contact details to assist a user in finding and communicating with the publisher. - `copyright` string — A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. - `_copyright` string - `date` string, date-time — The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition'). - `_date` string - `description` string — A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set. - `_description` string - `expansion` string — A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed. - `experimental` boolean — A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. - `_experimental` string - `identifier` integer[] — A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance. - `immutable` boolean — If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change. - `_immutable` string - `jurisdiction` string[] — A legal or geographic region in which the value set is intended to be used. - `name` string — A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation. - `_name` string - `publisher` string — The name of the organization or individual that published the value set. - `_publisher` string - `purpose` string — Explanation of why this value set is needed and why it has been designed as it has. - `_purpose` string - `status` string — The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state. - `_status` string - `title` string — A short, descriptive, user-friendly title for the value set. - `_title` string - `url` string — An absolute URI that is used to identify this value set 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 value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers. - `_url` string - `useContext` string[] — 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 value set instances. - `version` string — The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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. - `_version` string - Observation — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Measurements and simple assertions. Measurements and simple assertions made about a patient, device or other subject. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `basedOn` string[] — 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` string — Indicates the site on the subject's body where the observation was made (i.e. the target site). - `category` string[] — A code that classifies the general type of observation being made. - `code` string, required — Describes what was observed. Sometimes this is called the observation "name". - `component` string[] — 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. - `dataAbsentReason` string — Provides a reason why the expected value in the element Observation.value[x] is missing. - `derivedFrom` string[] — 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` string — The device used to generate the observation data. - `effectiveDateTime` string, date-time — 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. - `_effectiveDateTime` string - `effectiveInstant` string, date-time — 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. - `_effectiveInstant` string - `effectivePeriod` string — 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. - `effectiveTiming` string — 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` string — The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. - `focus` string[] — 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` string[] — 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. - `identifier` integer[] — A unique identifier assigned to this observation. - `interpretation` string[] — A categorical assessment of an observation value. For example, high, low, normal. - `issued` string, date-time — The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. - `_issued` string - `method` string — Indicates the mechanism used to perform the observation. - `note` string[] — Comments about the observation or the results. - `partOf` string[] — A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. - `performer` string[] — Who was responsible for asserting the observed value as "true". - `referenceRange` string[] — 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 `referenceRange` elements would be used. - `specimen` string — The specimen that was used when this observation was made. - `status` string — The status of the result value. - `_status` string - `subject` string — 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 `focus` element or the `code` itself specifies the actual focus of the observation. - `valueBoolean` boolean — The information determined as a result of making the observation, if the information has a simple value. - `_valueBoolean` string - `valueCodeableConcept` string — The information determined as a result of making the observation, if the information has a simple value. - `valueDateTime` string, date-time — The information determined as a result of making the observation, if the information has a simple value. - `_valueDateTime` string - `valueInteger` integer — The information determined as a result of making the observation, if the information has a simple value. - `_valueInteger` string - `valuePeriod` string — The information determined as a result of making the observation, if the information has a simple value. - `valueQuantity` integer — The information determined as a result of making the observation, if the information has a simple value. - `valueRange` integer — The information determined as a result of making the observation, if the information has a simple value. - `valueRatio` string — The information determined as a result of making the observation, if the information has a simple value. - `valueSampledData` string — The information determined as a result of making the observation, if the information has a simple value. - `valueString` string — The information determined as a result of making the observation, if the information has a simple value. - `_valueString` string - `valueTime` string, time — The information determined as a result of making the observation, if the information has a simple value. - `_valueTime` string - Condition — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Detailed information about conditions, problems or diagnoses. A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `abatementAge` integer — 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. - `abatementDateTime` string, date-time — 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. - `_abatementDateTime` string - `abatementPeriod` string — 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. - `abatementRange` integer — 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. - `abatementString` string — 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. - `_abatementString` string - `asserter` string — Individual who is making the condition statement. - `bodySite` string[] — The anatomical location where this condition manifests itself. - `category` string[] — A category assigned to the condition. - `clinicalStatus` string — The clinical status of the condition. - `code` string - `encounter` string — The Encounter during which this Condition was created or to which the creation of this record is tightly associated. - `evidence` string[] — Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. - `identifier` integer[] — 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. - `note` string[] — Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. - `onsetAge` integer — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `onsetDateTime` string, date-time — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `_onsetDateTime` string - `onsetPeriod` string — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `onsetRange` integer — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `onsetString` string — Estimated or actual date or date-time the condition began, in the opinion of the clinician. - `_onsetString` string - `recordedDate` string, date-time — The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date. - `_recordedDate` string - `recorder` string — Individual who recorded the record and takes responsibility for its content. - `severity` string — A subjective assessment of the severity of the condition as evaluated by the clinician. - `stage` string[] — Clinical stage or grade of a condition. May include formal severity assessments. - `subject` string, required — Indicates the patient or group who the condition record is associated with. - `verificationStatus` string — The verification status to support the clinical status of the condition. - ServiceRequest — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A request for a service to be performed. A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `asNeededBoolean` boolean — If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. - `_asNeededBoolean` string - `asNeededCodeableConcept` string — If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. - `authoredOn` string, date-time — When the request transitioned to being actionable. - `_authoredOn` string - `basedOn` string[] — Plan/proposal/order fulfilled by this request. - `bodySite` string[] — Anatomic location where the procedure should be performed. This is the target site. - `category` string[] — A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). - `code` string — A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. - `doNotPerform` boolean — Set this to true if the record is saying that the service/procedure should NOT be performed. - `_doNotPerform` string - `encounter` string — An encounter that provides additional information about the healthcare context in which this request is made. - `identifier` integer[] — Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. - `instantiatesCanonical` string[] — 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. - `_instantiatesCanonical` string[] - `instantiatesUri` string[] — 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. - `_instantiatesUri` string[] - `insurance` string[] — Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. - `intent` string — Whether the request is a proposal, plan, an original order or a reflex order. - `_intent` string - `locationCode` string[] — 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` string[] — A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. - `note` string[] — Any other notes and comments made about the service request. For example, internal billing notes. - `occurrenceDateTime` string, date-time — The date/time at which the requested service should occur. - `_occurrenceDateTime` string - `occurrencePeriod` string — The date/time at which the requested service should occur. - `occurrenceTiming` string — The date/time at which the requested service should occur. - `orderDetail` string[] — 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` string — Instructions in terms that are understood by the patient or consumer. - `_patientInstruction` string - `performer` string[] — The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. - `performerType` string — Desired type of performer for doing the requested service. - `priority` string — Indicates how quickly the ServiceRequest should be addressed with respect to other requests. - `_priority` string - `quantityQuantity` integer — 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). - `quantityRange` integer — 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). - `quantityRatio` string — 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` string[] — 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` string[] — Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. - `relevantHistory` string[] — Key events in the history of the request. - `replaces` string[] — The request takes the place of the referenced completed or terminated request(s). - `requester` string — The individual who initiated the request and has responsibility for its activation. - `requisition` integer — 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` string[] — One or more specimens that the laboratory procedure will use. - `status` string — The status of the order. - `_status` string - `subject` string, required — 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` string[] — 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. - Immunization — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Immunization event information. 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. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `doseQuantity` integer — The quantity of vaccine product that was administered. - `education` string[] — Educational material presented to the patient (or guardian) at the time of vaccine administration. - `encounter` string — The visit or admission or other contact between patient and health care provider the immunization was performed as part of. - `expirationDate` string, date — Date vaccine batch expires. - `_expirationDate` string - `fundingSource` string — 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). - `identifier` integer[] — A unique identifier assigned to this immunization record. - `isSubpotent` boolean — Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. - `_isSubpotent` string - `location` string — The service delivery location where the vaccine administration occurred. - `lotNumber` string — Lot number of the vaccine product. - `_lotNumber` string - `manufacturer` string — Name of vaccine manufacturer. - `note` string[] — Extra information about the immunization that is not conveyed by the other attributes. - `occurrenceDateTime` string, date-time — Date vaccine administered or was to be administered. - `_occurrenceDateTime` string - `occurrenceString` string — Date vaccine administered or was to be administered. - `_occurrenceString` string - `patient` string, required — The patient who either received or did not receive the immunization. - `performer` string[] — Indicates who performed the immunization event. - `primarySource` boolean — 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. - `_primarySource` string - `programEligibility` string[] — Indicates a patient's eligibility for a funding program. - `protocolApplied` string[] — The protocol (set of recommendations) being followed by the provider who administered the dose. - `reaction` string[] — Categorical data indicating that an adverse event is associated in time to an immunization. - `reasonCode` string[] — Reasons why the vaccine was administered. - `reasonReference` string[] — Condition, Observation or DiagnosticReport that supports why the immunization was administered. - `recorded` string, date-time — The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. - `_recorded` string - `reportOrigin` string — 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` string — The path by which the vaccine product is taken into the body. - `site` string — Body site where vaccine was administered. - `status` string — Indicates the current status of the immunization event. - `_status` string - `statusReason` string — Indicates the reason the immunization event was not performed. - `subpotentReason` string[] — Reason why a dose is considered to be subpotent. - `vaccineCode` string, required — Vaccine that was administered or was to be administered. - AllergyIntolerance — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. Allergy or Intolerance (generally: Risk of adverse reaction to a substance). Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `asserter` string — The source of the information about the allergy that is recorded. - `category` string[] — Category of the identified substance. - `_category` string[] - `clinicalStatus` string — The clinical status of the allergy or intolerance. - `code` string — 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. - `criticality` string — Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. - `_criticality` string - `encounter` string — The encounter when the allergy or intolerance was asserted. - `identifier` integer[] — 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. - `lastOccurrence` string, date-time — Represents the date and/or time of the last known occurrence of a reaction event. - `_lastOccurrence` string - `note` string[] — Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. - `onsetAge` integer — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `onsetDateTime` string, date-time — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `_onsetDateTime` string - `onsetPeriod` string — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `onsetRange` integer — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `onsetString` string — Estimated or actual date, date-time, or age when allergy or intolerance was identified. - `_onsetString` string - `patient` string, required — The patient who has the allergy or intolerance. - `reaction` string[] — Details about each adverse reaction event linked to exposure to the identified substance. - `recordedDate` string, date-time — The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. - `_recordedDate` string - `recorder` string — Individual who recorded the record and takes responsibility for its content. - `type` string — Identification of the underlying physiological mechanism for the reaction risk. - `_type` string - `verificationStatus` string — Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). - Communication — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A record of information transmitted from a sender to a receiver. 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. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `about` string[] — Other resources that pertain to this communication and to which this communication should be associated. - `basedOn` string[] — An order, proposal or plan fulfilled in whole or in part by this Communication. - `category` string[] — The type of message conveyed such as alert, notification, reminder, instruction, etc. - `encounter` string — The Encounter during which this Communication was created or to which the creation of this record is tightly associated. - `identifier` integer[] — 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. - `inResponseTo` string[] — Prior communication that this communication is in response to. - `instantiatesCanonical` string[] — 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. - `_instantiatesCanonical` string[] - `instantiatesUri` string[] — 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. - `_instantiatesUri` string[] - `medium` string[] — A channel that was used for this communication (e.g. email, fax). - `note` string[] — Additional notes or commentary about the communication by the sender, receiver or other interested parties. - `partOf` string[] - `payload` string[] — Text, attachment(s), or resource(s) that was communicated to the recipient. - `priority` string — Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. - `_priority` string - `reasonCode` string[] — The reason or justification for the communication. - `reasonReference` string[] — Indicates another resource whose existence justifies this communication. - `received` string, date-time — The time when this communication arrived at the destination. - `_received` string - `recipient` string[] — 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` string — The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. - `sent` string, date-time — The time when this communication was sent. - `_sent` string - `status` string — The status of the transmission. - `_status` string - `statusReason` string — Captures the reason for the current state of the Communication. - `subject` string — The patient or group that was the focus of this communication. - `topic` string — Description of the purpose/content, similar to a subject line in an email. - Endpoint — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. The technical details of an endpoint that can be used for electronic services. The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `address` string, uri — The uri that describes the actual end-point to connect to. - `_address` string - `connectionType` string, required — A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). - `contact` string[] — Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. - `header` string[] — Additional headers / information to send as part of the notification. - `_header` string[] - `identifier` integer[] — Identifier for the organization that is used to identify the endpoint across multiple disparate systems. - `managingOrganization` string — The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). - `name` string — A friendly name that this endpoint can be referred to with. - `_name` string - `payloadMimeType` string[] — The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). - `_payloadMimeType` string[] - `payloadType` string[], required — The payload type describes the acceptable content that can be communicated on the endpoint. - `period` string — The interval during which the endpoint is expected to be operational. - `status` string — active | suspended | error | off | test. - `_status` string - DocumentReference — Disclaimer: Any field name ends with ``__ext`` does't part of Resource StructureDefinition, instead used to enable Extensibility feature for FHIR Primitive Data Types. A reference to a document. 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. - `resource_type` string - `fhir_comments` union - string - string[] - `id` string — The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. - `_id` string - `implicitRules` string — 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. - `_implicitRules` string - `language` string — The base language in which the resource is written. - `_language` string - `meta` string — The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `contained` string[] — 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` string[] — 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. - `modifierExtension` string[] — 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` string — A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. - `authenticator` string — Which person or organization authenticates that this document is valid. - `author` string[] — Identifies who is responsible for adding the information to the document. - `category` string[] — 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. - `content` string[], required — The document and format referenced. There may be multiple content element repetitions, each with a different format. - `context` unknown - `custodian` string — Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. - `date` string, date-time — When the document reference was created. - `_date` string - `description` string — Human-readable description of the source document. - `_description` string - `docStatus` string — The status of the underlying document. - `_docStatus` string - `identifier` integer[] — Other identifiers associated with the document, including version independent identifiers. - `masterIdentifier` integer — 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. - `relatesTo` string[] — Relationships that this document has with other document references that already exist. - `securityLabel` string[] — 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` string — The status of this document reference. - `_status` string - `subject` string — 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). - `type` string — 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. - `resourceId` string — A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete. - `uuid` string, required — Unique identifier, used for auditing and logging suggestions. - `id` string, required — UUID that identifies this definition ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/elationhealth/apis/billing-api.md) · [All operations](https://skmtc.net/elationhealth/apis/billing-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elationhealth/billing-api/versions/0acfdeb9bd9b/schema)