DSTU2 Ballot Source

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

4.22.12.2 StructureDefinition: USLabDO

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/do-uslab-uslabdo

Constraints and extensions for the US Realm laboratory ordering in ambulatory care setting

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.

4.22.12.2.1 Formal Views of Profile Content

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

This structure is derived from DiagnosticOrder.

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 1..1DiagnosticOrderA request for a diagnostic service
... 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: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... uslabcc-practitioner S0..*PractitionerCopy to provider,organization, or patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueReference S0..*pract-uslab-uslabpractValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... subject S Σ1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientWho and/or what test is about
... orderer S Σ1..1pract-uslab-uslabphpract, pract-uslab-uslabpractWho ordered the test
... identifier S Σ1..1IdentifierIdentifiers assigned to this order
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... 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)
... encounter Σ0..1EncounterThe encounter that this diagnostic order is associated with
... clinicalNotes S0..1stringExplanation/Justification for test
... supportingInformation Observation, Condition, DocumentReferenceAdditional clinical information
Slice: Unordered, Open, by @Profile, @type
... supportingInformation S0..*obs-uslab-uslabobscode, obs-uslab-uslabobsquantity, obs-uslab-uslabobsother, obs-uslab-uslabobsratio, obs-uslab-uslabobspanel, cond-uslab-uslabcond, DocumentReferenceAdditional clinical information
... specimen S0..*spec-uslab-uslabspecIf the whole order relates to specific specimens
... status ?! SΣ1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required)
... priority S Σ1..1coderoutine | urgent | stat | asap
Binding: DiagnosticOrderPriority (required)
... event S1..*A list of events of interest in the lifecycle
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... status Σ1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required)
.... description S Σ1..1CodeableConceptMore information about the event and its context
Binding: USLABDOEvent (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..*CodingCode defined by a terminology system
...... 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 0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
..... text 0..1stringPlain text representation of the concept
.... dateTime S ΣI1..1dateTimeThe date at which the event happened
inv-2: Datetime must be at least to day.
.... actor 0..1Practitioner, DeviceWho recorded or did this
... item S1..*The items the orderer requested
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code S Σ1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: USLabObservationName (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..*CodingCode defined by a terminology system
...... 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
...... primary 0..1booleanIf this code was chosen directly by the user
..... text S0..1stringPlain text representation of the concept
.... specimen S0..*spec-uslab-uslabspecIf this item relates to specific specimens
.... status S Σ1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required)
.... event Σ0..*Events specific to this item

todo

Differential View

This structure is derived from DiagnosticOrder.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticOrder 1..1DiagnosticOrderA request for a diagnostic service
... 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: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... uslabcc-practitioner S0..*PractitionerCopy to provider,organization, or patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueReference S0..*pract-uslab-uslabpractValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... subject S Σ1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientWho and/or what test is about
... orderer S Σ1..1pract-uslab-uslabphpract, pract-uslab-uslabpractWho ordered the test
... identifier S Σ1..1IdentifierIdentifiers assigned to this order
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
Fixed Value: official
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... 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)
... encounter Σ0..1EncounterThe encounter that this diagnostic order is associated with
... clinicalNotes S0..1stringExplanation/Justification for test
... supportingInformation Observation, Condition, DocumentReferenceAdditional clinical information
Slice: Unordered, Open, by @Profile, @type
... supportingInformation S0..*obs-uslab-uslabobscode, obs-uslab-uslabobsquantity, obs-uslab-uslabobsother, obs-uslab-uslabobsratio, obs-uslab-uslabobspanel, cond-uslab-uslabcond, DocumentReferenceAdditional clinical information
... specimen S0..*spec-uslab-uslabspecIf the whole order relates to specific specimens
... status ?! SΣ1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required)
... priority S Σ1..1coderoutine | urgent | stat | asap
Binding: DiagnosticOrderPriority (required)
... event S1..*A list of events of interest in the lifecycle
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... status Σ1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required)
.... description S Σ1..1CodeableConceptMore information about the event and its context
Binding: USLABDOEvent (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..*CodingCode defined by a terminology system
...... 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 0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
..... text 0..1stringPlain text representation of the concept
.... dateTime S ΣI1..1dateTimeThe date at which the event happened
inv-2: Datetime must be at least to day.
.... actor 0..1Practitioner, DeviceWho recorded or did this
... item S1..*The items the orderer requested
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code S Σ1..1CodeableConceptUS Realm Laboratory Report Order Code
Binding: USLabObservationName (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S1..*CodingCode defined by a terminology system
...... 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
...... primary 0..1booleanIf this code was chosen directly by the user
..... text S0..1stringPlain text representation of the concept
.... specimen S0..*spec-uslab-uslabspecIf this item relates to specific specimens
.... status S Σ1..1codeproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
Binding: DiagnosticOrderStatus (required)
.... event Σ0..*Events specific to this item

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

4.22.12.2.2 Terminology Bindings

PathNameConformanceValueSet
DiagnosticOrder.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
DiagnosticOrder.identifier.useIdentifierUserequiredIdentifierUse
DiagnosticOrder.identifier.typeIdentifierTypeextensibleIdentifier Type Codes
DiagnosticOrder.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus
DiagnosticOrder.priorityDiagnosticOrderPriorityrequiredDiagnosticOrderPriority
DiagnosticOrder.event.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus
DiagnosticOrder.event.descriptionUSLABDOEventextensibleUSLAB Diagnostic Order Event Codes
DiagnosticOrder.item.codeUSLabObservationNameextensibleUS Laboratory Observation Profile Observation Name Codes
DiagnosticOrder.item.statusDiagnosticOrderStatusrequiredDiagnosticOrderStatus

4.22.12.2.3 Constraints

IdPathNameDetails
inv-2DiagnosticOrder.event.dateTimedatetime to DayDatetime must be at least to day.
XPath: f:matches(dateTime,/\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/)
.