minimal Common Oncology Data Elements (mCODE) Implementation Guide
2.0.0 - STU 2

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Data Type Profile: Body Structure Identifier Data Type Profile

Defining URL:http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-structure-identifier
Version:2.0.0
Name:BodyStructureIdentifier
Title:Body Structure Identifier Data Type Profile
Status:Active as of 1/18/22 3:17 AM
Definition:

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

Publisher:HL7 International Clinical Interoperability Council
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-structure-identifier

Formal Views of Profile Content

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

This structure is derived from Identifier

Summary

Mandatory: 1 element

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierAn identifier intended for computation
... use 0..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
... type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: BodyStructure
... value 1..1stringThe value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierAn identifier intended for computation
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: BodyStructure
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringThe value that is unique
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

This structure is derived from Identifier

Summary

Mandatory: 1 element

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierAn identifier intended for computation
... use 0..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
... type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: BodyStructure
... value 1..1stringThe value that is unique

doco Documentation for this format

Snapshot View

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


Required Pattern: usual
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/resource-types
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: BodyStructure
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
... value Σ1..1stringThe value that is unique
Example General: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredPattern: usual
Identifier.typeextensiblePattern: BodyStructure