HL7 FHIR Implementation Guide: Profiles for Transfusion and Vaccination Adverse Event Detection and Reporting
1.0.1 - STU 1 Technical Correction
HL7 FHIR Implementation Guide: Profiles for Transfusion and Vaccination Adverse Event Detection and Reporting
1.0.1 - STU 1 Technical Correction
This page is part of the Profiles for ICSR Transfusion and Vaccination Adverse Event Detection and Reporting (v1.0.1: STU 1 Update) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Draft as of 2023-08-29 |
XML representation of the icsr-ext-previouscaseidentifier extension.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="icsr-ext-previouscaseidentifier"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">Placeholder</div>
</text>
<url
value="http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-previouscaseidentifier"/>
<version value="1.0.1"/>
<name value="PreviousCaseIdentifier"/>
<status value="draft"/>
<date value="2023-08-29T21:18:01+00:00"/>
<publisher value="Biomedical Research & Regulation WG"/>
<contact>
<name value="Biomedical Research & Regulation WG"/>
<telecom>
<system value="url"/>
<value value="http://hl7.org/Special/committees/rcrim"/>
</telecom>
</contact>
<contact>
<name value="Jean Duteau"/>
<telecom>
<system value="email"/>
<value value="mailto:jean.duteau@ibm.com"/>
</telecom>
</contact>
<description value="Previous identifiers used to reference this case"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="complex-type"/>
<abstract value="false"/>
<context>
<type value="element"/>
<expression value="Composition"/>
</context>
<type value="Extension"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/>
<derivation value="constraint"/>
<snapshot>
<element id="Extension">
<path value="Extension"/>
<short value="Extension"/>
<definition value="Previous identifiers used to reference this case"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Extension"/>
<min value="0"/>
<max value="*"/>
</base>
<condition value="ele-1"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
</element>
<element id="Extension.id">
<path value="Extension.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Extension.extension">
<path value="Extension.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Extension"/>
<definition value="An Extension"/>
<min value="0"/>
<max value="0"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Extension.url">
<path value="Extension.url"/>
<representation value="xmlAttr"/>
<short value="identifies the meaning of the extension"/>
<definition
value="Source of the definition for the extension code - a logical name or a URL."/>
<comment
value="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 SHALL be a URI for the Structure Definition defining the extension."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<fixedUri
value="http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-previouscaseidentifier"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]"/>
<short value="Value of extension"/>
<definition
value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list)."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Extension.value[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Identifier"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Extension.value[x].id">
<path value="Extension.value[x].id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Extension.value[x].extension">
<path value="Extension.value[x].extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<short value="Additional content defined by implementations"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Extension.value[x].use">
<path value="Extension.value[x].use"/>
<short value="usual | official | temp | secondary | old (If known)"/>
<definition value="The purpose of this identifier."/>
<comment
value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary."/>
<requirements
value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.use"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one."/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierUse"/>
</extension>
<strength value="required"/>
<description
value="Identifies the purpose for this identifier, if known ."/>
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="N/A"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.code or implied by context"/>
</mapping>
</element>
<element id="Extension.value[x].type">
<path value="Extension.value[x].type"/>
<short value="Description of identifier"/>
<definition
value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose."/>
<comment
value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type."/>
<requirements
value="Allows users to make use of identifiers when the identifier system is not known."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.type"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierType"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
<valueBoolean value="true"/>
</extension>
<strength value="extensible"/>
<description
value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."/>
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-type"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="CX.5"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.code or implied by context"/>
</mapping>
</element>
<element id="Extension.value[x].system">
<path value="Extension.value[x].system"/>
<short value="The namespace for the identifier value"/>
<definition
value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique."/>
<comment value="Identifier.system is always case sensitive."/>
<requirements
value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Identifier.system"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<patternUri value="urn:oid:2.16.840.1.113883.3.989.2.1.3.3"/>
<example>
<label value="General"/>
<valueUri value="http://www.acme.com/identifiers/patient"/>
</example>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.4 / EI-2-4"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="II.root or Role.id.root"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./IdentifierType"/>
</mapping>
</element>
<element id="Extension.value[x].value">
<path value="Extension.value[x].value"/>
<short value="The value that is unique"/>
<definition
value="The portion of the identifier typically relevant to the user and which is unique within the context of the system."/>
<comment
value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Identifier.value"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<example>
<label value="General"/>
<valueString value="123456"/>
</example>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.1 / EI.1"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./Value"/>
</mapping>
</element>
<element id="Extension.value[x].period">
<path value="Extension.value[x].period"/>
<short value="Time period when id is/was valid for use"/>
<definition
value="Time period during which identifier is/was valid for use."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Identifier.period"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Period"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.7 + CX.8"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Role.effectiveTime or implied by context"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./StartDate and ./EndDate"/>
</mapping>
</element>
<element id="Extension.value[x].assigner">
<path value="Extension.value[x].assigner"/>
<short value="Organization that issued id (may be just text)"/>
<definition value="Organization that issued/manages the identifier."/>
<comment
value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Identifier.assigner"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Organization"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="v2"/>
<map value="CX.4 / (CX.4,CX.9,CX.10)"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"/>
</mapping>
<mapping>
<identity value="servd"/>
<map value="./IdentifierIssuingAuthority"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Extension">
<path value="Extension"/>
<definition value="Previous identifiers used to reference this case"/>
</element>
<element id="Extension.extension">
<path value="Extension.extension"/>
<max value="0"/>
</element>
<element id="Extension.url">
<path value="Extension.url"/>
<fixedUri
value="http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-previouscaseidentifier"/>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]"/>
<min value="1"/>
<type>
<code value="Identifier"/>
</type>
<mustSupport value="true"/>
</element>
<element id="Extension.value[x].system">
<path value="Extension.value[x].system"/>
<min value="1"/>
<patternUri value="urn:oid:2.16.840.1.113883.3.989.2.1.3.3"/>
</element>
<element id="Extension.value[x].value">
<path value="Extension.value[x].value"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Extension.value[x].assigner">
<path value="Extension.value[x].assigner"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>
IG © 2020+ Biomedical Research & Regulation WG. Package hl7.fhir.us.icsr-ae-reporting#1.0.1 based on FHIR 4.0.1. Generated 2023-08-29
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change