HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) R3. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

BreastLymphNodeBodySiteProfile

 

The official URL for this profile is: 

http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-BreastLymphNodeBodySite

A body site specific to the lymph node structure.

This profile builds on BodySite.

This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).

View the corresponding BreastLymphNodeBodySiteModel logical model.

Summary

Mandatory: 0 element (1 nested mandatory element)

Slices

This structure defines the following Slices:

  • The element BodySite.qualifier is sliced based on the value of value:coding.code

BC Mapping Source

This structure represents the following BC mapping definition:

oncology.BreastLymphNodeBodySite maps to BodySite:
  CodeableConcept maps to code
  Laterality maps to qualifier (slice on = coding.code)
  AnatomicalDirection maps to qualifier
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite BC BreastLymphNodeBodySite Profile
... code 1..1Binding: BC BreastLymphNodeGroupVS ValueSet (preferred)
... qualifier Slice: Unordered, Open by value:coding.code
... qualifier 0..1Laterality
Binding: Laterality (required)
... qualifier 0..1AnatomicalDirection
Binding: BC AnatomicalDirectionVS ValueSet (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite I0..*BC BreastLymphNodeBodySite Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodysite identifier
... active ?!Σ0..1booleanWhether this body site record is in active use
... code Σ1..1CodeableConceptNamed anatomical location
Binding: BC BreastLymphNodeGroupVS ValueSet (preferred)
... qualifier CodeableConceptModification to location code
Slice: Unordered, Open by value:coding.code
Binding: Bodysite Location Qualifier (example)
... qualifier 0..1CodeableConceptLaterality
Binding: Laterality (required)
... qualifier 0..1CodeableConceptAnatomicalDirection
Binding: BC AnatomicalDirectionVS ValueSet (required)
... description Σ0..1stringAnatomical location description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Slices

This structure defines the following Slices:

  • The element BodySite.qualifier is sliced based on the value of value:coding.code

BC Mapping Source

This structure represents the following BC mapping definition:

oncology.BreastLymphNodeBodySite maps to BodySite:
  CodeableConcept maps to code
  Laterality maps to qualifier (slice on = coding.code)
  AnatomicalDirection maps to qualifier

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite BC BreastLymphNodeBodySite Profile
... code 1..1Binding: BC BreastLymphNodeGroupVS ValueSet (preferred)
... qualifier Slice: Unordered, Open by value:coding.code
... qualifier 0..1Laterality
Binding: Laterality (required)
... qualifier 0..1AnatomicalDirection
Binding: BC AnatomicalDirectionVS ValueSet (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodySite I0..*BC BreastLymphNodeBodySite Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBodysite identifier
... active ?!Σ0..1booleanWhether this body site record is in active use
... code Σ1..1CodeableConceptNamed anatomical location
Binding: BC BreastLymphNodeGroupVS ValueSet (preferred)
... qualifier CodeableConceptModification to location code
Slice: Unordered, Open by value:coding.code
Binding: Bodysite Location Qualifier (example)
... qualifier 0..1CodeableConceptLaterality
Binding: Laterality (required)
... qualifier 0..1CodeableConceptAnatomicalDirection
Binding: BC AnatomicalDirectionVS ValueSet (required)
... description Σ0..1stringAnatomical location description
... image 0..*AttachmentAttached images
... patient Σ1..1Reference(Patient)Who this is about

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
BodySite.languageCommon LanguagesextensibleCommon Languages
BodySite.codeBC BreastLymphNodeGroupVS ValueSetpreferredBreastLymphNodeGroupVS
BodySite.qualifierBC AnatomicalDirectionVS ValueSetrequiredAnatomicalDirectionVS
BodySite.qualifierBC AnatomicalDirectionVS ValueSetrequiredAnatomicalDirectionVS
BodySite.qualifierBC AnatomicalDirectionVS ValueSetrequiredAnatomicalDirectionVS

 

Constraints

IdPathDetailsRequirements
dom-2BodySiteIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BodySiteIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BodySiteIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3BodySiteIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()