CodeX Radiation Therapy, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/codex-radiation-therapy/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Radiotherapy Seed Device

A device that represents implanted seeds for brachytherapy. The device is specified by the type of radioactive seed (at a minimum).

Usage:

• Refer to this Resource Profile: Radiotherapy Course Prescription, Radiotherapy Course Summary, Radiotherapy Phase Prescription, Radiotherapy Plan Prescription... Show 6 more, Radiotherapy Planned Course, Radiotherapy Planned Phase, Radiotherapy Treated Fraction, Radiotherapy Treated Phase, Radiotherapy Treated Plan and Radiotherapy Treatment Plan
• Examples for this Resource Profile: Device/RadiotherapySeedDevice-Mesh

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from USCoreImplantableDeviceProfile

Name	Flags	Card.	Type	Description & Constraints
Device			USCoreImplantableDeviceProfile
type		1..1	CodeableConcept	(USCDI) The kind or type of device Binding: Brachytherapy Device Type Value Set (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Device.type	required	BrachytherapyDeviceTypeVS http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-brachytherapy-device-type-vs from this IG

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	USCoreImplantableDeviceProfile	Item used in healthcare dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
udiCarrier	SΣ	0..1	BackboneElement	(USCDI) Unique Device Identifier (UDI) Barcode string ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deviceIdentifier	SΣ	1..1	string	(USCDI) Mandatory fixed portion of UDI ele-1: All FHIR elements must have a @value or children
carrierHRF	SΣ	0..1	string	(USCDI) UDI Human Readable Barcode String ele-1: All FHIR elements must have a @value or children
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children
distinctIdentifier	S	0..1	string	(USCDI) The distinct identification string ele-1: All FHIR elements must have a @value or children
manufactureDate	S	0..1	dateTime	(USCDI) Date when the device was made ele-1: All FHIR elements must have a @value or children
expirationDate	S	0..1	dateTime	(USCDI) Date and time of expiry of this device (if applicable) ele-1: All FHIR elements must have a @value or children
lotNumber	S	0..1	string	(USCDI) Lot number of manufacture ele-1: All FHIR elements must have a @value or children
serialNumber	S	0..1	string	(USCDI) Serial number assigned by the manufacturer ele-1: All FHIR elements must have a @value or children
type	S	1..1	CodeableConcept	(USCDI) The kind or type of device Binding: Brachytherapy Device Type Value Set (required) ele-1: All FHIR elements must have a @value or children
patient	S	1..1	Reference(US Core Patient Profile)	(USCDI) Patient to whom Device is affixed ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.type	required	BrachytherapyDeviceTypeVS http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-brachytherapy-device-type-vs from this IG

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	USCoreImplantableDeviceProfile	Item used in healthcare
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	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
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Instance identifier
definition		0..1	Reference(DeviceDefinition)	The reference to the definition for the device
udiCarrier	SΣ	0..1	BackboneElement	(USCDI) Unique Device Identifier (UDI) Barcode string
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
deviceIdentifier	SΣ	1..1	string	(USCDI) Mandatory fixed portion of UDI
issuer		0..1	uri	UDI Issuing Organization
jurisdiction		0..1	uri	Regional UDI authority
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
carrierHRF	SΣ	0..1	string	(USCDI) UDI Human Readable Barcode String
entryType		0..1	code	barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason		0..*	CodeableConcept	online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier	S	0..1	string	(USCDI) The distinct identification string
manufacturer		0..1	string	Name of device manufacturer
manufactureDate	S	0..1	dateTime	(USCDI) Date when the device was made
expirationDate	S	0..1	dateTime	(USCDI) Date and time of expiry of this device (if applicable)
lotNumber	S	0..1	string	(USCDI) Lot number of manufacture
serialNumber	S	0..1	string	(USCDI) Serial number assigned by the manufacturer
deviceName		0..*	BackboneElement	The name of the device as given by the manufacturer
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
name		1..1	string	The name of the device
type		1..1	code	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
modelNumber		0..1	string	The model number for the device
partNumber		0..1	string	The part number of the device
type	S	1..1	CodeableConcept	(USCDI) The kind or type of device Binding: Brachytherapy Device Type Value Set (required)
specialization		0..*	BackboneElement	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
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
systemType		1..1	CodeableConcept	The standard that is used to operate and communicate
version		0..1	string	The version of the standard that is used to operate and communicate
version		0..*	BackboneElement	The actual design of the device or software version running on the device
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
type		0..1	CodeableConcept	The type of the device version
component		0..1	Identifier	A single component of the device version
value		1..1	string	The version text
property		0..*	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
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
type		1..1	CodeableConcept	Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
valueQuantity		0..*	Quantity	Property value as a quantity
valueCode		0..*	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP)
patient	S	1..1	Reference(US Core Patient Profile)	(USCDI) Patient to whom Device is affixed
owner		0..1	Reference(Organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(Location)	Where the device is found
url		0..1	uri	Network address to contact device
note		0..*	Annotation	Device notes and comments
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device
parent		0..1	Reference(Device)	The parent device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Device.udiCarrier.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.statusReason	extensible	FHIRDeviceStatusReason http://hl7.org/fhir/ValueSet/device-status-reason from the FHIR Standard
Device.deviceName.type	required	DeviceNameType http://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard
Device.type	required	BrachytherapyDeviceTypeVS http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-brachytherapy-device-type-vs from this IG

This structure is derived from USCoreImplantableDeviceProfile

Summary

Differential View

This structure is derived from USCoreImplantableDeviceProfile

Name	Flags	Card.	Type	Description & Constraints
Device			USCoreImplantableDeviceProfile
type		1..1	CodeableConcept	(USCDI) The kind or type of device Binding: Brachytherapy Device Type Value Set (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Device.type	required	BrachytherapyDeviceTypeVS http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-brachytherapy-device-type-vs from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	USCoreImplantableDeviceProfile	Item used in healthcare dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
udiCarrier	SΣ	0..1	BackboneElement	(USCDI) Unique Device Identifier (UDI) Barcode string ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deviceIdentifier	SΣ	1..1	string	(USCDI) Mandatory fixed portion of UDI ele-1: All FHIR elements must have a @value or children
carrierHRF	SΣ	0..1	string	(USCDI) UDI Human Readable Barcode String ele-1: All FHIR elements must have a @value or children
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children
distinctIdentifier	S	0..1	string	(USCDI) The distinct identification string ele-1: All FHIR elements must have a @value or children
manufactureDate	S	0..1	dateTime	(USCDI) Date when the device was made ele-1: All FHIR elements must have a @value or children
expirationDate	S	0..1	dateTime	(USCDI) Date and time of expiry of this device (if applicable) ele-1: All FHIR elements must have a @value or children
lotNumber	S	0..1	string	(USCDI) Lot number of manufacture ele-1: All FHIR elements must have a @value or children
serialNumber	S	0..1	string	(USCDI) Serial number assigned by the manufacturer ele-1: All FHIR elements must have a @value or children
type	S	1..1	CodeableConcept	(USCDI) The kind or type of device Binding: Brachytherapy Device Type Value Set (required) ele-1: All FHIR elements must have a @value or children
patient	S	1..1	Reference(US Core Patient Profile)	(USCDI) Patient to whom Device is affixed ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.type	required	BrachytherapyDeviceTypeVS http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-brachytherapy-device-type-vs from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Device		0..*	USCoreImplantableDeviceProfile	Item used in healthcare
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	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
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Instance identifier
definition		0..1	Reference(DeviceDefinition)	The reference to the definition for the device
udiCarrier	SΣ	0..1	BackboneElement	(USCDI) Unique Device Identifier (UDI) Barcode string
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
deviceIdentifier	SΣ	1..1	string	(USCDI) Mandatory fixed portion of UDI
issuer		0..1	uri	UDI Issuing Organization
jurisdiction		0..1	uri	Regional UDI authority
carrierAIDC	Σ	0..1	base64Binary	UDI Machine Readable Barcode String
carrierHRF	SΣ	0..1	string	(USCDI) UDI Human Readable Barcode String
entryType		0..1	code	barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered.
status	?!Σ	0..1	code	active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device.
statusReason		0..*	CodeableConcept	online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device.
distinctIdentifier	S	0..1	string	(USCDI) The distinct identification string
manufacturer		0..1	string	Name of device manufacturer
manufactureDate	S	0..1	dateTime	(USCDI) Date when the device was made
expirationDate	S	0..1	dateTime	(USCDI) Date and time of expiry of this device (if applicable)
lotNumber	S	0..1	string	(USCDI) Lot number of manufacture
serialNumber	S	0..1	string	(USCDI) Serial number assigned by the manufacturer
deviceName		0..*	BackboneElement	The name of the device as given by the manufacturer
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
name		1..1	string	The name of the device
type		1..1	code	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by.
modelNumber		0..1	string	The model number for the device
partNumber		0..1	string	The part number of the device
type	S	1..1	CodeableConcept	(USCDI) The kind or type of device Binding: Brachytherapy Device Type Value Set (required)
specialization		0..*	BackboneElement	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
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
systemType		1..1	CodeableConcept	The standard that is used to operate and communicate
version		0..1	string	The version of the standard that is used to operate and communicate
version		0..*	BackboneElement	The actual design of the device or software version running on the device
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
type		0..1	CodeableConcept	The type of the device version
component		0..1	Identifier	A single component of the device version
value		1..1	string	The version text
property		0..*	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
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
type		1..1	CodeableConcept	Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
valueQuantity		0..*	Quantity	Property value as a quantity
valueCode		0..*	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP)
patient	S	1..1	Reference(US Core Patient Profile)	(USCDI) Patient to whom Device is affixed
owner		0..1	Reference(Organization)	Organization responsible for device
contact		0..*	ContactPoint	Details for human/organization for support
location		0..1	Reference(Location)	Where the device is found
url		0..1	uri	Network address to contact device
note		0..*	Annotation	Device notes and comments
safety	Σ	0..*	CodeableConcept	Safety Characteristics of Device
parent		0..1	Reference(Device)	The parent device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Device.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Device.udiCarrier.entryType	required	UDIEntryType http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1 from the FHIR Standard
Device.status	required	FHIRDeviceStatus http://hl7.org/fhir/ValueSet/device-status|4.0.1 from the FHIR Standard
Device.statusReason	extensible	FHIRDeviceStatusReason http://hl7.org/fhir/ValueSet/device-status-reason from the FHIR Standard
Device.deviceName.type	required	DeviceNameType http://hl7.org/fhir/ValueSet/device-nametype|4.0.1 from the FHIR Standard
Device.type	required	BrachytherapyDeviceTypeVS http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-brachytherapy-device-type-vs from this IG

This structure is derived from USCoreImplantableDeviceProfile

Summary

Other representations of profile: CSV, Excel, Schematron