Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Extension: relatesTo

Biomedical Research and Regulation Work Group Maturity Level: 0InformativeUse 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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. relatesTo0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo
relatesTo: The relationship of other objects and systems to a study.


Use on Element ID ResearchStudy
... relationshipType1..1CodeableConceptDescribes the relationship of the artefact to the Research Study.

... targetClassifier0..*CodeableConceptDescribes the access to the artefact.

... target1..1uri, Identifier, Attachment, Reference(Practitioner | PractitionerRole)Identification of the target artifact.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo
relatesTo: The relationship of other objects and systems to a study.


Use on Element ID ResearchStudy
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:relationshipType 1..1Extensionreplaces | 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"relationshipType"
.... value[x] 1..1CodeableConceptValue of extension
Binding: ???? (required): Possible relationships between an artefact and a Research Study.

... extension:targetClassifier 0..*ExtensionExpanded-Access | Available | No-longer-available | Termporarily-not-available | Approved-for-marketing
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"targetClassifier"
.... value[x] 1..1CodeableConceptValue of extension
Binding: ???? (example): Example classification of artefacts related to a Research Study.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1Value of extension
..... valueUriuri
..... valueIdentifierIdentifier
..... valueAttachmentAttachment
..... valueReferenceReference(Practitioner | PractitionerRole)
... extension:description 0..1ExtensionShort explanation of study path
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"description"
.... value[x] 1..1markdownValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- relatesTo -->doco

<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

NameFlagsCard.TypeDescription & Constraintsdoco
.. relatesTo0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo
relatesTo: The relationship of other objects and systems to a study.


Use on Element ID ResearchStudy
... relationshipType1..1CodeableConceptDescribes the relationship of the artefact to the Research Study.

... targetClassifier0..*CodeableConceptDescribes the access to the artefact.

... target1..1uri, Identifier, Attachment, Reference(Practitioner | PractitionerRole)Identification of the target artifact.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/researchStudy-relatesTo
relatesTo: The relationship of other objects and systems to a study.


Use on Element ID ResearchStudy
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:relationshipType 1..1Extensionreplaces | 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"relationshipType"
.... value[x] 1..1CodeableConceptValue of extension
Binding: ???? (required): Possible relationships between an artefact and a Research Study.

... extension:targetClassifier 0..*ExtensionExpanded-Access | Available | No-longer-available | Termporarily-not-available | Approved-for-marketing
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"targetClassifier"
.... value[x] 1..1CodeableConceptValue of extension
Binding: ???? (example): Example classification of artefacts related to a Research Study.

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1Value of extension
..... valueUriuri
..... valueIdentifierIdentifier
..... valueAttachmentAttachment
..... valueReferenceReference(Practitioner | PractitionerRole)
... extension:description 0..1ExtensionShort explanation of study path
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"description"
.... value[x] 1..1markdownValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- relatesTo -->doco

<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)