MyHealtheVet PHR FHIR API
0.3.9-current - ci-build United States of America flag

MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions

Resource Profile: VA MHV PHR Imaging Report

Official URL: https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.imaging Version: 0.3.9-current
Standards status: Trial-use Maturity Level: 1 Computable Name: MHVimagingExam

A profile on the DiagnosticReport resource for MHV PHR exposing Imaging Report (ImagingExamTO) using FHIR API.

Radiology Diagnostic Report

  • This profile is based on:
  • subject is a reference to this patient
  • category = LOINC#LP29684-5
  • code.coding may hold CPT code from ImagingExamTO.type
  • code.text will hold the ImagingExamTO.name
  • status = final if not entered-in-error or derived from ImagingExamTO.status
  • identifier:
    • will hold the unique identifier of this report
    • may hold case number
    • may hold accession number
  • performer may point at the imaging study organization
  • resultsInterpreter will point at the provider
  • issued will be the date of the report Verified
  • effectiveDateTime will be the date of the Exam
  • encounter.identifier may hold the encounter identifier
  • conclusion will hold the interpretation
  • presentedForm.title will hold the title of the radiology report
  • presentedForm.creation will hold the timestamp on the report
  • presentedForm.contentType will be text/plain
  • presentedForm.data will hold the base64 encoded radiology report
  • basedOn may point at a the order ServiceRequest
    • ServiceRequest.code.text will be the name of the order
    • ServiceRequest.identifier will be the identifier of the order
    • ServiceRequest.category will be Imaging
    • ServiceRequest.intent will be order
    • ServiceRequest.requester may be the Requesting Physician
    • ServiceRequest.performer may be the imaging center organization
  • Note there are no Observations or Specimen with a radiology report

Search Consideration

  • Should search for entries that do not have status=entered-in-error (i.e., &status:not=entered-in-error)
  • Should search for entries with category of Radiology to get only Radiology DiagnosticReport resources
GET {path}/DiagnosticReport?patient={patient}&status:not=entered-in-error&category=http://loinc.org LP29684-5

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreDiagnosticReportProfileNoteExchange

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* USCoreDiagnosticReportProfileNoteExchange A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for identifier S 1..* Identifier Business identifier for report
Slice: Unordered, Open by pattern:use
.... identifier:TOid 1..1 Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `ImagingExamTO` | `.` | {ImagingExamTO.id}
.... identifier:accessionNumber 0..* Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `Accession` | `.` | {ImagingExamTO.accessionNum}
.... identifier:casenum 0..* Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `CaseNum` | `.` | {ImagingExam.casenum}
... basedOn S 0..* Reference(VA MHV PHR ImagingExamTO.order) {c} order
... status 1..1 code registered | partial | preliminary | final +
... category 1..* CodeableConcept Service category
... Slices for category Content/Rules for all slices
.... category:us-core 0..* CodeableConcept Service category
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP29684-5
...... display 1..1 string Representation defined by the system
Fixed Value: Radiology
... code
.... coding 0..* Coding Code defined by a terminology system
.... text 0..1 string Plain text representation of the concept
... subject 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter
.... reference 0..0
.... identifier S 0..1 Identifier Logical reference, when literal reference is not known
... Slices for effective[x] 1..1 dateTime Diagnostically relevant time (typically the time of the procedure)
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 1..1 dateTime S Diagnostically relevant time (typically the time of the procedure)
... issued 1..1 instant DateTime this version was made
... performer 1..1 Reference(VA MHV PHR Organization) {c} imagingLocation
... resultsInterpreter S 1..1 Reference(US Core Practitioner Profile) {c} provider
... specimen 0..0
... result 0..0
... imagingStudy 0..0
... media 0..0
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..0
... presentedForm
.... contentType S 0..1 code Mime type of the content, with charset etc.
.... data S 0..1 base64Binary Data inline, base64ed
.... title S 0..1 string Label to display in place of the data
.... creation S 0..1 dateTime Date attachment was first created

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.system, DiagnosticReport.identifier:accessionNumber.system, DiagnosticReport.identifier:casenum.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileNoteExchange A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-10: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier for report
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business identifier for report
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImagingExamTO` | `.` | {ImagingExamTO.id}
Example General: 123456
.... identifier:accessionNumber Σ 0..* Identifier Business identifier for report
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `Accession` | `.` | {ImagingExamTO.accessionNum}
Example General: 123456
.... identifier:casenum Σ 0..* Identifier Business identifier for report
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `CaseNum` | `.` | {ImagingExam.casenum}
Example General: 123456
... basedOn S 0..* Reference(VA MHV PHR ImagingExamTO.order) {c} order
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


.... category:us-core SΣ 0..* CodeableConcept Service category
Binding: US Core Diagnostic Report Category Codes (required)

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP29684-5
...... display 1..1 string Representation defined by the system
Fixed Value: Radiology
... code SΣ 1..1 CodeableConcept US Core Report Code
Binding: US Core Non Laboratory Codes (extensible): LOINC codes

.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(US Core Encounter Profile) Health care event when test ordered
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
... Slices for effective[x] SΣC 1..1 dateTime Diagnostically relevant time (typically the time of the procedure)
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime Diagnostically relevant time (typically the time of the procedure)
... issued SΣ 1..1 instant DateTime this version was made
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} imagingLocation
... resultsInterpreter SΣ 1..1 Reference(US Core Practitioner Profile) {c} provider
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... data S 0..1 base64Binary Data inline, base64ed
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:casenum.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:us-corerequiredPattern: LOINC Code LP29684-5("Radiology")
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category
DiagnosticReport.codeextensibleUSCoreNonLaboratoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-report-and-note-codes
DiagnosticReport.presentedForm.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.system, DiagnosticReport.identifier:accessionNumber.system, DiagnosticReport.identifier:casenum.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileNoteExchange A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-10: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... 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 BindingsPurpose
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
... Slices for identifier SΣ 1..* Identifier Business identifier for report
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImagingExamTO` | `.` | {ImagingExamTO.id}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:accessionNumber Σ 0..* Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `Accession` | `.` | {ImagingExamTO.accessionNum}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:casenum Σ 0..* Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `CaseNum` | `.` | {ImagingExam.casenum}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... basedOn S 0..* Reference(VA MHV PHR ImagingExamTO.order) {c} order
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


.... category:us-core SΣ 0..* CodeableConcept Service category
Binding: US Core Diagnostic Report Category Codes (required)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP29684-5
...... display 1..1 string Representation defined by the system
Fixed Value: Radiology
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept US Core Report Code
Binding: US Core Non Laboratory Codes (extensible): LOINC codes

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(US Core Encounter Profile) Health care event when test ordered
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for effective[x] SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of the procedure)
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of the procedure)
... issued SΣ 1..1 instant DateTime this version was made
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} imagingLocation
... resultsInterpreter SΣ 1..1 Reference(US Core Practitioner Profile) {c} provider
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data S 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:casenum.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:casenum.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:us-corerequiredPattern: LOINC Code LP29684-5("Radiology")
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category
DiagnosticReport.codeextensibleUSCoreNonLaboratoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-report-and-note-codes
DiagnosticReport.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.presentedForm.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DiagnosticReport.presentedForm.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.system, DiagnosticReport.identifier:accessionNumber.system, DiagnosticReport.identifier:casenum.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreDiagnosticReportProfileNoteExchange

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.identifier
  • The element 1 is sliced based on the value of DiagnosticReport.effective[x]

Maturity: 1

Differential View

This structure is derived from USCoreDiagnosticReportProfileNoteExchange

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* USCoreDiagnosticReportProfileNoteExchange A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for identifier S 1..* Identifier Business identifier for report
Slice: Unordered, Open by pattern:use
.... identifier:TOid 1..1 Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `ImagingExamTO` | `.` | {ImagingExamTO.id}
.... identifier:accessionNumber 0..* Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `Accession` | `.` | {ImagingExamTO.accessionNum}
.... identifier:casenum 0..* Identifier Business identifier for report
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `CaseNum` | `.` | {ImagingExam.casenum}
... basedOn S 0..* Reference(VA MHV PHR ImagingExamTO.order) {c} order
... status 1..1 code registered | partial | preliminary | final +
... category 1..* CodeableConcept Service category
... Slices for category Content/Rules for all slices
.... category:us-core 0..* CodeableConcept Service category
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP29684-5
...... display 1..1 string Representation defined by the system
Fixed Value: Radiology
... code
.... coding 0..* Coding Code defined by a terminology system
.... text 0..1 string Plain text representation of the concept
... subject 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter
.... reference 0..0
.... identifier S 0..1 Identifier Logical reference, when literal reference is not known
... Slices for effective[x] 1..1 dateTime Diagnostically relevant time (typically the time of the procedure)
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 1..1 dateTime S Diagnostically relevant time (typically the time of the procedure)
... issued 1..1 instant DateTime this version was made
... performer 1..1 Reference(VA MHV PHR Organization) {c} imagingLocation
... resultsInterpreter S 1..1 Reference(US Core Practitioner Profile) {c} provider
... specimen 0..0
... result 0..0
... imagingStudy 0..0
... media 0..0
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..0
... presentedForm
.... contentType S 0..1 code Mime type of the content, with charset etc.
.... data S 0..1 base64Binary Data inline, base64ed
.... title S 0..1 string Label to display in place of the data
.... creation S 0..1 dateTime Date attachment was first created

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.system, DiagnosticReport.identifier:accessionNumber.system, DiagnosticReport.identifier:casenum.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileNoteExchange A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-10: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier for report
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business identifier for report
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImagingExamTO` | `.` | {ImagingExamTO.id}
Example General: 123456
.... identifier:accessionNumber Σ 0..* Identifier Business identifier for report
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `Accession` | `.` | {ImagingExamTO.accessionNum}
Example General: 123456
.... identifier:casenum Σ 0..* Identifier Business identifier for report
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `CaseNum` | `.` | {ImagingExam.casenum}
Example General: 123456
... basedOn S 0..* Reference(VA MHV PHR ImagingExamTO.order) {c} order
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


.... category:us-core SΣ 0..* CodeableConcept Service category
Binding: US Core Diagnostic Report Category Codes (required)

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP29684-5
...... display 1..1 string Representation defined by the system
Fixed Value: Radiology
... code SΣ 1..1 CodeableConcept US Core Report Code
Binding: US Core Non Laboratory Codes (extensible): LOINC codes

.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(US Core Encounter Profile) Health care event when test ordered
.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
... Slices for effective[x] SΣC 1..1 dateTime Diagnostically relevant time (typically the time of the procedure)
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime Diagnostically relevant time (typically the time of the procedure)
... issued SΣ 1..1 instant DateTime this version was made
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} imagingLocation
... resultsInterpreter SΣ 1..1 Reference(US Core Practitioner Profile) {c} provider
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... data S 0..1 base64Binary Data inline, base64ed
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:casenum.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:us-corerequiredPattern: LOINC Code LP29684-5("Radiology")
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category
DiagnosticReport.codeextensibleUSCoreNonLaboratoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-report-and-note-codes
DiagnosticReport.presentedForm.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.system, DiagnosticReport.identifier:accessionNumber.system, DiagnosticReport.identifier:casenum.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileNoteExchange A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-10: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... 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 BindingsPurpose
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
... Slices for identifier SΣ 1..* Identifier Business identifier for report
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImagingExamTO` | `.` | {ImagingExamTO.id}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:accessionNumber Σ 0..* Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `Accession` | `.` | {ImagingExamTO.accessionNum}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:casenum Σ 0..* Identifier Business identifier for report
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `CaseNum` | `.` | {ImagingExam.casenum}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... basedOn S 0..* Reference(VA MHV PHR ImagingExamTO.order) {c} order
... status ?!SΣC 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.


.... category:us-core SΣ 0..* CodeableConcept Service category
Binding: US Core Diagnostic Report Category Codes (required)

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LP29684-5
...... display 1..1 string Representation defined by the system
Fixed Value: Radiology
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept US Core Report Code
Binding: US Core Non Laboratory Codes (extensible): LOINC codes

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(US Core Encounter Profile) Health care event when test ordered
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier SΣ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... Slices for effective[x] SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of the procedure)
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣC 1..1 dateTime S Diagnostically relevant time (typically the time of the procedure)
... issued SΣ 1..1 instant DateTime this version was made
... performer SΣ 1..1 Reference(VA MHV PHR Organization) {c} imagingLocation
... resultsInterpreter SΣ 1..1 Reference(US Core Practitioner Profile) {c} provider
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType SΣ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data S 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.userequiredPattern: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:accessionNumber.typeextensiblePattern: ACSN
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.identifier:casenum.userequiredPattern: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:casenum.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:us-corerequiredPattern: LOINC Code LP29684-5("Radiology")
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category
DiagnosticReport.codeextensibleUSCoreNonLaboratoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-report-and-note-codes
DiagnosticReport.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
DiagnosticReport.presentedForm.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DiagnosticReport.presentedForm.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorDiagnosticReport.identifier:TOid.system, DiagnosticReport.identifier:accessionNumber.system, DiagnosticReport.identifier:casenum.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreDiagnosticReportProfileNoteExchange

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.identifier
  • The element 1 is sliced based on the value of DiagnosticReport.effective[x]

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Business Rules

  • Ignore if no facility
  • hold is calculated from the "Date Verified:" text found in the report body

Mapping Concerns

  • some schema elements found in VIA_v4.0.7_uat.wsdl are not mapped here because I can't tell what is in them. Most of them likely have a place to go in the FHIR model, but I need to know more about them.
    • hasImages
    • imagingType - always was GENERAL RADIOLOGY
    • facility - no clear place. Need to understand this better, is it data best put inside a contained Encounter?
    • these never appeared in examples
      • modifiers
      • clinicalHX
      • impression
      • imagingExamTO
      • reportId
  • Validation does not like some of our CPT codes. These might be deprecated codes, that the codeSystem that the validator is using does not include. These might also be mistakes or test data.
    • (Leaf Request #52)
    • Jay confirmed these are good, but deprecated: 71020, 78465
    • Not yet confirmed: 78478, 78990
    • unclear what other codes may come to us from Vista
    • see zulip chat with terminology
  • status
    • radiologyReportTO.status – always "Verified" in our mock data. not clear what else it might be. Might this be the signature status on the report?
    • imagingExamTO.status – always "COMPLETE" in our mock data. not clear what else it might be
  • unclear the difference between the imagingStudyTO.timestamp and the radiologyReport.timestamp. Logic would be that the first is the timestamp of the study, and the second is the timestamp of the report. All data has them as the same values.
  • unclear if there will ever be more than one Order
  • unclear if there will ever be more than one radiologyReportTO. I think the code handles only one radiologyReportTO per imagingExamTO.
  • is VIA the only source? Or do we also get some from CVIX? (asked Barry)

Mapping

MHV eVault has one object definition that gets replicated for each imagingExamTO with one radiologyReportTO

VIA sends

  • imagingExamTO
    • OrderTO
    • radiologyReportTO
V Vn VIA MHV eVault FHIR Note
    imagingExamTO.accessionNum     no data
    imagingExamTO.casenum   DiagnosticReport.identifier[casenum]  
    imagingExamTO.encounterId   DiagnosticReport.encounter.identifier  
    imagingExamTO.facility     no data
    imagingExamTO.hasImages      
    imagingExamTO.id   DiagnosticReport.identifier[TOid]  
    imagingExamTO.imagingType   DiagnosticReport.code.text  
    imagingExamTO.interpretation   DiagnosticReport.conclusion  
    imagingExamTO.imagingLocation   DiagnosticReport.performer [Org]  
    imagingExamTO.modifiers     no data
    imagingExamTO.name      
    imagingExamTO.order [OrderTO]   DiagnosticReport.basedOn = ServiceRequest  
    imagingExamTO.provider radiologist DiagnosticReport.resultsInterpreter  
    """   ServiceRequest.requester  
    imagingExamTO. [radiologyReportTO]      
    imagingExamTO.reportId     no data
    imagingExamTO.status     presume always COMPLETE
    imagingExamTO.timestamp eventTime DiagnosticReport.effectiveDateTime  
    imagingExamTO.type.id   DiagnosticReport.code.coding.code CPT code
    imagingExamTO.type.name   DiagnosticReport.code.coding.display  
    orderTO.id   ServiceRequest.identifier  
    orderTO.type.name1   ServiceRequest.code.text  
    orderTO.*     no data
    radiologyReportTO.accessionNumber   DiagnosticReport.identifier[accessionNumber]  
    radiologyReportTO.caseNumber   DiagnosticReport.identifier[casenum]  
    radiologyReportTO.id     duplicates imagingExamTO.id
    radiologyReportTO.title title DiagnosticReport.presentedForm.title  
    radiologyReportTO.timestamp      
    radiologyReportTO.author     no data
    radiologyReportTO.facility facility ServiceRequest.performer  
    radiologyReportTO.status     always Verified
    radiologyReportTO.cptCode     no data
    radiologyReportTO.clinicalHx     no data
    radiologyReportTO.impression     no data
    radiologyReportTO.text   DiagnosticReport.presentedForm.data  
    text {Date Verified}   DiagnosticReport.issued used for Hold
    text {Req Phys} requesting_provider ServiceRequest.requester  
    text {Report} reporttext   subset of the text
    text {Impression} impressiontext   subset of the text
    text {Exm Date} examDateImprecise   seems ImagingExamTO.timestamp
    text {Report Status} status    
    text {Clinical History} clinical_history    
    text {reason for study} reason_for_study   no data
    text {Date Reported}   DiagnosticReport.presentedForm.created  
    /recordsource/ performing_location_st_number    
        ServiceRequest.category = SCT#363679005 "Imaging"  
        ServiceRequest.status = unknown  
        ServiceRequest.intent = order  
        ServiceRequest.subject = {patient}  
        DiagnosticReport.category = LOINC#LP29684-5 Radiology  
        DiagnosticReport.status = final if not `entered-in-error  
        DiagnosticReport.subject = {patient}  
        DiagnosticReport.presentedForm.contentType = text/plain  
      inpatient_outpatient   never set
      comments   never set