FHIR for FAIR - FHIR Implementation Guide
0.1.0 - STU 1 Ballot
FHIR for FAIR - FHIR Implementation Guide
0.1.0 - STU 1 Ballot
This page is part of the FHIR for FAIR - FHIR Implementation Guide (v0.1.0: STU 1 (FHIR R4b) Ballot 1) based on FHIR v4.1.0. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
XML representation of the RelatedArtifact-uv-f4f data type profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="RelatedArtifact-uv-f4f"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/2021Mar/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2021Mar/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-RelatedArtifact-uv-f4f-definitions.html#RelatedArtifact">RelatedArtifact</a><a name="RelatedArtifact"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/metadatatypes.html#RelatedArtifact">RelatedArtifact</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Related artifacts for a knowledge resource</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck14.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_slice_item.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Slice Item" class="hierarchy"/> <a href="StructureDefinition-RelatedArtifact-uv-f4f-definitions.html#RelatedArtifact.extension:classifier" title="Extension URL = http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier">relatedArtifactClassifier</a><a name="RelatedArtifact.extension"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Classifier (RelatedArtifact)</span><br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/2021Mar/StructureDefinition-relatedArtifactClassifier.html">http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier</a></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck04.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_slice_item.png" alt="." style="background-color: white; background-color: inherit" title="Slice Item" class="hierarchy"/> <a href="StructureDefinition-RelatedArtifact-uv-f4f-definitions.html#RelatedArtifact.extension:resourceReference" title="Extension URL = http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference">relatedArtifactResourceReference</a><a name="RelatedArtifact.extension"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2021Mar/references.html">Reference</a>(<a href="http://hl7.org/fhir/2021Mar/resource.html">Resource</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">ResourceReference (RelatedArtifact)</span><br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/2021Mar/StructureDefinition-relatedArtifactResourceReference.html">http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference</a></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/2021Mar/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2021Mar/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<url
value="http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/RelatedArtifact-uv-f4f"/>
<version value="0.1.0"/>
<name value="RelatedArtifactF4F"/>
<title value="RelatedArtifact (FHIR for FAIR)"/>
<status value="active"/>
<date value="2021-12-05T00:01:34+00:00"/>
<publisher value="Health Level Seven International - SOA Work Group"/>
<contact>
<name value="Health Level Seven International - SOA Work Group"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/soa"/>
</telecom>
</contact>
<contact>
<name value="HL7 SOA Work Group"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/soa"/>
</telecom>
</contact>
<description
value="This profile enhances the current RelatedArtifact data with the enhancements identified in FHIR R5"/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<fhirVersion value="4.1.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="complex-type"/>
<abstract value="false"/>
<type value="RelatedArtifact"/>
<baseDefinition
value="http://hl7.org/fhir/StructureDefinition/RelatedArtifact"/>
<derivation value="constraint"/>
<snapshot>
<element id="RelatedArtifact">
<path value="RelatedArtifact"/>
<short value="Related artifacts for a knowledge resource"/>
<definition
value="Related artifacts such as additional documentation, justification, or bibliographic references."/>
<comment
value="Each related artifact is either an attachment, or a reference to another knowledge resource, but not both."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RelatedArtifact"/>
<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 unless an empty Parameters resource"/>
<expression
value="hasValue() or (children().count() > id.count()) or $this is Parameters"/>
<xpath value="@value|f:*|h:div|self::f:Parameters"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RelatedArtifact.id">
<path value="RelatedArtifact.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">
<valueUri 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="RelatedArtifact.extension">
<path value="RelatedArtifact.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="RelatedArtifact.extension:classifier">
<path value="RelatedArtifact.extension"/>
<sliceName value="classifier"/>
<short value="Classifier (RelatedArtifact)"/>
<definition
value="This extension enanches the current RelatedArtifact data type with the classifier element as specified in R5"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier"/>
</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="RelatedArtifact.extension:resourceReference">
<path value="RelatedArtifact.extension"/>
<sliceName value="resourceReference"/>
<short value="ResourceReference (RelatedArtifact)"/>
<definition
value="This extension enanches the current RelatedArtifact data type allowing to reference FHIR resources"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference"/>
</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="RelatedArtifact.type">
<path value="RelatedArtifact.type"/>
<short
value="documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of"/>
<definition value="The type of relationship to the related artifact."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="RelatedArtifact.type"/>
<min value="1"/>
<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="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/build/StructureDefinition/definition">
<valueString value="The type of relationship to the related artifact."/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="RelatedArtifactType"/>
</extension>
<strength value="required"/>
<valueSet
value="http://hl7.org/fhir/ValueSet/related-artifact-type|4.1.0"/>
</binding>
</element>
<element id="RelatedArtifact.label">
<path value="RelatedArtifact.label"/>
<short value="Short label"/>
<definition
value="A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedArtifact.label"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</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"/>
</element>
<element id="RelatedArtifact.display">
<path value="RelatedArtifact.display"/>
<short value="Brief description of the related artifact"/>
<definition
value="A brief description of the document or knowledge resource being referenced, suitable for display to a consumer."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedArtifact.display"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</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"/>
</element>
<element id="RelatedArtifact.citation">
<path value="RelatedArtifact.citation"/>
<short value="Bibliographic citation for the artifact"/>
<definition
value="A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format."/>
<comment
value="Additional structured information about citations should be captured as extensions."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedArtifact.citation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="markdown"/>
</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"/>
</element>
<element id="RelatedArtifact.url">
<path value="RelatedArtifact.url"/>
<short value="Where the artifact can be accessed"/>
<definition
value="A url for the artifact that can be followed to access the actual content."/>
<comment
value="If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedArtifact.url"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="url"/>
</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"/>
</element>
<element id="RelatedArtifact.document">
<path value="RelatedArtifact.document"/>
<short value="What document is being referenced"/>
<definition
value="The document being referenced, represented as an attachment. This is exclusive with the resource element."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedArtifact.document"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Attachment"/>
</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"/>
</element>
<element id="RelatedArtifact.resource">
<path value="RelatedArtifact.resource"/>
<short value="What resource is being referenced"/>
<definition
value="The related resource, such as a library, value set, profile, or other knowledge resource."/>
<comment
value="If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="RelatedArtifact.resource"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="canonical"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/>
</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"/>
</element>
</snapshot>
<differential>
<element id="RelatedArtifact">
<path value="RelatedArtifact"/>
</element>
<element id="RelatedArtifact.extension:classifier">
<path value="RelatedArtifact.extension"/>
<sliceName value="classifier"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactClassifier"/>
</type>
</element>
<element id="RelatedArtifact.extension:resourceReference">
<path value="RelatedArtifact.extension"/>
<sliceName value="resourceReference"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Extension"/>
<profile
value="http://hl7.org/fhir/uv/fhir-for-fair/StructureDefinition/relatedArtifactResourceReference"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2020+ Health Level Seven International - SOA Work Group. Package hl7.fhir.uv.fhir-for-fair#0.1.0 based on FHIR 4.1.0. Generated 2021-12-05
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change