Data Model Libraries
    Preparing search index...

    Class PlanDefinitionActorOptionComponent

    PlanDefinitionActorOptionComponent Class

    FHIR Specification

    • Short: Who or what can be this actor
    • Definition: The characteristics of the candidates that could serve as the actor.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    actionParticipantTypeEnum: ActionParticipantTypeEnum

    FHIR CodeSystem: ActionParticipantType

    type_?: EnumCodeType

    PlanDefinition.actor.option.type Element

    FHIR Specification

    • Short: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
    • Definition: The type of participant in the action.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionParticipantTypeEnum

    typeCanonical?: CanonicalType

    PlanDefinition.actor.option.typeCanonical Element

    FHIR Specification

    typeReference?: Reference

    PlanDefinition.actor.option.typeReference Element

    FHIR Specification

    PlanDefinition.actor.option.role Element

    FHIR Specification

    • Short: E.g. Nurse, Surgeon, Parent
    • Definition: The role the participant should play in performing the described action.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PlanDefinitionActorOptionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PlanDefinitionActorOptionComponent

      PlanDefinitionActorOptionComponent data model or undefined for PlanDefinitionActorOptionComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided TypeReference object value to the typeReference property.

      Parameters

      • value: undefined | Reference

        the typeReference object value

      Returns this

      this

      @ReferenceTargets('PlanDefinition.actor.option.typeReference', ['CareTeam','Device','DeviceDefinition','Endpoint','Group','HealthcareService','Location','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson',])

      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