Data Model Libraries
    Preparing search index...

    Class CarePlanActivityComponent

    CarePlanActivityComponent Class

    FHIR Specification

    • Short: Action to occur as part of plan
    • Definition: Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
    • Requirements: Allows systems to prompt for performance of planned activities, and validate plans against best practice.

    FHIR CarePlan

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    outcomeCodeableConcept? outcomeReference? progress? reference? detail?

    Methods

    parse getOutcomeCodeableConcept setOutcomeCodeableConcept addOutcomeCodeableConcept hasOutcomeCodeableConcept getOutcomeReference setOutcomeReference addOutcomeReference hasOutcomeReference getProgress setProgress addProgress hasProgress getReference setReference hasReference getDetail setDetail hasDetail fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initOutcomeCodeableConcept initOutcomeReference initProgress

    Constructors

    Properties

    outcomeCodeableConcept?: CodeableConcept[]

    CarePlan.activity.outcomeCodeableConcept Element

    FHIR Specification

    • Short: Results of the activity
    • Definition: Identifies 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).
    • Comment: Note that this should not duplicate the activity status (e.g. completed or in progress).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    outcomeReference?: Reference[]

    CarePlan.activity.outcomeReference Element

    FHIR Specification

    • Short: Appointment, Encounter, Procedure, etc.
    • Definition: Details 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).
    • Comment: 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.
    • Requirements: Links plan to resulting actions.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    progress?: Annotation[]

    CarePlan.activity.progress Element

    FHIR Specification

    • Short: Comments about the activity status/progress
    • Definition: Notes about the adherence/status/progress of the activity.
    • Comment: 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.
    • Requirements: Can be used to capture information about adherence, progress, concerns, etc.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reference?: Reference

    CarePlan.activity.reference Element

    FHIR Specification

    detail?: CarePlanActivityDetailComponent

    CarePlan.activity.detail Element

    FHIR Specification

    • Short: In-line definition of activity
    • Definition: A 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.
    • Requirements: Details in a simple form for generic care plan systems.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided CarePlanActivityComponent JSON to instantiate the CarePlanActivityComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR CarePlanActivityComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CarePlanActivityComponent

      Returns undefined | CarePlanActivityComponent

      CarePlanActivityComponent data model or undefined for CarePlanActivityComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference object value to the reference property.

      Parameters

      • value: undefined | Reference

        the reference object value

      Returns this

      this

      @ReferenceTargets('CarePlan.activity.reference', ['Appointment','CommunicationRequest','DeviceRequest','MedicationRequest','NutritionOrder','Task','ServiceRequest','VisionPrescription','RequestGroup',])

      InvalidTypeError for invalid data type or reference value

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods