2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: DAFDiagnosticOrder

The official URL for this profile is: 

http://hl7.org/fhir/Profile/diagnosticorder-daf-dafdiagnosticorder

. Defines constraints and extensions on the DiagnosticOrder resource for use in querying and retrieving DiagnosticOrder information. : U.S. Data Access Framework (DAF) DiagnosticOrder Profile

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC).

Summary

Terminology Bindings

  • DiagnosticOrder.event.description must come from Information about an event that occurred to a diagnostic order that corresponds to the USLabOrder Use Cases

Required/Prohibited Elements

  • The element DiagnosticOrder is required
  • The element DiagnosticOrder.text is required
  • The element DiagnosticOrder.text.status is required
  • The element DiagnosticOrder.subject is required
  • The element DiagnosticOrder.orderer is required
  • The element DiagnosticOrder.identifier is required
  • The element DiagnosticOrder.identifier.use is required
  • The element DiagnosticOrder.identifier.label is required
  • The element DiagnosticOrder.identifier.system is required
  • The element DiagnosticOrder.identifier.value is required
  • The element DiagnosticOrder.identifier.use is required
  • The element DiagnosticOrder.identifier.label is required
  • The element DiagnosticOrder.identifier.system is required
  • The element DiagnosticOrder.identifier.value is required
  • The element DiagnosticOrder.encounter is required
  • The element DiagnosticOrder.status is required
  • The element DiagnosticOrder.priority is required
  • The element DiagnosticOrder.event is required
  • The element DiagnosticOrder.event.description is required
  • The element DiagnosticOrder.event.description.coding is required
  • The element DiagnosticOrder.event.description.coding.code is required
  • The element DiagnosticOrder.event.dateTime is required
  • The element DiagnosticOrder.item is required
  • The element DiagnosticOrder.item.code is required
  • The element DiagnosticOrder.item.code.coding.system is required
  • The element DiagnosticOrder.item.code.coding.code is required
  • The element DiagnosticOrder.item.code.coding.system is required
  • The element DiagnosticOrder.item.code.coding.code is required
  • The element DiagnosticOrder.item.bodySite[x] is prohibited
  • The element DiagnosticOrder.item.status is required

Fixed Values

  • The element DiagnosticOrder.text.status value has been fixed to generated
  • The element DiagnosticOrder.identifier.use value has been fixed to official
  • The element DiagnosticOrder.identifier.label value has been fixed to Placer Order Number
  • The element DiagnosticOrder.identifier.use value has been fixed to official
  • The element DiagnosticOrder.identifier.label value has been fixed to Filler Order Number
  • The element DiagnosticOrder.item.code.coding.system value has been fixed to http://loinc.org

Formal Views of Profile Content

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

Differential View

This structure is derived from DiagnosticOrder.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 1..1
... text S1..1
.... status S1..1codeFixed Value: generated
... subject S1..1patient-daf-dafpatient
... orderer S1..1
... identifier Slice: Ordered, Closed, by identifier.label
... identifier S1..1Identifier
.... use S1..1codeFixed Value: official
.... label S1..1stringFixed Value: Placer Order Number
.... system S1..1Placer URI
.... value S1..1Placer Identifier
... identifier S0..1Identifier
.... use S1..1codeFixed Value: official
.... label S1..1stringFixed Value: Filler Order Number
.... system S1..1Filler URI
.... value S1..1Filler Identifier
... encounter S1..1encounter-daf-dafencounter
... clinicalNotes S0..1
... supportingInformation S0..*observation-daf-results-dafresultobservationcode, observation-daf-results-dafresultobsquantity, observation-daf-results-dafresultobsratio, observation-daf-results-dafresultobsother
... specimen S0..*
... status S1..1
... priority S1..1
... event S1..*
.... description S1..1Binding: USLABDOEvent (required, extensible)
..... coding S1..1
...... code S1..1
.... dateTime S1..1
... item S1..*
.... code S I1..1US Realm Laboratory Report Order Code
inv-1: Must have a LOINC or a Local code or both.
..... coding Slice: Unordered, Open, by system
..... coding S I0..1LOINC coding if available
...... system S1..1uriLOINC Coding System
Fixed Value: http://loinc.org
...... code S1..1LOINC
...... display S0..1LOINC Display Name
..... coding S I0..1
...... system S1..1uriLocal Coding System
...... code S1..1Local Code
...... display S0..1Local Code Display name
.... specimen S0..*
.... bodySite[x] 0..0
.... status S1..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 1..1A request for a diagnostic service
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... subject S1..1patient-daf-dafpatientWho and/or what test is about
... orderer S1..1PractitionerWho ordered the test
... identifier IdentifierIdentifiers assigned to this order
Slice: Ordered, Closed, by identifier.label
... identifier S1..1IdentifierIdentifiers assigned to this order
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
Fixed Value: official
.... label S1..1stringDescription of identifier
Fixed Value: Placer Order Number
.... system S1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringPlacer Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... identifier S0..1IdentifierIdentifiers assigned to this order
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
Fixed Value: official
.... label S1..1stringDescription of identifier
Fixed Value: Filler Order Number
.... system S1..1uriFiller URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringFiller Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... encounter S1..1encounter-daf-dafencounterThe encounter that this diagnostic order is associated with
... clinicalNotes S0..1stringExplanation/Justification for test
... supportingInformation S0..*observation-daf-results-dafresultobservationcode, observation-daf-results-dafresultobsquantity, observation-daf-results-dafresultobsratio, observation-daf-results-dafresultobsotherAdditional clinical information
... specimen S0..*SpecimenIf the whole order relates to specific specimens
... status S1..1codeproposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required, not extensible)
... priority S1..1coderoutine | urgent | stat | asap
Binding: DiagnosticOrderPriority (required, not extensible)
... event S1..*A list of events of interest in the lifecycle
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeproposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required, not extensible)
.... description S1..1CodeableConceptMore information about the event and its context
Binding: USLABDOEvent (required, extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..1CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system 0..1uriIdentity of the terminology system
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSymbol in syntax defined by the system
...... display 0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... text 0..1stringPlain text representation of the concept
.... dateTime S1..1dateTimeThe date at which the event happened
.... actor 0..1Practitioner, DeviceWho recorded or did this
... item S1..*The items the orderer requested
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... code S I1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: DiagnosticRequests (preferred, extensible)
inv-1: Must have a LOINC or a Local code or both.
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding CodingCode defined by a terminology system
Slice: Unordered, Open, by system
..... coding S0..1CodingLOINC coding if available
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriLOINC Coding System
Fixed Value: http://loinc.org
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeLOINC
...... display S0..1stringLOINC Display Name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... coding S0..1CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriLocal Coding System
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeLocal Code
...... display S0..1stringLocal Code Display name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... text 0..1stringPlain text representation of the concept
.... specimen S0..*SpecimenIf this item relates to specific specimens
.... status S1..1codeproposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required, not extensible)
.... event 0..*Events specific to this item

XML Template

JSON Template

todo

Differential View

This structure is derived from DiagnosticOrder.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 1..1
... text S1..1
.... status S1..1codeFixed Value: generated
... subject S1..1patient-daf-dafpatient
... orderer S1..1
... identifier Slice: Ordered, Closed, by identifier.label
... identifier S1..1Identifier
.... use S1..1codeFixed Value: official
.... label S1..1stringFixed Value: Placer Order Number
.... system S1..1Placer URI
.... value S1..1Placer Identifier
... identifier S0..1Identifier
.... use S1..1codeFixed Value: official
.... label S1..1stringFixed Value: Filler Order Number
.... system S1..1Filler URI
.... value S1..1Filler Identifier
... encounter S1..1encounter-daf-dafencounter
... clinicalNotes S0..1
... supportingInformation S0..*observation-daf-results-dafresultobservationcode, observation-daf-results-dafresultobsquantity, observation-daf-results-dafresultobsratio, observation-daf-results-dafresultobsother
... specimen S0..*
... status S1..1
... priority S1..1
... event S1..*
.... description S1..1Binding: USLABDOEvent (required, extensible)
..... coding S1..1
...... code S1..1
.... dateTime S1..1
... item S1..*
.... code S I1..1US Realm Laboratory Report Order Code
inv-1: Must have a LOINC or a Local code or both.
..... coding Slice: Unordered, Open, by system
..... coding S I0..1LOINC coding if available
...... system S1..1uriLOINC Coding System
Fixed Value: http://loinc.org
...... code S1..1LOINC
...... display S0..1LOINC Display Name
..... coding S I0..1
...... system S1..1uriLocal Coding System
...... code S1..1Local Code
...... display S0..1Local Code Display name
.... specimen S0..*
.... bodySite[x] 0..0
.... status S1..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 1..1A request for a diagnostic service
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... subject S1..1patient-daf-dafpatientWho and/or what test is about
... orderer S1..1PractitionerWho ordered the test
... identifier IdentifierIdentifiers assigned to this order
Slice: Ordered, Closed, by identifier.label
... identifier S1..1IdentifierIdentifiers assigned to this order
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
Fixed Value: official
.... label S1..1stringDescription of identifier
Fixed Value: Placer Order Number
.... system S1..1uriPlacer URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringPlacer Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... identifier S0..1IdentifierIdentifiers assigned to this order
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
Fixed Value: official
.... label S1..1stringDescription of identifier
Fixed Value: Filler Order Number
.... system S1..1uriFiller URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringFiller Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... encounter S1..1encounter-daf-dafencounterThe encounter that this diagnostic order is associated with
... clinicalNotes S0..1stringExplanation/Justification for test
... supportingInformation S0..*observation-daf-results-dafresultobservationcode, observation-daf-results-dafresultobsquantity, observation-daf-results-dafresultobsratio, observation-daf-results-dafresultobsotherAdditional clinical information
... specimen S0..*SpecimenIf the whole order relates to specific specimens
... status S1..1codeproposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required, not extensible)
... priority S1..1coderoutine | urgent | stat | asap
Binding: DiagnosticOrderPriority (required, not extensible)
... event S1..*A list of events of interest in the lifecycle
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeproposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required, not extensible)
.... description S1..1CodeableConceptMore information about the event and its context
Binding: USLABDOEvent (required, extensible)
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..1CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system 0..1uriIdentity of the terminology system
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSymbol in syntax defined by the system
...... display 0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... text 0..1stringPlain text representation of the concept
.... dateTime S1..1dateTimeThe date at which the event happened
.... actor 0..1Practitioner, DeviceWho recorded or did this
... item S1..*The items the orderer requested
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... code S I1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: DiagnosticRequests (preferred, extensible)
inv-1: Must have a LOINC or a Local code or both.
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding CodingCode defined by a terminology system
Slice: Unordered, Open, by system
..... coding S0..1CodingLOINC coding if available
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriLOINC Coding System
Fixed Value: http://loinc.org
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeLOINC
...... display S0..1stringLOINC Display Name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... coding S0..1CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriLocal Coding System
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeLocal Code
...... display S0..1stringLocal Code Display name
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... text 0..1stringPlain text representation of the concept
.... specimen S0..*SpecimenIf this item relates to specific specimens
.... status S1..1codeproposed | planned | requested | received | accepted | in-progress | review | completed | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required, not extensible)
.... event 0..*Events specific to this item

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
DiagnosticOrder.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DiagnosticOrder.text.statusNarrativeStatusrequiredNarrativeStatus
DiagnosticOrder.identifier.useIdentifierUserequiredIdentifierUse
DiagnosticOrder.identifier.useIdentifierUserequiredIdentifierUse
DiagnosticOrder.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus
DiagnosticOrder.priorityDiagnosticOrderPriorityrequiredDiagnosticOrderPriority
DiagnosticOrder.event.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus
DiagnosticOrder.event.descriptionUSLABDOEventrequired (extensible)USLAB Diagnostic Order Event Codes
DiagnosticOrder.item.codeDiagnosticRequestspreferred (extensible)LOINC Diagnostic Order Codes
DiagnosticOrder.item.bodySite[x]BodySiteexample (extensible)SNOMED CT Body Structures
DiagnosticOrder.item.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus

Constraints

IdPathNameDetails
txt-2DiagnosticOrder.text.divThe narrative SHALL have some non-whitespace content
XPath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]
txt-1DiagnosticOrder.text.divThe narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))])
txt-3DiagnosticOrder.text.divThe narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])
inv-1DiagnosticOrder.item.codeLOINC or LocalMust have a LOINC or a Local code or both.
XPath: exists(f:coding)
.