This page is part of the HSPC FHIR Implementation Guide (v0.1.0: Daft For Comment Draft) based on FHIR v1.9.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticRequest | 0..* | |||
encounter | Reference(Profile hspc-genencounter) | |||
event | 1..* | |||
actor | 1..1 | |||
priority | 1..1 | |||
status | 1..1 | code | ||
code | 1..1 | CodeableConcept | Binding: HSPC LOINC Orderable Codes (preferred) | |
subject | 1..1 | Reference(Profile hspc-patient) | ||
requester | 0..1 | Reference(Profile hspc-provpract) | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticRequest | 0..* | A request for a diagnostic service | ||
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: Common Languages (extensible) | |
text | I | 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 |
identifier | ∑ | 0..* | Identifier | Identifiers assigned to this order |
definition | ∑ | 0..* | Reference(Resource) | Protocol or definition |
basedOn | ∑ | 0..* | Reference(Resource) | What request fulfills |
replaces | ∑ | 0..* | Reference(Resource) | What request replaces |
requisition | ∑ | 0..1 | Identifier | Identifier of composite request |
status | ?! | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) |
stage | ?! ∑ | 1..1 | CodeableConcept | proposal | plan | orig. order | encoded + Binding: DiagnosticRequestStage (extensible) |
code | 1..1 | CodeableConcept | What’s being requested/ordered Binding: HSPC LOINC Orderable Codes (preferred) | |
subject | 1..1 | Reference(Profile hspc-patient) | Information about an individual or animal receiving health care services | |
context | ∑ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode during which request was created |
occurrence[x] | ∑ | 0..1 | dateTime, Period, Timing | When testing should occur |
authored | ∑ | 0..1 | dateTime | Date request signed |
requester | 0..1 | Reference(Profile hspc-provpract) | A person with a formal responsibility in the provisioning of healthcare or related services | |
performerType | ∑ | 0..1 | CodeableConcept | Performer role Binding: Participant Roles (example) |
performer | ∑ | 0..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson) | Requested perfomer |
reason | ∑ | 0..* | CodeableConcept | Explanation/Justification for test Binding: Condition/Problem/Diagnosis Codes (example) |
supportingInformation | 0..* | Reference(Resource) | Additional clinical information | |
note | 0..* | Annotation | Comments | |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
DiagnosticRequest(HSPC Lab Order) | |
Definition | A record of a request for a diagnostic investigation service to be performed. |
Control | 0..* |
DiagnosticRequest.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
DiagnosticRequest.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
DiagnosticRequest.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
DiagnosticRequest.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
DiagnosticRequest.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
DiagnosticRequest.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
DiagnosticRequest.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
DiagnosticRequest.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
DiagnosticRequest.identifier | |
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
Control | 0..* |
Type | Identifier |
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the notes section below. |
DiagnosticRequest.definition | |
Definition | Protocol or definition followed by this request. |
Control | 0..* |
Type | Reference(Resource) |
DiagnosticRequest.basedOn | |
Definition | Plan/proposal/order fulfilled by this request. |
Control | 0..* |
Type | Reference(Resource) |
DiagnosticRequest.replaces | |
Definition | The request takes the place of the referenced completed or terminated request(s). |
Control | 0..* |
Type | Reference(Resource) |
DiagnosticRequest.requisition | |
Definition | Composite request this is part of. |
Control | 0..1 |
Type | Identifier |
DiagnosticRequest.status | |
Definition | The status of the order. |
Control | 1..1 |
Binding | The status of a diagnostic order. The codes SHALL be taken from RequestStatus |
Type | code |
Is Modifier | true |
Comments | Typically the system placing the order sets the status to "requested". Thereafter, the order is maintained by the receiver that updates the status as the request is handled. |
DiagnosticRequest.stage | |
Definition | Whether the request is a proposal, plan, an original order or a reflex order. |
Control | 1..1 |
Binding | The kind of diagnostic request The codes SHALL be taken from DiagnosticRequestStage; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Is Modifier | true |
DiagnosticRequest.code | |
Definition | A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested. |
Control | 1..1 |
Type | CodeableConcept |
Comments | Many laboratory tests and radiology tests embed the specimen/organ system in the test name, for example, serum or serum/plasma glucose, or a chest xray. The specimen may not be recorded separately from the test code. |
DiagnosticRequest.subject | |
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
Control | 1..1 |
Type | Reference(Profile hspc-patient) |
Alternate Names | SubjectOfCare Client Resident |
DiagnosticRequest.context | |
Definition | An encounter or episode of care that provides additional information about the healthcare context in which this request is made. |
Control | 0..1 |
Type | Choice of: Reference(Encounter), Reference(EpisodeOfCare) |
DiagnosticRequest.occurrence[x] | |
Definition | The date/time at which the diagnostic testing should occur. |
Control | 0..1 |
Type | Choice of: dateTime, Period, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
DiagnosticRequest.authored | |
Definition | When the request transitioned to being actionable. |
Control | 0..1 |
Type | dateTime |
DiagnosticRequest.requester | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Control | 0..1 |
Type | Reference(Profile hspc-provpract) |
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual? |
DiagnosticRequest.performerType | |
Definition | Desired type of performer for doing the diagnostic testing. (. |
Control | 0..1 |
Binding | Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. For example codes, see Participant Roles |
Type | CodeableConcept |
Comments | this is a role, not aparticipation type. I.e. doesn’t describe the task, describes the capacity. Examples “compounding pharmacy” or “psychiatrist” or “internal referral”. |
DiagnosticRequest.performer | |
Definition | The desired perfomer for doing the diagnostic testing. |
Control | 0..1 |
Type | Choice of: Reference(Practitioner), Reference(Organization), Reference(Patient), Reference(Device), Reference(RelatedPerson) |
Comments | Use the standard XXX extension for listing alternative alternative performers and/or roles and/or preference. |
DiagnosticRequest.reason | |
Definition | An explanation or justification for why this diagnostic investigation is being requested. This is often for billing purposes. May relate to the resources referred to in supportingInformation. |
Control | 0..* |
Binding | Diagnosis or problem codes justifying the reason for requesting the diagnostic investigation. For example codes, see Condition/Problem/Diagnosis Codes |
Type | CodeableConcept |
Comments | This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all. Use CodeableConcept text element if the data is free (uncoded) text as shown in the CT Scan example. |
DiagnosticRequest.supportingInformation | |
Definition | Additional clinical information about the patient or specimen that may influence test interpretations. This includes observations explicitly requested by the producer(filler) to provide context or supporting information needed to complete the order. |
Control | 0..* |
Type | Reference(Resource) |
Alternate Names | Ask at order entry question, AOE |
Comments | This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". Examples include reporting the amount of inspired oxygen for blood gasses, the point in the menstrual cycle for cervical pap tests, and other conditions that influence test interpretations. |
DiagnosticRequest.note | |
Definition | Any other notes and comments made about the service request. (e.g. "patient hates needles"). |
Control | 0..* |
Type | Annotation |
DiagnosticRequest.relevantHistory | |
Definition | Key events in the history of the request. |
Control | 0..* |
Type | Reference(Provenance) |
Comments | This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |