This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: relatesTo

Biomedical Research and Regulation Work Group

Maturity Level: 0

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo

Status: draft. Extension maintained by: HL7

The relationship of other objects and systems to a study.

Comment:

RelatedArtefact and partOf must be considered first.

Context of Use: Use on Element ID ResearchStudy

Summary

Name	Card.	Type	Description & Constraints
relatesTo	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo relatesTo: The relationship of other objects and systems to a study. Use on Element ID ResearchStudy
relationshipType	1..1	CodeableConcept	Describes the relationship of the artefact to the Research Study.
targetClassifier	0..*	CodeableConcept	Describes the access to the artefact.
target	1..1	uri, Identifier, Attachment, Reference(Practitioner \| PractitionerRole)	Identification of the target artifact.
description	0..1	markdown	A succinct description of the path through the study that would be followed by a subject adhering to this arm.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo relatesTo: The relationship of other objects and systems to a study. Use on Element ID ResearchStudy
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:relationshipType	1..1	Extension	replaces \| amends \| appends \| transforms \| replaced-with \| amended-with \| appended-with \| transformed-with \| derived-from \| transformed-into \| composed-of \| part-of \| supports \| supported-with \| depends-on \| cites \| cited-by
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"relationshipType"
value[x]	1..1	CodeableConcept	Value of extension Binding: ???? (required): Possible relationships between an artefact and a Research Study.
extension:targetClassifier	0..*	Extension	Expanded-Access \| Available \| No-longer-available \| Termporarily-not-available \| Approved-for-marketing
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"targetClassifier"
value[x]	1..1	CodeableConcept	Value of extension Binding: ???? (example): Example classification of artefacts related to a Research Study.
extension:target	1..1	Extension	Identification of the target artifact
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"target"
value[x]	1..1		Value of extension
valueUri		uri
valueIdentifier		Identifier
valueAttachment		Attachment
valueReference		Reference(Practitioner \| PractitionerRole)
extension:description	0..1	Extension	Short explanation of study path
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"description"
value[x]	1..1	markdown	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
value[x]	0..0
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- relatesTo -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="relationshipType">  1..1 Extension  <!--  1..1 replaces | amends | appends | transforms | replaced-with | amended-with | appended-with | transformed-with | derived-from | transformed-into | composed-of | part-of | supports | supported-with | depends-on | cites | cited-by -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="targetClassifier">  0..* Extension  <!--  0..* Expanded-Access | Available | No-longer-available | Termporarily-not-available | Approved-for-marketing -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="target">  1..1 Extension  <!--  1..1 Identification of the target artifact -->
  <value[x]><!--  1..1 uri|Identifier|Attachment|Reference(Practitioner) 
      Value of extension --></value[x]>
 </extension>
 <extension url="description">  0..1 Extension  <!--  0..1 Short explanation of study path -->
  <valueMarkdown value="[markdown]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // relatesTo
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // replaces | amends | appends | transforms | replaced-with | amended-with | appended-with | transformed-with | derived-from | transformed-into | composed-of | part-of | supports | supported-with | depends-on | cites | cited-by // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationshipType", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // Expanded-Access | Available | No-longer-available | Termporarily-not-available | Approved-for-marketing // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetClassifier", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // Identification of the target artifact // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
// value[x]: Value of extension. One of these 4:
        "valueUri" : "<uri>" // C? R! Value of extension
        "valueIdentifier" : { Identifier }, // C? R! Value of extension
        "valueAttachment" : { Attachment }, // C? R! Value of extension
        "valueReference" : { Reference(Practitioner) }, // C? R! Value of extension
      },
      { // Short explanation of study path // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "description", // R! 
        "valueMarkdown" : "<markdown>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

Name	Card.	Type	Description & Constraints
relatesTo	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo relatesTo: The relationship of other objects and systems to a study. Use on Element ID ResearchStudy
relationshipType	1..1	CodeableConcept	Describes the relationship of the artefact to the Research Study.
targetClassifier	0..*	CodeableConcept	Describes the access to the artefact.
target	1..1	uri, Identifier, Attachment, Reference(Practitioner \| PractitionerRole)	Identification of the target artifact.
description	0..1	markdown	A succinct description of the path through the study that would be followed by a subject adhering to this arm.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo relatesTo: The relationship of other objects and systems to a study. Use on Element ID ResearchStudy
extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:relationshipType	1..1	Extension	replaces \| amends \| appends \| transforms \| replaced-with \| amended-with \| appended-with \| transformed-with \| derived-from \| transformed-into \| composed-of \| part-of \| supports \| supported-with \| depends-on \| cites \| cited-by
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"relationshipType"
value[x]	1..1	CodeableConcept	Value of extension Binding: ???? (required): Possible relationships between an artefact and a Research Study.
extension:targetClassifier	0..*	Extension	Expanded-Access \| Available \| No-longer-available \| Termporarily-not-available \| Approved-for-marketing
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"targetClassifier"
value[x]	1..1	CodeableConcept	Value of extension Binding: ???? (example): Example classification of artefacts related to a Research Study.
extension:target	1..1	Extension	Identification of the target artifact
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"target"
value[x]	1..1		Value of extension
valueUri		uri
valueIdentifier		Identifier
valueAttachment		Attachment
valueReference		Reference(Practitioner \| PractitionerRole)
extension:description	0..1	Extension	Short explanation of study path
id	0..1	string	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"description"
value[x]	1..1	markdown	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-animal"
value[x]	0..0
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- relatesTo -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="relationshipType">  1..1 Extension  <!--  1..1 replaces | amends | appends | transforms | replaced-with | amended-with | appended-with | transformed-with | derived-from | transformed-into | composed-of | part-of | supports | supported-with | depends-on | cites | cited-by -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="targetClassifier">  0..* Extension  <!--  0..* Expanded-Access | Available | No-longer-available | Termporarily-not-available | Approved-for-marketing -->
  <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="target">  1..1 Extension  <!--  1..1 Identification of the target artifact -->
  <value[x]><!--  1..1 uri|Identifier|Attachment|Reference(Practitioner) 
      Value of extension --></value[x]>
 </extension>
 <extension url="description">  0..1 Extension  <!--  0..1 Short explanation of study path -->
  <valueMarkdown value="[markdown]"/><!--  1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // relatesTo
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // replaces | amends | appends | transforms | replaced-with | amended-with | appended-with | transformed-with | derived-from | transformed-into | composed-of | part-of | supports | supported-with | depends-on | cites | cited-by // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "relationshipType", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // Expanded-Access | Available | No-longer-available | Termporarily-not-available | Approved-for-marketing // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "targetClassifier", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // Identification of the target artifact // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
// value[x]: Value of extension. One of these 4:
        "valueUri" : "<uri>" // C? R! Value of extension
        "valueIdentifier" : { Identifier }, // C? R! Value of extension
        "valueAttachment" : { Attachment }, // C? R! Value of extension
        "valueReference" : { Reference(Practitioner) }, // C? R! Value of extension
      },
      { // Short explanation of study path // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "description", // R! 
        "valueMarkdown" : "<markdown>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/patient-animal", // R! 
// value[x]: Value of extension. One of these 51:
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)