Data Model Libraries
    Preparing search index...

    Class CarePlanActivityDetailComponent

    CarePlanActivityDetailComponent Class

    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 CarePlan

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    resourceTypesEnum kind? instantiatesCanonical? instantiatesUri? code? reasonCode? reasonReference? goal? carePlanActivityStatusEnum status statusReason? doNotPerform? scheduled? location? performer? product? dailyAmount? quantity? description?

    Methods

    parse getKindEnumType setKindEnumType hasKindEnumType getKindElement setKindElement hasKindElement getKind setKind hasKind getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getCode setCode hasCode getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getGoal setGoal addGoal hasGoal getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason hasStatusReason getDoNotPerformElement setDoNotPerformElement hasDoNotPerformElement getDoNotPerform setDoNotPerform hasDoNotPerform getScheduled setScheduled hasScheduled getScheduledTiming hasScheduledTiming getScheduledPeriod hasScheduledPeriod getScheduledStringType hasScheduledStringType getLocation setLocation hasLocation getPerformer setPerformer addPerformer hasPerformer getProduct setProduct hasProduct getProductCodeableConcept hasProductCodeableConcept getProductReference hasProductReference getDailyAmount setDailyAmount hasDailyAmount getQuantity setQuantity hasQuantity getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initInstantiatesCanonical initInstantiatesUri initReasonCode initReasonReference initGoal initPerformer

    Constructors

    Properties

    resourceTypesEnum: ResourceTypesEnum

    FHIR CodeSystem: ResourceTypes

    ResourceTypesEnum

    kind?: EnumCodeType

    CarePlan.activity.detail.kind Element

    FHIR Specification

    • Short: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
    • Definition: A 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.
    • Requirements: May determine what types of extensions are permitted.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ResourceTypesEnum

    instantiatesCanonical?: CanonicalType[]

    CarePlan.activity.detail.instantiatesCanonical Element

    FHIR Specification

    instantiatesUri?: UriType[]

    CarePlan.activity.detail.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
    • Comment: This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
    • Requirements: Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    code?: CodeableConcept

    CarePlan.activity.detail.code Element

    FHIR Specification

    • Short: Detail type of activity
    • Definition: Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.
    • Comment: Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.
    • Requirements: Allows matching performed to planned as well as validation against protocols.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reasonCode?: CodeableConcept[]

    CarePlan.activity.detail.reasonCode Element

    FHIR Specification

    • Short: Why activity should be done or why activity was prohibited
    • Definition: Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
    • Comment: This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    CarePlan.activity.detail.reasonReference Element

    FHIR Specification

    goal?: Reference[]

    CarePlan.activity.detail.goal Element

    FHIR Specification

    • Short: Goals this activity relates to
    • Definition: Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
    • Requirements: So that participants know the link explicitly.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    carePlanActivityStatusEnum: CarePlanActivityStatusEnum

    FHIR CodeSystem: CarePlanActivityStatus

    CarePlanActivityStatusEnum

    status: null | EnumCodeType

    CarePlan.activity.detail.status Element

    FHIR Specification

    • Short: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
    • Definition: Identifies what progress is being made for the specific activity.
    • Comment: 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. 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 activity.
    • Requirements: Indicates progress against the plan, whether the activity is still relevant for the plan.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid
    • isSummary: false

    CodeSystem Enumeration: CarePlanActivityStatusEnum

    statusReason?: CodeableConcept

    CarePlan.activity.detail.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.
    • Comment: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    doNotPerform?: BooleanType

    CarePlan.activity.detail.doNotPerform Element

    FHIR Specification

    • Short: If true, activity is prohibiting action
    • Definition: If 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.
    • Comment: This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.
    • Requirements: Captures intention to not do something that may have been previously typical.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur.
    • isSummary: false
    scheduled?: IDataType

    CarePlan.activity.detail.scheduled[x] Element

    @ChoiceDataTypesMeta('CarePlan.activity.detail.scheduled[x]', ['Timing','Period','string',]

    FHIR Specification

    • Short: When activity is to occur
    • Definition: The period, timing or frequency upon which the described activity is to occur.
    • Requirements: Allows prompting for activities and detection of missed planned activities.
    • FHIR Types: 'Timing', 'Period', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    location?: Reference

    CarePlan.activity.detail.location Element

    FHIR Specification

    • Short: Where it should happen
    • Definition: Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
    • Comment: May reference a specific clinical location or may identify a type of location.
    • Requirements: Helps in planning of activity.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    performer?: Reference[]

    CarePlan.activity.detail.performer Element

    FHIR Specification

    product?: IDataType

    CarePlan.activity.detail.product[x] Element

    @ChoiceDataTypesMeta('CarePlan.activity.detail.product[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: What is to be administered/supplied
    • Definition: Identifies the food, drug or other product to be consumed or supplied in the activity.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dailyAmount?: Quantity

    CarePlan.activity.detail.dailyAmount Element

    FHIR Specification

    • Short: How to consume/day?
    • Definition: Identifies the quantity expected to be consumed in a given day.
    • Requirements: Allows rough dose checking.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    CarePlan.activity.detail.quantity Element

    FHIR Specification

    • Short: How much to administer/supply/consume
    • Definition: Identifies the quantity expected to be supplied, administered or consumed by the subject.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: StringType

    CarePlan.activity.detail.description Element

    FHIR Specification

    • Short: Extra info describing activity to perform
    • Definition: This 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CarePlanActivityDetailComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CarePlanActivityDetailComponent

      CarePlanActivityDetailComponent data model or undefined for CarePlanActivityDetailComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the reasonReference property.

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('CarePlan.activity.detail.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the reasonReference array property.

      Parameters

      • value: undefined | Reference

        the reasonReference value

      Returns this

      this

      @ReferenceTargets('CarePlan.activity.detail.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the performer property.

      Parameters

      • value: undefined | Reference[]

        the performer array value

      Returns this

      this

      @ReferenceTargets('CarePlan.activity.detail.performer', ['Practitioner','PractitionerRole','Organization','RelatedPerson','Patient','CareTeam','HealthcareService','Device',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the performer array property.

      Parameters

      • value: undefined | Reference

        the performer value

      Returns this

      this

      @ReferenceTargets('CarePlan.activity.detail.performer', ['Practitioner','PractitionerRole','Organization','RelatedPerson','Patient','CareTeam','HealthcareService','Device',])

      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 the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetKindEnumTypesetKindEnumTypehasKindEnumTypegetKindElementsetKindElementhasKindElementgetKindsetKindhasKindgetInstantiatesCanonicalElementsetInstantiatesCanonicalElementaddInstantiatesCanonicalElementhasInstantiatesCanonicalElementgetInstantiatesCanonicalsetInstantiatesCanonicaladdInstantiatesCanonicalhasInstantiatesCanonicalgetInstantiatesUriElementsetInstantiatesUriElementaddInstantiatesUriElementhasInstantiatesUriElementgetInstantiatesUrisetInstantiatesUriaddInstantiatesUrihasInstantiatesUrigetCodesetCodehasCodegetReasonCodesetReasonCodeaddReasonCodehasReasonCodegetReasonReferencesetReasonReferenceaddReasonReferencehasReasonReferencegetGoalsetGoaladdGoalhasGoalgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetStatusReasonsetStatusReasonhasStatusReasongetDoNotPerformElementsetDoNotPerformElementhasDoNotPerformElementgetDoNotPerformsetDoNotPerformhasDoNotPerformgetScheduledsetScheduledhasScheduledgetScheduledTiminghasScheduledTiminggetScheduledPeriodhasScheduledPeriodgetScheduledStringTypehasScheduledStringTypegetLocationsetLocationhasLocationgetPerformersetPerformeraddPerformerhasPerformergetProductsetProducthasProductgetProductCodeableConcepthasProductCodeableConceptgetProductReferencehasProductReferencegetDailyAmountsetDailyAmounthasDailyAmountgetQuantitysetQuantityhasQuantitygetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitInstantiatesCanonicalinitInstantiatesUriinitReasonCodeinitReasonReferenceinitGoalinitPerformer