DSTU2 QA Preview

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

F.??.4 StructureDefinition: QICore-AdverseEvent - Detailed Descriptions

Definitions for the qicore-adverseevent Profile.

Basic(QICore-AdverseEvent)
Definition

An adverse event is any untoward occurrence during treatment that must be reported, for example, to a clinical study sponsor. AEs also include reportable serious medical errors such as those defined by National Quality Forum (see http://www.qualityforum.org/Topics/ SREs/ListofSREs.aspx). Some AEs can involve conditions such as "recurring headaches" but others do not, such as accidental falls, surgical errors, sexual abuse of patient, and sudden death. An adverse event can be caused by exposure to some agent (e.g., a medication, immunization, food, or environmental agent). An adverse reaction can range from a mild reaction, such as a harmless rash to a severe and life-threatening condition. They can occur immediately or develop over time. For example, a patient may develop a rash after taking a particular medication.

Control0..*
TypeBasic
Alternate NamesZ-resource, Extension-resource, Custom-resource
Basic.id
Definition

The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes.

Control0..1
Typeid
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. Bundles always have an id, though it is usually a generated UUID.

Basic.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.

Control0..1
TypeMeta
Basic.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.

Control0..1
Typeuri
Is Modifiertrue
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.

Basic.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
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).

Basic.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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Basic.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.

Control0..*
TypeResource
Alternate Namesinline 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.

Basic.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Basic.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-cause)
Definition

Details about causes for this adverse event. Note that causes may not always exist or be available.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Basic.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Basic.extension.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-cause#item)
Definition

Details about causes for this adverse event. Note that causes may not always exist or be available.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-cause#certainty)
Definition

Details about causes for this adverse event. Note that causes may not always exist or be available.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Basic.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Basic.extension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeChoice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Basic.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-clinicalStudy)
Definition

The NCT numbers of the clinical studies the patient participates in at the time of the adverse event (if available).

Control0..*
TypeExtension (Extension Type: string)
Basic.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-type)
Definition

The adverse event experienced by the patient (primary code).

Control1..1
TypeExtension (Extension Type: CodeableConcept)
Basic.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-period)
Definition

The time period during which the adverse event occurred.

Control0..1
TypeExtension (Extension Type: Period)
Basic.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-severity)
Definition

The severity of the adverse event.

Control0..1
TypeExtension (Extension Type: CodeableConcept)
Basic.extension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-related)
Definition

A condition or intolerance that is related to this adverse event.

Control0..*
TypeExtension (Extension Type: Choice of: Reference(QICore-Condition), Reference(QICore-AllergyIntolerance))
Comments

Added as a suggestion from May 2015 ballot.

Basic.modifierExtension (http://hl7.org/fhir/StructureDefinition/qicore-adverseevent-didNotOccur)
Definition

When true, the resource implies that the adverse event did NOT occur during the stated time period. If true, the severity should not be specified, and the certainty value will be ignored.

Control1..1
TypeExtension (Extension Type: boolean)
Is Modifiertrue
Basic.identifier
Definition

Identifier assigned to the resource for business purposes, outside the context of FHIR.

Control0..*
TypeIdentifier
Basic.code
Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

Control1..1
BindingCodes for identifying types of resources not yet defined by FHIR
For example codes, see Basic Resource Types
TypeCodeableConcept
Is Modifiertrue
Requirements

Must be able to distinguish different types of "basic" resources.

Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

Basic.subject
Definition

The person who has the adverse event.

Control1..1
TypeReference(QICore-Patient)
Must Supporttrue
Requirements

Needed for partitioning the resource by Patient.

Comments

Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Basic.author
Definition

Indicates who was responsible for creating the resource instance.

Control0..1
TypeChoice of: Reference(QICore-Patient), Reference(QICore-RelatedPerson), Reference(QICore-Practitioner)
Requirements

Needed for partitioning the resource.

Basic.created
Definition

Identifies when the resource was first created.

Control0..1
Typedate
Requirements

Allows ordering resource instances by time.