Data Model Libraries
    Preparing search index...

    Class BodyStructure

    BodyStructure Class

    Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

    FHIR Specification

    • Short: Specific and identified anatomical structure
    • Definition: Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
    • FHIR Version: 5.0.0

    FHIR BodyStructure

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? morphology? includedStructure excludedStructure? description? image? patient

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getMorphology setMorphology hasMorphology getIncludedStructure setIncludedStructure addIncludedStructure hasIncludedStructure getExcludedStructure setExcludedStructure addExcludedStructure hasExcludedStructure getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getImage setImage addImage hasImage getPatient setPatient hasPatient fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initIncludedStructure initExcludedStructure initImage

    Constructors

    Properties

    identifier?: Identifier[]

    BodyStructure.identifier Element

    FHIR Specification

    • Short: Bodystructure identifier
    • Definition: Identifier for this instance of the anatomical structure.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    BodyStructure.active Element

    FHIR Specification

    • Short: Whether this record is in active use
    • Definition: Whether this body site is in active use.
    • Comment: This element is labeled as a modifier because it may be used to mark that the resource was created in error.
    • Requirements: Need to be able to mark a body site entry as not to be used because it was created in error.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    • isSummary: true
    morphology?: CodeableConcept

    BodyStructure.morphology Element

    FHIR Specification

    • Short: Kind of Structure
    • Definition: The kind of structure being represented by the body structure at BodyStructure.location. This can define both normal and abnormal morphologies.
    • Comment: The minimum cardinality of 0 supports the use case of specifying a location without defining a morphology.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    includedStructure: null | BodyStructureIncludedStructureComponent[]

    BodyStructure.includedStructure Element

    FHIR Specification

    • Short: Included anatomic location(s)
    • Definition: The anatomical location(s) or region(s) of the specimen, lesion, or body structure.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false
    excludedStructure?: BodyStructureIncludedStructureComponent[]

    BodyStructure.excludedStructure Element

    FHIR Specification

    • Short: Excluded anatomic locations(s)
    • Definition: The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    BodyStructure.description Element

    FHIR Specification

    • Short: Text description
    • Definition: A summary, characterization or explanation of the body structure.
    • Comment: This description could include any visual markings used to orientate the viewer e.g. external reference points, special sutures, ink markings.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    image?: Attachment[]

    BodyStructure.image Element

    FHIR Specification

    • Short: Attached images
    • Definition: Image or images used to identify a location.
    • FHIR Type: Attachment
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    patient: null | Reference

    BodyStructure.patient Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR BodyStructure

      • OptionaloptSourceField: string

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

      Returns undefined | BodyStructure

      BodyStructure data model or undefined for BodyStructure

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetMorphologysetMorphologyhasMorphologygetIncludedStructuresetIncludedStructureaddIncludedStructurehasIncludedStructuregetExcludedStructuresetExcludedStructureaddExcludedStructurehasExcludedStructuregetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetImagesetImageaddImagehasImagegetPatientsetPatienthasPatientfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitIncludedStructureinitExcludedStructureinitImage