HL7.FHIR.US.BREAST-RADIOLOGY\Breast Imaging Document

Breast Imaging Reporting - 2nd STU ballot
0.3.0 - CI Build United States of America flag

Breast Imaging Reporting - 2nd STU ballot, published by HL7 International - Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 0.3.0). This version is based on the current content of https://github.com/HL7/fhir-breast-radiology-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Breast Imaging Document

Official URL: http://hl7.org/fhir/us/breast-radiology/StructureDefinition/BreastImagingDocument				Version: 0.3.0
Draft as of 2019-11-01				Computable Name: BreastImagingDocument

Breast Imaging Document Bundle.

Description

A Breast Imaging Document is an implementation of a FHIR Document.

A FHIR Document is a Bundle that provides a single item containing all the resource instances that are a part of the Breast Imaging Diagnostic Report.

The Breast Imaging Document is an atomic item, meaning that no part in it can be changed without changing the entire bundle, and that all the parts are contained in a single bundle

The first entry in the bundle is a composition instance that provides an index to all the other FHIR resource instances that are part of this document. This index composition entry must be an instance of the BreastImagingComposition profile.

Graphical Overview

This graph provides an overview of this profile, and its dependencies.

Click on any of the elements of the graph to go to a section describing that element.

Usage:

This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Bundle

Name	Card.	Type	Description & Constraints
Bundle	0..*	Bundle	Contains a collection of resources
Slices for entry	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by value:fullUrl
entry:index	1..1	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID) Required Pattern: index
resource	1..1	BreastImagingComposition	US Core Race Extension
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	Σ	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Slices for entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by value:fullUrl This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry:index	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID) Required Pattern: index
resource		1..1	BreastImagingComposition	US Core Race Extension
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Bundle.type	required	BundleType

Description & Constraints

Bundle

C

0..*

Bundle

Contains a collection of resources

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

?!Σ

0..1

uri

A set of rules under which this content was created

language

0..1

code

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

identifier

Σ

0..1

Identifier

Persistent identifier for the bundle

type

Σ

1..1

code

timestamp

Σ

0..1

instant

When the bundle was assembled

total

ΣC

0..1

unsignedInt

If search, the total number of matches

link

Σ

0..*

BackboneElement

Links related to this Bundle

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

relation

Σ

1..1

string

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

url

Σ

1..1

uri

Reference details for the link

Slices for entry

ΣC

1..*

BackboneElement

Entry in the bundle - will have a resource or information
Slice: Unordered, Open by value:fullUrl
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type

entry:All Slices

Content/Rules for all slices

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

link

Σ

0..*

See link (Bundle)

Links related to this entry

fullUrl

Σ

0..1

uri

URI for resource (Absolute URL server address or URI for UUID/OID)

resource

Σ

0..1

Resource

A resource in the bundle

search

ΣC

0..1

BackboneElement

Search related information

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

mode

Σ

0..1

code

match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

score

Σ

0..1

decimal

Search ranking (between 0 and 1)

request

ΣC

0..1

BackboneElement

Additional execution information (transaction/batch/history)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

method

Σ

1..1

code

url

Σ

1..1

uri

URL for HTTP equivalent of this entry

ifNoneMatch

Σ

0..1

string

For managing cache currency

ifModifiedSince

Σ

0..1

instant

For managing cache currency

ifMatch

Σ

0..1

string

For managing update contention

ifNoneExist

Σ

0..1

string

For conditional creates

response

ΣC

0..1

BackboneElement

Results of execution (transaction/batch/history)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

status

Σ

1..1

string

Status response code (text optional)

location

Σ

0..1

uri

The location (if the operation returns a location)

etag

Σ

0..1

string

The Etag for the resource (if relevant)

lastModified

Σ

0..1

instant

Server's date time modified

outcome

Σ

0..1

Resource

OperationOutcome with hints and warnings (for batch/transaction)

entry:index

ΣC

1..1

BackboneElement

Entry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

link

Σ

0..*

See link (Bundle)

Links related to this entry

fullUrl

Σ

1..1

uri

URI for resource (Absolute URL server address or URI for UUID/OID)
Required Pattern: index

resource

1..1

BreastImagingComposition

US Core Race Extension

search

ΣC

0..1

BackboneElement

Search related information

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

mode

Σ

0..1

code

match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

score

Σ

0..1

decimal

Search ranking (between 0 and 1)

request

ΣC

0..1

BackboneElement

Additional execution information (transaction/batch/history)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

method

Σ

1..1

code

url

Σ

1..1

uri

URL for HTTP equivalent of this entry

ifNoneMatch

Σ

0..1

string

For managing cache currency

ifModifiedSince

Σ

0..1

instant

For managing cache currency

ifMatch

Σ

0..1

string

For managing update contention

ifNoneExist

Σ

0..1

string

For conditional creates

response

ΣC

0..1

BackboneElement

Results of execution (transaction/batch/history)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

status

Σ

1..1

string

Status response code (text optional)

location

Σ

0..1

uri

The location (if the operation returns a location)

etag

Σ

0..1

string

The Etag for the resource (if relevant)

lastModified

Σ

0..1

instant

Server's date time modified

outcome

Σ

0..1

Resource

OperationOutcome with hints and warnings (for batch/transaction)

signature

ΣTU

0..1

Signature

Digital Signature

Documentation for this format

Terminology Bindings

Path

Conformance

ValueSet

Bundle.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Bundle.type

required

BundleType

Bundle.entry.search.mode

required

SearchEntryMode

Bundle.entry.request.method

required

HTTPVerb

Bundle.entry:index.search.mode

required

SearchEntryMode

Bundle.entry:index.request.method

required

HTTPVerb

This structure is derived from Bundle

Summary

Mandatory: 4 elements

Structures

This structure refers to these other structures:

Breast Imaging Composition (http://hl7.org/fhir/us/breast-radiology/StructureDefinition/BreastImagingComposition)

Slices

This structure defines the following Slices:

The element Bundle.entry is sliced based on the value of value:fullUrl

Differential View

This structure is derived from Bundle

Name	Card.	Type	Description & Constraints
Bundle	0..*	Bundle	Contains a collection of resources
Slices for entry	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by value:fullUrl
entry:index	1..1	BackboneElement	Entry in the bundle - will have a resource or information
fullUrl	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID) Required Pattern: index
resource	1..1	BreastImagingComposition	US Core Race Extension
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
type	Σ	1..1	code	document \| message \| transaction \| transaction-response \| batch \| batch-response \| history \| searchset \| collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Slices for entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Open by value:fullUrl This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
entry:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entry:index	ΣC	1..1	BackboneElement	Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
fullUrl	Σ	1..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID) Required Pattern: index
resource		1..1	BreastImagingComposition	US Core Race Extension
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Bundle.type	required	BundleType

Snapshot View

Description & Constraints

Bundle

C

0..*

Bundle

Contains a collection of resources

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

?!Σ

0..1

uri

A set of rules under which this content was created

language

0..1

code

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

identifier

Σ

0..1

Identifier

Persistent identifier for the bundle

type

Σ

1..1

code

timestamp

Σ

0..1

instant

When the bundle was assembled

total

ΣC

0..1

unsignedInt

If search, the total number of matches

link

Σ

0..*

BackboneElement

Links related to this Bundle

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

relation

Σ

1..1

string

See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1

url

Σ

1..1

uri

Reference details for the link

Slices for entry

ΣC

1..*

BackboneElement

Entry in the bundle - will have a resource or information
Slice: Unordered, Open by value:fullUrl
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type

entry:All Slices

Content/Rules for all slices

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

link

Σ

0..*

See link (Bundle)

Links related to this entry

fullUrl

Σ

0..1

uri

URI for resource (Absolute URL server address or URI for UUID/OID)

resource

Σ

0..1

Resource

A resource in the bundle

search

ΣC

0..1

BackboneElement

Search related information

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

mode

Σ

0..1

code

match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

score

Σ

0..1

decimal

Search ranking (between 0 and 1)

request

ΣC

0..1

BackboneElement

Additional execution information (transaction/batch/history)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

method

Σ

1..1

code

url

Σ

1..1

uri

URL for HTTP equivalent of this entry

ifNoneMatch

Σ

0..1

string

For managing cache currency

ifModifiedSince

Σ

0..1

instant

For managing cache currency

ifMatch

Σ

0..1

string

For managing update contention

ifNoneExist

Σ

0..1

string

For conditional creates

response

ΣC

0..1

BackboneElement

Results of execution (transaction/batch/history)

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

status

Σ

1..1

string

Status response code (text optional)

location

Σ

0..1

uri

The location (if the operation returns a location)

etag

Σ

0..1

string

The Etag for the resource (if relevant)

lastModified

Σ

0..1

instant

Server's date time modified

outcome

Σ

0..1

Resource

OperationOutcome with hints and warnings (for batch/transaction)

entry:index

ΣC

1..1

BackboneElement

Entry in the bundle - will have a resource or information
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

link

Σ

0..*

See link (Bundle)

Links related to this entry

fullUrl

Σ

1..1

uri

URI for resource (Absolute URL server address or URI for UUID/OID)
Required Pattern: index

resource

1..1

BreastImagingComposition

US Core Race Extension

search

ΣC

0..1

BackboneElement

Search related information

id

0..1

string

Unique id for inter-element referencing

extension

0..*

Extension

Additional content defined by implementations

modifierExtension

?!Σ

0..*

Extension

Extensions that cannot be ignored even if unrecognized

mode

Σ

0..1

code

match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

score

Σ

0..1

decimal

Search ranking (between 0 and 1)

request

ΣC

0..1

BackboneElement

Additional execution information (transaction/batch/history)

id

0..1