minimal Common Oncology Data Elements (mCODE) Implementation Guide
4.0.0-ballot - STU4 Ballot United States of America flag

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v4.0.0-ballot: STU4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Data Type Profile: Body Structure Identifier Profile

Official URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-structure-identifier Version: 4.0.0-ballot
Active as of 2024-04-10 Maturity Level: 3 Computable Name: BodyStructureIdentifier
Other Identifiers: OID:2.16.840.1.113883.4.642.40.15.42.3

An identifier that designates a body structure such as a tumor and can be used for tracking the structure over time.

Usage:

Changes since version true:

  • No changes

    • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier An identifier intended for computation
    ... use 0..1 code usual | official | temp | secondary | old (If known)
    Required Pattern: usual
    ... type 0..1 CodeableConcept Description of identifier
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://hl7.org/fhir/resource-types
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: BodyStructure
    ... value 1..1 string The value that is unique

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier An identifier intended for computation
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


    Required Pattern: usual
    ... type Σ 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://hl7.org/fhir/resource-types
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: BodyStructure
    ... value Σ 1..1 string The value that is unique
    Example General: 123456

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredPattern: usual
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: BodyStructure
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier An identifier intended for computation
    ... id 0..1 string Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


    Required Pattern: usual
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://hl7.org/fhir/resource-types
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: BodyStructure
    ..... display 0..1 string Representation defined by the system
    ..... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... text 0..1 string Plain text representation of the concept
    ... system Σ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ... value Σ 1..1 string The value that is unique
    Example General: 123456
    ... period Σ 0..1 Period Time period when id is/was valid for use
    ... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredPattern: usual
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: BodyStructure
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard

    This structure is derived from Identifier

    Summary

    Mandatory: 1 element

    Maturity: 3

    Differential View

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier An identifier intended for computation
    ... use 0..1 code usual | official | temp | secondary | old (If known)
    Required Pattern: usual
    ... type 0..1 CodeableConcept Description of identifier
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://hl7.org/fhir/resource-types
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: BodyStructure
    ... value 1..1 string The value that is unique

    doco Documentation for this format

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier An identifier intended for computation
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


    Required Pattern: usual
    ... type Σ 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://hl7.org/fhir/resource-types
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: BodyStructure
    ... value Σ 1..1 string The value that is unique
    Example General: 123456

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredPattern: usual
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: BodyStructure
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Identifier 0..* Identifier An identifier intended for computation
    ... id 0..1 string Unique id for inter-element referencing
    ... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


    Required Pattern: usual
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://hl7.org/fhir/resource-types
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: BodyStructure
    ..... display 0..1 string Representation defined by the system
    ..... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... text 0..1 string Plain text representation of the concept
    ... system Σ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ... value Σ 1..1 string The value that is unique
    Example General: 123456
    ... period Σ 0..1 Period Time period when id is/was valid for use
    ... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Identifier.userequiredPattern: usual
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Identifier.typeextensiblePattern: BodyStructure
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard

    This structure is derived from Identifier

    Summary

    Mandatory: 1 element

    Maturity: 3

     

    Other representations of profile: CSV, Excel, Schematron