This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. 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
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MRISafetyObservation | Version: 3.0.0 | |||
Draft as of 2024-05-18 | Computable Name: MRISafetyObservation | |||
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.318:2019-06-21 |
This template is intended to be used in addition to the Product Instance template to exchange the MRI Safety Status of the patient’s medical device. The UDI-DI of the medical device may be used to retrieve the MRI Safety Status in accessGUDID, which should be considered the source of truth.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:mri-safety-obs | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.318 | |
@extension | 1..1 | st | Required Pattern: 2019-06-21 | |
code | 1..1 | CD | Code for "MRI Safety Status" | |
@code | 1..1 | cs | Required Pattern: C106044 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.3.26.1.1 | |
@codeSystemName | 0..1 | st | MAY be set to 'NCI Thesaurus' | |
@displayName | 0..1 | st | MAY be set to 'MRI Safety' | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value | 1..1 | CD | ||
@nullFlavor | 0..0 | |||
@code | 1..1 | cs | Binding: Device Magnetic resonance (MR) Safety (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.value.code | required | DeviceMagneticResonanceMRSafety http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.46 |
Id | Grade | Path(s) | Details | Requirements |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:mri-safety-obs | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.318 | |
@extension | 1..1 | st | Required Pattern: 2019-06-21 | |
@classCode | 1..1 | cs | Binding: CDAActClassObservation (required) | |
@moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) | |
code | 1..1 | CD | Code for "MRI Safety Status" Binding: ObservationType (example) | |
@code | 1..1 | cs | Required Pattern: C106044 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.3.26.1.1 | |
@codeSystemName | 0..1 | st | MAY be set to 'NCI Thesaurus' | |
@displayName | 0..1 | st | MAY be set to 'MRI Safety' | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value | 1..1 | CD | ||
@code | 1..1 | cs | Binding: Device Magnetic resonance (MR) Safety (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.value.code | required | DeviceMagneticResonanceMRSafety http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.46 |
Id | Grade | Path(s) | Details | Requirements |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:mri-safety-obs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Observation.value.code | required | DeviceMagneticResonanceMRSafety http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.46 | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Observation
Summary
Mandatory: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:mri-safety-obs | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.318 | |
@extension | 1..1 | st | Required Pattern: 2019-06-21 | |
code | 1..1 | CD | Code for "MRI Safety Status" | |
@code | 1..1 | cs | Required Pattern: C106044 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.3.26.1.1 | |
@codeSystemName | 0..1 | st | MAY be set to 'NCI Thesaurus' | |
@displayName | 0..1 | st | MAY be set to 'MRI Safety' | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value | 1..1 | CD | ||
@nullFlavor | 0..0 | |||
@code | 1..1 | cs | Binding: Device Magnetic resonance (MR) Safety (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.value.code | required | DeviceMagneticResonanceMRSafety http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.46 |
Id | Grade | Path(s) | Details | Requirements |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 1..1 | Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:mri-safety-obs | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.318 | |
@extension | 1..1 | st | Required Pattern: 2019-06-21 | |
@classCode | 1..1 | cs | Binding: CDAActClassObservation (required) | |
@moodCode | 1..1 | cs | Binding: XActMoodDocumentObservation (2.0.0) (required) | |
code | 1..1 | CD | Code for "MRI Safety Status" Binding: ObservationType (example) | |
@code | 1..1 | cs | Required Pattern: C106044 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.3.26.1.1 | |
@codeSystemName | 0..1 | st | MAY be set to 'NCI Thesaurus' | |
@displayName | 0..1 | st | MAY be set to 'MRI Safety' | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
value | 1..1 | CD | ||
@code | 1..1 | cs | Binding: Device Magnetic resonance (MR) Safety (required) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.value.code | required | DeviceMagneticResonanceMRSafety http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.46 |
Id | Grade | Path(s) | Details | Requirements |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Observation.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.templateId:mri-safety-obs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.classCode | required | CDAActClassObservationhttp://hl7.org/cda/stds/core/ValueSet/CDAActClassObservation | |
Observation.moodCode | required | XActMoodDocumentObservationhttp://terminology.hl7.org/ValueSet/v3-xActMoodDocumentObservation|2.0.0 | |
Observation.code | example | ObservationTypehttp://terminology.hl7.org/ValueSet/v3-ObservationType | |
Observation.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Observation.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Observation.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Observation.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Observation.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Observation.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Observation.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard | |
Observation.value.code | required | DeviceMagneticResonanceMRSafety http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1021.46 | |
Observation.interpretationCode | required | CDAObservationInterpretationhttp://hl7.org/cda/stds/core/ValueSet/CDAObservationInterpretation | |
Observation.methodCode | example | ObservationMethodhttp://terminology.hl7.org/ValueSet/v3-ObservationMethod | |
Observation.referenceRange.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Observation.referenceRange.typeCode | required | Fixed Value: REFVhttp://hl7.org/cda/stds/core/ValueSet/CDAActRelationshipType |
Id | Grade | Path(s) | Details | Requirements |
should-text-ref-value | warning | Observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Observation.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Observation
Summary
Mandatory: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices: