HealthPlan
This resource represents the health plan (for example the HealthierSG programme)
| profile-HealthPlan-put-health-plan (CarePlan) | C | CarePlan | Element idCarePlanShort description Healthcare plan for patient or group Alternate namesCare Team DefinitionDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
| |||
| id | Σ | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idCarePlan.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idCarePlan.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idCarePlan.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). IETF language tag
| |||
| text | 0..0 | Narrative | There are no (further) constraints on this element Element idCarePlan.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |||
| contained | C | 0..* | Resource | There are no (further) constraints on this element Element idCarePlan.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| ||
| extension | C | 1..* | Extension | Element idCarePlan.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
| ||
| performer | C | 1..1 | Extension(Identifier) | Element idCarePlan.extension:performerShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ihis.sg/extension/performer ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idCarePlan.identifierShort description External Ids for this plan DefinitionBusiness identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
| ||
| instantiatesCanonical | Σ | 0..0 | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | There are no (further) constraints on this element Element idCarePlan.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Constraints
| ||
| instantiatesUri | Σ | 0..0 | uri | There are no (further) constraints on this element Element idCarePlan.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
| ||
| basedOn | Σ | 0..0 | Reference(CarePlan) | There are no (further) constraints on this element Element idCarePlan.basedOnShort description Fulfills CarePlan Alternate namesfulfills DefinitionA care plan that is fulfilled in whole or in part by this care plan. Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.
| ||
| replaces | Σ | 0..0 | Reference(CarePlan) | There are no (further) constraints on this element Element idCarePlan.replacesShort description CarePlan replaced by this CarePlan Alternate namessupersedes DefinitionCompleted or terminated care plan whose function is taken by this new care plan. Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans. The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.
| ||
| partOf | Σ | 0..0 | Reference(CarePlan) | There are no (further) constraints on this element Element idCarePlan.partOfShort description Part of referenced CarePlan DefinitionA larger care plan of which this particular care plan is a component or step. Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.
| ||
| status | Σ ?! | 1..1 | codeBindingFixed Value | Element idCarePlan.statusShort description draft | active | on-hold | revoked | completed | entered-in-error | unknown DefinitionIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Allows clinicians to determine whether the plan is actionable or not. The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan. This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid. Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
activeMappings
| ||
| intent | Σ ?! | 1..1 | codeBindingFixed Value | Element idCarePlan.intentShort description proposal | plan | order | option DefinitionIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. Codes indicating the degree of authority/intentionality associated with a care plan.
planMappings
| ||
| category | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.categoryShort description Type of plan DefinitionIdentifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc. Used for filtering what plan(s) are retrieved and displayed to different types of users. There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern. Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.category.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.category.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 0..* | CodingBinding | Element idCarePlan.category.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. http://ihis.sg/ValueSet/hsg-care-plan-category (required) Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.category.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.category.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.category.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-care-plan-categoryMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.category.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idCarePlan.category.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.category.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.category.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.category.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| title | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.titleShort description Human-friendly name for the care plan DefinitionHuman-friendly name for the care plan.
| ||
| description | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.descriptionShort description Summary of nature of plan DefinitionA description of the scope and nature of the plan. Provides more detail than conveyed by category.
| ||
| subject | Σ | 1..1 | Reference(Patient) | Element idCarePlan.subjectShort description Who the care plan is for Alternate namespatient DefinitionIdentifies the patient or group whose intended care is described by the plan.
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.subject.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.subject.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.subject.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ | 1..1 | uriBindingFixed Value | Element idCarePlan.subject.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
PatientMappings
| ||
| identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idCarePlan.subject.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.subject.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.subject.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idCarePlan.subject.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
| ||
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCarePlan.subject.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.subject.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
http://ihis.sg/identifier/nricExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ C | 1..1 | string | Element idCarePlan.subject.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456Mappings
| ||
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idCarePlan.subject.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idCarePlan.subject.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.subject.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
| encounter | Σ | 0..0 | Reference(Encounter) | There are no (further) constraints on this element Element idCarePlan.encounterShort description Encounter created as part of DefinitionThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.
| ||
| period | Σ | 1..1 | Period | There are no (further) constraints on this element Element idCarePlan.periodShort description Time period plan covers Alternate namestiming DefinitionIndicates when the plan did (or is intended to) come into effect and end. Allows tracking what plan(s) are in effect at a particular time. Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.period.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.period.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| start | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idCarePlan.period.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: per-1 Constraints
| ||
| end | Σ C | 0..1 | dateTime | There are no (further) constraints on this element Element idCarePlan.period.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: per-1 Constraints
| ||
| created | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idCarePlan.createdShort description Date record was first recorded Alternate namesauthoredOn DefinitionRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.
| ||
| author | Σ | 1..1 | Reference(Organization) | Element idCarePlan.authorShort description Who is the designated responsible party DefinitionWhen populated, the author is responsible for the care plan. The care plan is attributed to the author. The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.author.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.author.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.author.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ | 1..1 | uriBindingFixed Value | Element idCarePlan.author.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
OrganizationMappings
| ||
| identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idCarePlan.author.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.author.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.author.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idCarePlan.author.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
| ||
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCarePlan.author.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.author.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
http://ihis.sg/identifier/hci-codeExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ C | 1..1 | string | Element idCarePlan.author.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456Mappings
| ||
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idCarePlan.author.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idCarePlan.author.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.author.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
| contributor | 0..0 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | There are no (further) constraints on this element Element idCarePlan.contributorShort description Who provided the content of the care plan DefinitionIdentifies the individual(s) or organization who provided the contents of the care plan. Collaborative care plans may have multiple contributors. Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Constraints
| |||
| careTeam | 0..0 | Reference(CareTeam) | There are no (further) constraints on this element Element idCarePlan.careTeamShort description Who's involved in plan? DefinitionIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan. Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.
| |||
| addresses | Σ | 0..* | Reference(Condition) | There are no (further) constraints on this element Element idCarePlan.addressesShort description Health issues this plan addresses DefinitionIdentifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns. When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idCarePlan.addresses.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCarePlan.addresses.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.addresses.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idCarePlan.addresses.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idCarePlan.addresses.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.addresses.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
| supportingInfo | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idCarePlan.supportingInfoShort description Information considered as part of plan DefinitionIdentifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. Identifies barriers and other considerations associated with the care plan. Use "concern" to identify specific conditions addressed by the care plan.
| |||
| goal | 0..* | Reference(Goal) | There are no (further) constraints on this element Element idCarePlan.goalShort description Desired outcome of plan DefinitionDescribes the intended objective(s) of carrying out the care plan. Provides context for plan. Allows plan effectiveness to be evaluated by clinicians. Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.
| |||
| id | 0..1 | id | There are no (further) constraints on this element Element idCarePlan.goal.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCarePlan.goal.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.goal.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idCarePlan.goal.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idCarePlan.goal.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.goal.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
| ||
| activity | C | 0..* | BackboneElement | Element idCarePlan.activityShort description Action to occur as part of plan DefinitionIdentifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc. Allows systems to prompt for performance of planned activities, and validate plans against best practice. Unordered, Open, by detail.code.coding.system(Value) Constraints
| ||
| (All Slices) | The requirements in this element apply to all slices | |||||
| id | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.activity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| outcomeCodeableConcept | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity.outcomeCodeableConceptShort description Results of the activity DefinitionIdentifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). Note that this should not duplicate the activity status (e.g. completed or in progress). Identifies the results of the activity. CarePlanActivityOutcome (example) Constraints
| |||
| outcomeReference | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idCarePlan.activity.outcomeReferenceShort description Appointment, Encounter, Procedure, etc. DefinitionDetails of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). Links plan to resulting actions. The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.
| |||
| progress | 0..0 | Annotation | There are no (further) constraints on this element Element idCarePlan.activity.progressShort description Comments about the activity status/progress DefinitionNotes about the adherence/status/progress of the activity. Can be used to capture information about adherence, progress, concerns, etc. This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.
| |||
| reference | C | 0..0 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | There are no (further) constraints on this element Element idCarePlan.activity.referenceShort description Activity details defined in specific resource DefinitionThe details of the proposed activity represented in a specific resource. Details in a form consistent with other applications and contexts of use. Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) ConditionsThe cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| detail | C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idCarePlan.activity.detailShort description In-line definition of activity DefinitionA simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc. Details in a simple form for generic care plan systems. The cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.activity.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCarePlan.activity.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idCarePlan.activity.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| kind | 0..1 | codeBinding | There are no (further) constraints on this element Element idCarePlan.activity.detail.kindShort description Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription DefinitionA description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. May determine what types of extensions are permitted. Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. CarePlanActivityKind (required) Constraints
| |||
| instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | There are no (further) constraints on this element Element idCarePlan.activity.detail.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Constraints
| |||
| instantiatesUri | 0..* | uri | There are no (further) constraints on this element Element idCarePlan.activity.detail.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
| |||
| code | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity.detail.codeShort description Detail type of activity DefinitionDetailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. Allows matching performed to planned as well as validation against protocols. Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. ProcedureCodes(SNOMEDCT) (example) Constraints
| |||
| reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity.detail.reasonCodeShort description Why activity should be done or why activity was prohibited DefinitionProvides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. SNOMEDCTClinicalFindings (example) Constraints
| |||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idCarePlan.activity.detail.reasonReferenceShort description Why activity is needed DefinitionIndicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. Conditions can be identified at the activity level that are not identified as reasons for the overall plan. Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
| |||
| goal | 0..* | Reference(Goal) | There are no (further) constraints on this element Element idCarePlan.activity.detail.goalShort description Goals this activity relates to DefinitionInternal reference that identifies the goals that this activity is intended to contribute towards meeting. So that participants know the link explicitly.
| |||
| status | ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCarePlan.activity.detail.statusShort description not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error DefinitionIdentifies what progress is being made for the specific activity. Indicates progress against the plan, whether the activity is still relevant for the plan. Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated. Codes that reflect the current state of a care plan activity within its overall life cycle. CarePlanActivityStatus (required) Constraints
| ||
| statusReason | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity.detail.statusReasonShort description Reason for current status DefinitionProvides reason why the activity isn't yet started, is on hold, was cancelled, etc. Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.
| |||
| doNotPerform | ?! | 0..1 | boolean | There are no (further) constraints on this element Element idCarePlan.activity.detail.doNotPerformShort description If true, activity is prohibiting action DefinitionIf true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. Captures intention to not do something that may have been previously typical. This element is labeled as a modifier because it marks an activity as an activity that is not to be performed. If missing indicates that the described activity is one that should be engaged in when following the plan.
| ||
| scheduled[x] | 0..1 | There are no (further) constraints on this element Element idCarePlan.activity.detail.scheduled[x]Short description When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities.
| ||||
| scheduledTiming | Timing | There are no (further) constraints on this element Data type | ||||
| scheduledPeriod | Period | There are no (further) constraints on this element Data type | ||||
| scheduledString | string | There are no (further) constraints on this element Data type | ||||
| location | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idCarePlan.activity.detail.locationShort description Where it should happen DefinitionIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Helps in planning of activity. May reference a specific clinical location or may identify a type of location.
| |||
| performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | There are no (further) constraints on this element Element idCarePlan.activity.detail.performerShort description Who will be responsible? DefinitionIdentifies who's expected to be involved in the activity. Helps in planning of activity. A performer MAY also be a participant in the care plan. Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Constraints
| |||
| product[x] | 0..1 | There are no (further) constraints on this element Element idCarePlan.activity.detail.product[x]Short description What is to be administered/supplied DefinitionIdentifies the food, drug or other product to be consumed or supplied in the activity. A product supplied or administered as part of a care plan activity. SNOMEDCTMedicationCodes (example) Constraints
| ||||
| productCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| productReference | Reference(Medication | Substance) | There are no (further) constraints on this element Data type | ||||
| dailyAmount | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity.detail.dailyAmountShort description How to consume/day? Alternate namesdaily dose DefinitionIdentifies the quantity expected to be consumed in a given day. Allows rough dose checking.
| |||
| quantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity.detail.quantityShort description How much to administer/supply/consume DefinitionIdentifies the quantity expected to be supplied, administered or consumed by the subject.
| |||
| description | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.activity.detail.descriptionShort description Extra info describing activity to perform DefinitionThis provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
| |||
| recommended-next-check-in | C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-inShort description Action to occur as part of plan DefinitionIdentifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc. Allows systems to prompt for performance of planned activities, and validate plans against best practice.
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| outcomeCodeableConcept | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.outcomeCodeableConceptShort description Results of the activity DefinitionIdentifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). Note that this should not duplicate the activity status (e.g. completed or in progress). Identifies the results of the activity. CarePlanActivityOutcome (example) Constraints
| |||
| outcomeReference | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.outcomeReferenceShort description Appointment, Encounter, Procedure, etc. DefinitionDetails of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). Links plan to resulting actions. The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.
| |||
| progress | 0..0 | Annotation | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.progressShort description Comments about the activity status/progress DefinitionNotes about the adherence/status/progress of the activity. Can be used to capture information about adherence, progress, concerns, etc. This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.
| |||
| reference | C | 0..0 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.referenceShort description Activity details defined in specific resource DefinitionThe details of the proposed activity represented in a specific resource. Details in a form consistent with other applications and contexts of use. Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) ConditionsThe cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| detail | C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detailShort description In-line definition of activity DefinitionA simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc. Details in a simple form for generic care plan systems. The cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| kind | 1..1 | codeBindingFixed Value | Element idCarePlan.activity:recommended-next-check-in.detail.kindShort description Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription DefinitionA description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. May determine what types of extensions are permitted. Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. CarePlanActivityKind (required) Constraints
AppointmentMappings
| |||
| instantiatesCanonical | 0..0 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Constraints
| |||
| instantiatesUri | 0..0 | uri | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
| |||
| code | 1..1 | CodeableConceptBinding | Element idCarePlan.activity:recommended-next-check-in.detail.codeShort description Detail type of activity DefinitionDetailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. Allows matching performed to planned as well as validation against protocols. Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. http://ihis.sg/ValueSet/hsg-healthplan-activity-type (required) Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.activity:recommended-next-check-in.detail.code.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-healthplan-activity-typeMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ | 1..1 | code | Element idCarePlan.activity:recommended-next-check-in.detail.code.coding.codeShort description Sample Value : "recommended-next-check-in" DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
| display | Σ | 0..1 | string | Element idCarePlan.activity:recommended-next-check-in.detail.code.coding.displayShort description Sample Value : "Recommended Next Check-in" DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.code.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| reasonCode | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.reasonCodeShort description Why activity should be done or why activity was prohibited DefinitionProvides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. SNOMEDCTClinicalFindings (example) Constraints
| |||
| reasonReference | 0..0 | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.reasonReferenceShort description Why activity is needed DefinitionIndicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. Conditions can be identified at the activity level that are not identified as reasons for the overall plan. Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
| |||
| goal | 0..0 | Reference(Goal) | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.goalShort description Goals this activity relates to DefinitionInternal reference that identifies the goals that this activity is intended to contribute towards meeting. So that participants know the link explicitly.
| |||
| status | ?! | 1..1 | codeBindingFixed Value | Element idCarePlan.activity:recommended-next-check-in.detail.statusShort description status of the activity DefinitionIdentifies what progress is being made for the specific activity. Indicates progress against the plan, whether the activity is still relevant for the plan. Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated. Codes that reflect the current state of a care plan activity within its overall life cycle. CarePlanActivityStatus (required) Constraints
scheduledMappings
| ||
| statusReason | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.statusReasonShort description Reason for current status DefinitionProvides reason why the activity isn't yet started, is on hold, was cancelled, etc. Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.
| |||
| doNotPerform | ?! | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.doNotPerformShort description If true, activity is prohibiting action DefinitionIf true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. Captures intention to not do something that may have been previously typical. This element is labeled as a modifier because it marks an activity as an activity that is not to be performed. If missing indicates that the described activity is one that should be engaged in when following the plan.
| ||
| scheduled[x] | 1..1 | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.scheduled[x]Short description When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities.
| ||||
| scheduledTiming | Timing | Data type | ||||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.scheduled[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.scheduled[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.scheduled[x].modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| event | Σ C | 1..1 | dateTime | Element idCarePlan.activity:recommended-next-check-in.detail.scheduled[x].eventShort description Sample Value: "2023-10" DefinitionIdentifies specific times when the event occurs. Format: YYYY-MM In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
| ||
| repeat | Σ C | 0..0 | Element | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.scheduled[x].repeatShort description When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
| ||
| code | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.scheduled[x].codeShort description BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). TimingAbbreviation (preferred) Constraints
| ||
| location | 0..0 | Reference(Location) | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.locationShort description Where it should happen DefinitionIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Helps in planning of activity. May reference a specific clinical location or may identify a type of location.
| |||
| performer | 0..0 | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.performerShort description Who will be responsible? DefinitionIdentifies who's expected to be involved in the activity. Helps in planning of activity. A performer MAY also be a participant in the care plan. Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Constraints
| |||
| product[x] | 0..0 | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.product[x]Short description What is to be administered/supplied DefinitionIdentifies the food, drug or other product to be consumed or supplied in the activity. A product supplied or administered as part of a care plan activity. SNOMEDCTMedicationCodes (example) Constraints
| ||||
| dailyAmount | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.dailyAmountShort description How to consume/day? Alternate namesdaily dose DefinitionIdentifies the quantity expected to be consumed in a given day. Allows rough dose checking.
| |||
| quantity | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.quantityShort description How much to administer/supply/consume DefinitionIdentifies the quantity expected to be supplied, administered or consumed by the subject.
| |||
| description | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:recommended-next-check-in.detail.descriptionShort description Extra info describing activity to perform DefinitionThis provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
| |||
| Diet | C | 0..7 | BackboneElement | There are no (further) constraints on this element Element idCarePlan.activity:DietShort description Action to occur as part of plan DefinitionIdentifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc. Allows systems to prompt for performance of planned activities, and validate plans against best practice.
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| outcomeCodeableConcept | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConceptShort description Results of the activity DefinitionIdentifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). Note that this should not duplicate the activity status (e.g. completed or in progress). Identifies the results of the activity. CarePlanActivityOutcome (example) Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | CodingBinding | Element idCarePlan.activity:Diet.outcomeCodeableConcept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. http://ihis.sg/ValueSet/hsg-action-plan-category (required) Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.activity:Diet.outcomeCodeableConcept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-action-plan-categoryMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ | 1..1 | codeFixed Value | Element idCarePlan.activity:Diet.outcomeCodeableConcept.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
AP1Mappings
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeCodeableConcept.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| outcomeReference | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idCarePlan.activity:Diet.outcomeReferenceShort description Appointment, Encounter, Procedure, etc. DefinitionDetails of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). Links plan to resulting actions. The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.
| |||
| progress | 0..0 | Annotation | There are no (further) constraints on this element Element idCarePlan.activity:Diet.progressShort description Comments about the activity status/progress DefinitionNotes about the adherence/status/progress of the activity. Can be used to capture information about adherence, progress, concerns, etc. This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.
| |||
| reference | C | 0..0 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | There are no (further) constraints on this element Element idCarePlan.activity:Diet.referenceShort description Activity details defined in specific resource DefinitionThe details of the proposed activity represented in a specific resource. Details in a form consistent with other applications and contexts of use. Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) ConditionsThe cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| detail | C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detailShort description In-line definition of activity DefinitionA simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc. Details in a simple form for generic care plan systems. The cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| kind | 1..1 | codeBindingFixed Value | Element idCarePlan.activity:Diet.detail.kindShort description Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription DefinitionA description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. May determine what types of extensions are permitted. Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. CarePlanActivityKind (required) Constraints
ServiceRequestMappings
| |||
| instantiatesCanonical | 0..0 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Constraints
| |||
| instantiatesUri | 0..0 | uri | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
| |||
| code | 1..1 | CodeableConceptBinding | Element idCarePlan.activity:Diet.detail.codeShort description Detail type of activity DefinitionDetailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. Allows matching performed to planned as well as validation against protocols. Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. http://ihis.sg/ValueSet/hsg-action-plan-diet-item (required) Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.activity:Diet.detail.code.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-action-plan-diet-itemMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ C | 1..1 | code | Element idCarePlan.activity:Diet.detail.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.code.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| reasonCode | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.reasonCodeShort description Why activity should be done or why activity was prohibited DefinitionProvides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. SNOMEDCTClinicalFindings (example) Constraints
| |||
| reasonReference | 0..0 | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.reasonReferenceShort description Why activity is needed DefinitionIndicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. Conditions can be identified at the activity level that are not identified as reasons for the overall plan. Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
| |||
| goal | 0..0 | Reference(Goal) | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.goalShort description Goals this activity relates to DefinitionInternal reference that identifies the goals that this activity is intended to contribute towards meeting. So that participants know the link explicitly.
| |||
| status | ?! | 1..1 | codeBindingFixed Value | Element idCarePlan.activity:Diet.detail.statusShort description fixed 'scheduled' DefinitionIdentifies what progress is being made for the specific activity. Indicates progress against the plan, whether the activity is still relevant for the plan. Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated. Codes that reflect the current state of a care plan activity within its overall life cycle. CarePlanActivityStatus (required) Constraints
scheduledMappings
| ||
| statusReason | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.statusReasonShort description Reason for current status DefinitionProvides reason why the activity isn't yet started, is on hold, was cancelled, etc. Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.
| |||
| doNotPerform | ?! | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.doNotPerformShort description If true, activity is prohibiting action DefinitionIf true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. Captures intention to not do something that may have been previously typical. This element is labeled as a modifier because it marks an activity as an activity that is not to be performed. If missing indicates that the described activity is one that should be engaged in when following the plan.
| ||
| scheduled[x] | 0..0 | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.scheduled[x]Short description When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities.
| ||||
| location | 0..0 | Reference(Location) | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.locationShort description Where it should happen DefinitionIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Helps in planning of activity. May reference a specific clinical location or may identify a type of location.
| |||
| performer | 0..0 | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.performerShort description Who will be responsible? DefinitionIdentifies who's expected to be involved in the activity. Helps in planning of activity. A performer MAY also be a participant in the care plan. Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Constraints
| |||
| product[x] | 0..0 | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.product[x]Short description What is to be administered/supplied DefinitionIdentifies the food, drug or other product to be consumed or supplied in the activity. A product supplied or administered as part of a care plan activity. SNOMEDCTMedicationCodes (example) Constraints
| ||||
| dailyAmount | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.dailyAmountShort description How to consume/day? Alternate namesdaily dose DefinitionIdentifies the quantity expected to be consumed in a given day. Allows rough dose checking.
| |||
| quantity | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.quantityShort description How much to administer/supply/consume DefinitionIdentifies the quantity expected to be supplied, administered or consumed by the subject.
| |||
| description | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Diet.detail.descriptionShort description Extra info describing activity to perform DefinitionThis provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
| |||
| Vaccination | C | 0..8 | BackboneElement | There are no (further) constraints on this element Element idCarePlan.activity:VaccinationShort description Action to occur as part of plan DefinitionIdentifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc. Allows systems to prompt for performance of planned activities, and validate plans against best practice.
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| outcomeCodeableConcept | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConceptShort description Results of the activity DefinitionIdentifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). Note that this should not duplicate the activity status (e.g. completed or in progress). Identifies the results of the activity. CarePlanActivityOutcome (example) Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | CodingBinding | Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. http://ihis.sg/ValueSet/hsg-action-plan-category (required) Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-action-plan-categoryMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ | 1..1 | codeFixed Value | Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
AP2Mappings
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeCodeableConcept.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| outcomeReference | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.outcomeReferenceShort description Appointment, Encounter, Procedure, etc. DefinitionDetails of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). Links plan to resulting actions. The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.
| |||
| progress | 0..0 | Annotation | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.progressShort description Comments about the activity status/progress DefinitionNotes about the adherence/status/progress of the activity. Can be used to capture information about adherence, progress, concerns, etc. This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.
| |||
| reference | C | 0..0 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.referenceShort description Activity details defined in specific resource DefinitionThe details of the proposed activity represented in a specific resource. Details in a form consistent with other applications and contexts of use. Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) ConditionsThe cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| detail | C | 1..1 | BackboneElement | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detailShort description In-line definition of activity DefinitionA simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc. Details in a simple form for generic care plan systems. The cardinality or value of this element may be affected by these constraints: cpl-3 Constraints
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..1 | Extension | Element idCarePlan.activity:Vaccination.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
| ||
| vaccinationExtension | C | 0..1 | Extension(date) | Element idCarePlan.activity:Vaccination.detail.extension:vaccinationExtensionShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ihis.sg/extension/dueDate ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.extension:vaccinationExtension.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.extension:vaccinationExtension.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.extension:vaccinationExtension.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://ihis.sg/extension/dueDateMappings
| |||
| value[x] | 0..1 | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.extension:vaccinationExtension.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||||
| valueDate | date | There are no (further) constraints on this element Data type | ||||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| kind | 1..1 | codeBindingFixed Value | Element idCarePlan.activity:Vaccination.detail.kindShort description fixed 'ServiceRequest' DefinitionA description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. May determine what types of extensions are permitted. Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. CarePlanActivityKind (required) Constraints
ServiceRequestMappings
| |||
| instantiatesCanonical | 0..0 | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.instantiatesCanonicalShort description Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Constraints
| |||
| instantiatesUri | 0..0 | uri | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.instantiatesUriShort description Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
| |||
| code | 1..1 | CodeableConceptBinding | Element idCarePlan.activity:Vaccination.detail.codeShort description Detail type of activity DefinitionDetailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. Allows matching performed to planned as well as validation against protocols. Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. http://ihis.sg/ValueSet/hsg-action-plan-vaccination-item (required) Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idCarePlan.activity:Vaccination.detail.code.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-action-plan-vaccination-itemMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ C | 1..1 | code | Element idCarePlan.activity:Vaccination.detail.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.code.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| reasonCode | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.reasonCodeShort description Why activity should be done or why activity was prohibited DefinitionProvides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. SNOMEDCTClinicalFindings (example) Constraints
| |||
| reasonReference | 0..0 | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.reasonReferenceShort description Why activity is needed DefinitionIndicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. Conditions can be identified at the activity level that are not identified as reasons for the overall plan. Reference(Condition | Observation | DiagnosticReport | DocumentReference) Constraints
| |||
| goal | 0..0 | Reference(Goal) | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.goalShort description Goals this activity relates to DefinitionInternal reference that identifies the goals that this activity is intended to contribute towards meeting. So that participants know the link explicitly.
| |||
| status | ?! | 1..1 | codeBindingFixed Value | Element idCarePlan.activity:Vaccination.detail.statusShort description fixed 'scheduled' DefinitionIdentifies what progress is being made for the specific activity. Indicates progress against the plan, whether the activity is still relevant for the plan. Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated. Codes that reflect the current state of a care plan activity within its overall life cycle. CarePlanActivityStatus (required) Constraints
scheduledMappings
| ||
| statusReason | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.statusReasonShort description Reason for current status DefinitionProvides reason why the activity isn't yet started, is on hold, was cancelled, etc. Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.
| |||
| doNotPerform | ?! | 0..0 | boolean | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.doNotPerformShort description If true, activity is prohibiting action DefinitionIf true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. Captures intention to not do something that may have been previously typical. This element is labeled as a modifier because it marks an activity as an activity that is not to be performed. If missing indicates that the described activity is one that should be engaged in when following the plan.
| ||
| scheduled[x] | 0..1 | Element idCarePlan.activity:Vaccination.detail.scheduled[x]Short description When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities. Unordered, Open, by $this(Type) Constraints
| ||||
| scheduledPeriod | Period | There are no (further) constraints on this element Data type | ||||
| scheduledString | string | There are no (further) constraints on this element Data type | ||||
| scheduledTiming | 0..1 | Timing | Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTimingShort description When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities.
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| event | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.eventShort description When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
| ||
| repeat | Σ C | 1..1 | Element | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeatShort description When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| bounds[x] | Σ | 0..0 | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.bounds[x]Short description Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
| |||
| count | Σ | 0..0 | positiveInt | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.countShort description Number of times to repeat DefinitionA total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. Repetitions may be limited by end time or total occurrences. If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
| ||
| countMax | Σ | 0..0 | positiveInt | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.countMaxShort description Maximum number of times to repeat DefinitionIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.
| ||
| duration | Σ | 0..0 | decimal | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.durationShort description How long when it happens DefinitionHow long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
| durationMax | Σ | 0..0 | decimal | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.durationMaxShort description How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
| ||
| durationUnit | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.durationUnitShort description s | min | h | d | wk | mo | a - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units.
| ||
| frequency | Σ | 1..1 | positiveIntFixed Value | Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.frequencyShort description Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
1Mappings
| ||
| frequencyMax | Σ | 0..0 | positiveInt | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.frequencyMaxShort description Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
| ||
| period | Σ | 1..1 | decimalFixed Value | Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.periodShort description Event occurs frequency times per period DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.
1.0Mappings
| ||
| periodMax | Σ | 0..0 | decimal | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.periodMaxShort description Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.
| ||
| periodUnit | Σ | 1..1 | codeBindingFixed Value | Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.periodUnitShort description fixed value 'a' DefinitionThe units of time for the period in UCUM units.
aMappings
| ||
| dayOfWeek | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.dayOfWeekShort description mon | tue | wed | thu | fri | sat | sun DefinitionIf one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
| ||
| timeOfDay | Σ | 0..0 | time | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.timeOfDayShort description Time of day for action DefinitionSpecified time of day for action to take place. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
| ||
| when | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.whenShort description Code for time period of occurrence DefinitionAn approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events.
| ||
| offset | Σ | 0..0 | unsignedInt | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.repeat.offsetShort description Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
| ||
| code | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.scheduled[x]:scheduledTiming.codeShort description BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). TimingAbbreviation (preferred) Constraints
| ||
| location | 0..0 | Reference(Location) | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.locationShort description Where it should happen DefinitionIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Helps in planning of activity. May reference a specific clinical location or may identify a type of location.
| |||
| performer | 0..0 | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.performerShort description Who will be responsible? DefinitionIdentifies who's expected to be involved in the activity. Helps in planning of activity. A performer MAY also be a participant in the care plan. Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Constraints
| |||
| product[x] | 0..0 | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.product[x]Short description What is to be administered/supplied DefinitionIdentifies the food, drug or other product to be consumed or supplied in the activity. A product supplied or administered as part of a care plan activity. SNOMEDCTMedicationCodes (example) Constraints
| ||||
| dailyAmount | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.dailyAmountShort description How to consume/day? Alternate namesdaily dose DefinitionIdentifies the quantity expected to be consumed in a given day. Allows rough dose checking.
| |||
| quantity | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.quantityShort description How much to administer/supply/consume DefinitionIdentifies the quantity expected to be supplied, administered or consumed by the subject.
| |||
| description | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.activity:Vaccination.detail.descriptionShort description Extra info describing activity to perform DefinitionThis provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
| |||
| note | 0..2 | Annotation | There are no (further) constraints on this element Element idCarePlan.noteShort description Comments about the plan DefinitionGeneral notes about the care plan not covered elsewhere. Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.note.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idCarePlan.note.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| noteExtension | C | 1..1 | Extension(CodeableConcept) | Element idCarePlan.note.extension:noteExtensionShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://ihis.sg/extension/health-plan-note-type ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author[x] | Σ | 0..0 | There are no (further) constraints on this element Element idCarePlan.note.author[x]Short description Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |||
| time | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idCarePlan.note.timeShort description When the annotation was made DefinitionIndicates when this particular annotation was made.
| ||
| text | Σ C | 1..1 | markdown | Element idCarePlan.note.textShort description The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format.
| ||
| condition | C | 0..1 | Reference(profile-Healthplan-c1PatientConditionTag) | Element idCarePlan.conditionShort description A reference from one resource to another DefinitionA reference from one resource to another. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(profile-Healthplan-c1PatientConditionTag) Allowed aggregation:contained ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCarePlan.condition.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCarePlan.condition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.condition.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idCarePlan.condition.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idCarePlan.condition.identifierShort description Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idCarePlan.condition.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
| profile-Healthplan-c1PatientConditionTag (Condition) | C | profile-HealthPlan-conditionBase | There are no (further) constraints on this element Element idConditionShort description Detailed information about conditions, problems or diagnoses DefinitionA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. profile-HealthPlan-conditionBase Constraints
| |||
| id | Σ | 1..1 | id | Element idCondition.idShort description Sample Value: "3ce6e90318e74f3f839b825b60638356" DefinitionLogical id of the resource. SOE to generate a guid without hyphen The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..0 | Meta | There are no (further) constraints on this element Element idCondition.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idCondition.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idCondition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). IETF language tag
| |||
| text | 0..0 | Narrative | There are no (further) constraints on this element Element idCondition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |||
| contained | C | 0..0 | Resource | There are no (further) constraints on this element Element idCondition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| ||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCondition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| modifierExtension | ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idCondition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idCondition.identifierShort description External Ids for this condition DefinitionBusiness 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. Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
| ||
| clinicalStatus | Σ ?! C | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCondition.clinicalStatusShort description active | recurrence | relapse | inactive | remission | resolved DefinitionThe clinical status of the condition. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. The clinical status of the condition or diagnosis. ConditionClinicalStatusCodes (required) ConditionsThe cardinality or value of this element may be affected by these constraints: con-3, con-4, con-5 Constraints
| ||
| verificationStatus | Σ ?! C | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCondition.verificationStatusShort description unconfirmed | provisional | differential | confirmed | refuted | entered-in-error DefinitionThe verification status to support the clinical status of the condition. verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status. The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. The verification status to support or decline the clinical status of the condition or diagnosis. ConditionVerificationStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: con-3, con-5 Constraints
| ||
| category | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idCondition.categoryShort description problem-list-item | encounter-diagnosis DefinitionA category assigned to the condition. The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts. A category assigned to the condition. ConditionCategoryCodes (extensible) Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idCondition.category.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCondition.category.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..* | CodingBinding | Element idCondition.category.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. http://ihis.sg/ValueSet/hsg-condition-category (required) Constraints
| ||
| id | 0..1 | id | There are no (further) constraints on this element Element idCondition.category.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idCondition.category.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCondition.category.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-condition-categoryMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCondition.category.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idCondition.category.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCondition.category.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCondition.category.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCondition.category.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| severity | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idCondition.severityShort description Subjective severity of condition DefinitionA subjective assessment of the severity of the condition as evaluated by the clinician. Coding of the severity with a terminology is preferred, where possible. A subjective assessment of the severity of the condition as evaluated by the clinician. Condition/DiagnosisSeverity (preferred) Constraints
| |||
| code | Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idCondition.codeShort description Identification of the condition, problem or diagnosis Alternate namestype DefinitionIdentification of the condition, problem or diagnosis. 0..1 to account for primarily narrative only resources. Identification of the condition or diagnosis. Condition/Problem/DiagnosisCodes (example) Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCondition.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCondition.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..1 | CodingBinding | Element idCondition.code.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. http://ihis.sg/ValueSet/hsg-condition-tag (required) Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idCondition.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idCondition.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idCondition.code.coding.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://ihis.sg/ValueSet/hsg-condition-tagMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idCondition.code.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
| ||
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idCondition.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
| ||
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element idCondition.code.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idCondition.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idCondition.code.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
| bodySite | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idCondition.bodySiteShort description Anatomical location, if relevant DefinitionThe anatomical location where this condition manifests itself. Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. SNOMED CT Body site concepts SNOMEDCTBodyStructures (example) Constraints
| ||
| subject | Σ | 1..1 | Reference(Patient | Group) | Element idCondition.subjectShort description Please do not include in put request, HSAR will auto populate Alternate namespatient DefinitionPlease do not include in put request, HSAR will auto populate Group is typically used for veterinary or public health use cases.
| ||
| encounter | Σ | 0..0 | Reference(Encounter) | There are no (further) constraints on this element Element idCondition.encounterShort description Encounter created as part of DefinitionThe Encounter during which this Condition was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a "new" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first "known".
| ||
| onset[x] | Σ | 0..0 | There are no (further) constraints on this element Element idCondition.onset[x]Short description Estimated or actual date, date-time, or age DefinitionEstimated or actual date or date-time the condition began, in the opinion of the clinician. Age is generally used when the patient reports an age at which the Condition began to occur.
| |||
| abatement[x] | C | 0..0 | There are no (further) constraints on this element Element idCondition.abatement[x]Short description When in resolution/remission DefinitionThe 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. There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated. The cardinality or value of this element may be affected by these constraints: con-4 Constraints
| |||
| recordedDate | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idCondition.recordedDateShort description Date record was first recorded DefinitionThe recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
| ||
| recorder | Σ | 0..0 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | There are no (further) constraints on this element Element idCondition.recorderShort description Who recorded the condition DefinitionIndividual who recorded the record and takes responsibility for its content. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Constraints
| ||
| asserter | Σ | 0..0 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | There are no (further) constraints on this element Element idCondition.asserterShort description Person who asserts this condition DefinitionIndividual who is making the condition statement. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Constraints
| ||
| stage | C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idCondition.stageShort description Stage/grade, usually assessed formally DefinitionClinical stage or grade of a condition. May include formal severity assessments.
| ||
| evidence | C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idCondition.evidenceShort description Supporting evidence DefinitionSupporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition. The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.
| ||
| note | 0..0 | Annotation | There are no (further) constraints on this element Element idCondition.noteShort description Additional information about the Condition DefinitionAdditional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
|
Terminologies
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| CarePlan.status | required | http://hl7.org/fhir/ValueSet/request-status|4.3.0 | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
| CarePlan.intent | required | http://hl7.org/fhir/ValueSet/care-plan-intent|4.3.0 | Codes indicating the degree of authority/intentionality associated with a care plan. |
| CarePlan.category | example | http://hl7.org/fhir/ValueSet/care-plan-category | Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
| CarePlan.category.coding | required | http://ihis.sg/ValueSet/hsg-care-plan-category | |
| CarePlan.subject.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | |
| CarePlan.author.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | |
| CarePlan.activity.outcomeCodeableConcept | example | http://hl7.org/fhir/ValueSet/care-plan-activity-outcome | Identifies the results of the activity. |
| CarePlan.activity.detail.kind | required | http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.3.0 | Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. |
| CarePlan.activity.detail.code | example | http://hl7.org/fhir/ValueSet/procedure-code | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
| CarePlan.activity.detail.reasonCode | example | http://hl7.org/fhir/ValueSet/clinical-findings | Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. |
| CarePlan.activity.detail.status | required | http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.3.0 | Codes that reflect the current state of a care plan activity within its overall life cycle. |
| CarePlan.activity.detail.product[x] | example | http://hl7.org/fhir/ValueSet/medication-codes | A product supplied or administered as part of a care plan activity. |
| CarePlan.activity.detail.kind | required | http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.3.0 | Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. |
| CarePlan.activity.detail.code | required | http://ihis.sg/ValueSet/hsg-healthplan-activity-type | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
| CarePlan.activity.detail.status | required | http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.3.0 | Codes that reflect the current state of a care plan activity within its overall life cycle. |
| CarePlan.activity.detail.scheduled[x].repeat.durationUnit | required | http://hl7.org/fhir/ValueSet/units-of-time|4.3.0 | |
| CarePlan.activity.detail.scheduled[x].repeat.periodUnit | required | http://hl7.org/fhir/ValueSet/units-of-time|4.3.0 | |
| CarePlan.activity.detail.scheduled[x].repeat.dayOfWeek | required | http://hl7.org/fhir/ValueSet/days-of-week|4.3.0 | |
| CarePlan.activity.detail.scheduled[x].repeat.when | required | http://hl7.org/fhir/ValueSet/event-timing|4.3.0 | |
| CarePlan.activity.outcomeCodeableConcept | example | http://hl7.org/fhir/ValueSet/care-plan-activity-outcome | Identifies the results of the activity. |
| CarePlan.activity.outcomeCodeableConcept.coding | required | http://ihis.sg/ValueSet/hsg-action-plan-category | |
| CarePlan.activity.detail.kind | required | http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.3.0 | Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. |
| CarePlan.activity.detail.code | required | http://ihis.sg/ValueSet/hsg-action-plan-diet-item | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
| CarePlan.activity.detail.status | required | http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.3.0 | Codes that reflect the current state of a care plan activity within its overall life cycle. |
| CarePlan.activity.outcomeCodeableConcept | example | http://hl7.org/fhir/ValueSet/care-plan-activity-outcome | Identifies the results of the activity. |
| CarePlan.activity.outcomeCodeableConcept.coding | required | http://ihis.sg/ValueSet/hsg-action-plan-category | |
| CarePlan.activity.detail.kind | required | http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.3.0 | Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. |
| CarePlan.activity.detail.code | required | http://ihis.sg/ValueSet/hsg-action-plan-vaccination-item | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
| CarePlan.activity.detail.status | required | http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.3.0 | Codes that reflect the current state of a care plan activity within its overall life cycle. |
| CarePlan.activity.detail.scheduled[x].repeat.periodUnit | required | http://hl7.org/fhir/ValueSet/units-of-time|4.3.0 |