STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-diagnosticreport

The official URL for this profile is: 

http://hl7.org/fhir/us/daf/StructureDefinition/daf-diagnosticreport

This profile was published on Wed Nov 19 00:00:00 AEDT 2014 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.4.1.1 Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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 S0..*IdentifierId for external references to this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!S1..1coderegistered | partial | final | corrected | appended | cancelled | entered-in-error
Binding: DiagnosticReportStatus (required)
... category S0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
... code S1..1CodeableConceptName/Code for this diagnostic report
Binding: uslab-obs-codes (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display S0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text S0..1stringPlain text representation of the concept
... subject S1..1Reference(Profile daf-patient)The subject of the report, usually, but not always, the patient
... encounter S0..1Reference(Profile daf-encounter)Health care event when test ordered
... effective[x] S1..1dateTime, PeriodClinically Relevant time/time-period for report
... issued S1..1instantDateTime this version was released
... performer S1..1Reference(Profile daf-pract | Profile daf-organization)Responsible Diagnostic Service
... request S1..*Reference(Profile daf-diagnosticrequest)A request for a diagnostic service
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result S0..*Reference(Profile daf-resultobs)Observations - simple, or complex nested groups
... imagingStudy 0..*Reference(ImagingStudy | ImagingManifest)Reference to full details of imaging associated with the diagnostic report
... image ∑0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link ∑1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical Interpretation of test results
... codedDiagnosis S0..*CodeableConceptCodes for the conclusion
Binding: SNOMED CT Clinical Findings (preferred)
... presentedForm S0..*AttachmentEntire report as issued

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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 S0..*IdentifierId for external references to this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!S1..1coderegistered | partial | final | corrected | appended | cancelled | entered-in-error
Binding: DiagnosticReportStatus (required)
... category S0..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
... code S1..1CodeableConceptName/Code for this diagnostic report
Binding: uslab-obs-codes (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display S0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text S0..1stringPlain text representation of the concept
... subject S1..1Reference(Profile daf-patient)The subject of the report, usually, but not always, the patient
... encounter S0..1Reference(Profile daf-encounter)Health care event when test ordered
... effective[x] S1..1dateTime, PeriodClinically Relevant time/time-period for report
... issued S1..1instantDateTime this version was released
... performer S1..1Reference(Profile daf-pract | Profile daf-organization)Responsible Diagnostic Service
... request S1..*Reference(Profile daf-diagnosticrequest)A request for a diagnostic service
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result S0..*Reference(Profile daf-resultobs)Observations - simple, or complex nested groups
... imagingStudy 0..*Reference(ImagingStudy | ImagingManifest)Reference to full details of imaging associated with the diagnostic report
... image ∑0..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link ∑1..1Reference(Media)Reference to the image source
... conclusion S0..1stringClinical Interpretation of test results
... codedDiagnosis S0..*CodeableConceptCodes for the conclusion
Binding: SNOMED CT Clinical Findings (preferred)
... presentedForm S0..*AttachmentEntire report as issued

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
DiagnosticReport.languageCommon LanguagesextensibleCommon Languages
DiagnosticReport.identifier.useIdentifierUserequiredIdentifierUse
DiagnosticReport.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
DiagnosticReport.statusDiagnosticReportStatusrequiredDiagnosticReportStatus
DiagnosticReport.categoryDiagnostic Service Section CodesexampleDiagnostic Service Section Codes
DiagnosticReport.code?extextensiblehttp://hl7.org/fhir/ValueSet/uslab-obs-codes
DiagnosticReport.codedDiagnosisSNOMED CT Clinical FindingspreferredSNOMED CT Clinical Findings

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4DiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3DiagnosticReportIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.