R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4

15.13 Resource SubstanceReferenceInformation - Content

Biomedical Research and Regulation icon

Work Group

Maturity Level: 0

Trial Use

Security Category: Anonymous

Compartments: Not linked to any defined compartments

Todo.

15.13.1 Scope and Usage

Note to Implementers: This resource is still undergoing development and review by the appropriate Workgroups. At this time, is considered only as a draft resource not suitable for production implementation.

15.13.2 References to this Resource

Resource References: SubstanceDefinition

Structure

Name	Flags	Card.	Type	Description & Constraints
SubstanceReferenceInformation	TU		DomainResource	Todo Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
comment	Σ	0..1	string	Todo
gene	Σ	0..*	BackboneElement	Todo
geneSequenceOrigin	Σ	0..1	CodeableConcept	Todo
gene	Σ	0..1	CodeableConcept	Todo
source	Σ	0..*	Reference(DocumentReference)	Todo
geneElement	Σ	0..*	BackboneElement	Todo
type	Σ	0..1	CodeableConcept	Todo
element	Σ	0..1	Identifier	Todo
source	Σ	0..*	Reference(DocumentReference)	Todo
target	Σ	0..*	BackboneElement	Todo
target	Σ	0..1	Identifier	Todo
type	Σ	0..1	CodeableConcept	Todo
interaction	Σ	0..1	CodeableConcept	Todo
organism	Σ	0..1	CodeableConcept	Todo
organismType	Σ	0..1	CodeableConcept	Todo
amount[x]	Σ	0..1		Todo
amountQuantity			Quantity
amountRange			Range
amountString			string
amountType	Σ	0..1	CodeableConcept	Todo
source	Σ	0..*	Reference(DocumentReference)	Todo
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<SubstanceReferenceInformation xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <comment value="[string]"/><!-- 0..1 Todo -->
 <gene>  <!-- 0..* Todo -->
  <geneSequenceOrigin><!-- 0..1 CodeableConcept Todo --></geneSequenceOrigin>
  <gene><!-- 0..1 CodeableConcept Todo --></gene>
  <source><!-- 0..* Reference(DocumentReference) Todo --></source>
 </gene>
 <geneElement>  <!-- 0..* Todo -->
  <type><!-- 0..1 CodeableConcept Todo --></type>
  <element><!-- 0..1 Identifier Todo --></element>
  <source><!-- 0..* Reference(DocumentReference) Todo --></source>
 </geneElement>
 <target>  <!-- 0..* Todo -->
  <target><!-- 0..1 Identifier Todo --></target>
  <type><!-- 0..1 CodeableConcept Todo --></type>
  <interaction><!-- 0..1 CodeableConcept Todo --></interaction>
  <organism><!-- 0..1 CodeableConcept Todo --></organism>
  <organismType><!-- 0..1 CodeableConcept Todo --></organismType>
  <amount[x]><!-- 0..1 Quantity|Range|string Todo --></amount[x]>
  <amountType><!-- 0..1 CodeableConcept Todo --></amountType>
  <source><!-- 0..* Reference(DocumentReference) Todo --></source>
 </target>
</SubstanceReferenceInformation>

JSON Template

{
  "resourceType" : "SubstanceReferenceInformation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "comment" : "<string>", // Todo
  "gene" : [{ // Todo
    "geneSequenceOrigin" : { CodeableConcept }, // Todo
    "gene" : { CodeableConcept }, // Todo
    "source" : [{ Reference(DocumentReference) }] // Todo
  }],
  "geneElement" : [{ // Todo
    "type" : { CodeableConcept }, // Todo
    "element" : { Identifier }, // Todo
    "source" : [{ Reference(DocumentReference) }] // Todo
  }],
  "target" : [{ // Todo
    "target" : { Identifier }, // Todo
    "type" : { CodeableConcept }, // Todo
    "interaction" : { CodeableConcept }, // Todo
    "organism" : { CodeableConcept }, // Todo
    "organismType" : { CodeableConcept }, // Todo
    // amount[x]: Todo. One of these 3:
    "amountQuantity" : { Quantity },
    "amountRange" : { Range },
    "amountString" : "<string>",
    "amountType" : { CodeableConcept }, // Todo
    "source" : [{ Reference(DocumentReference) }] // Todo
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:SubstanceReferenceInformation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:comment [ string ] ; # 0..1 Todo
  fhir:gene ( [ # 0..* Todo
    fhir:geneSequenceOrigin [ CodeableConcept ] ; # 0..1 Todo
    fhir:gene [ CodeableConcept ] ; # 0..1 Todo
    fhir:source  ( [ Reference(DocumentReference) ] ... ) ; # 0..* Todo
  ] ... ) ;
  fhir:geneElement ( [ # 0..* Todo
    fhir:type [ CodeableConcept ] ; # 0..1 Todo
    fhir:element [ Identifier ] ; # 0..1 Todo
    fhir:source  ( [ Reference(DocumentReference) ] ... ) ; # 0..* Todo
  ] ... ) ;
  fhir:target ( [ # 0..* Todo
    fhir:target [ Identifier ] ; # 0..1 Todo
    fhir:type [ CodeableConcept ] ; # 0..1 Todo
    fhir:interaction [ CodeableConcept ] ; # 0..1 Todo
    fhir:organism [ CodeableConcept ] ; # 0..1 Todo
    fhir:organismType [ CodeableConcept ] ; # 0..1 Todo
    # amount[x] : 0..1 Todo. One of these 3
      fhir:amount [  a fhir:Quantity ; Quantity ]
      fhir:amount [  a fhir:Range ; Range ]
      fhir:amount [  a fhir:string ; string ]
    fhir:amountType [ CodeableConcept ] ; # 0..1 Todo
    fhir:source  ( [ Reference(DocumentReference) ] ... ) ; # 0..* Todo
  ] ... ) ;
]

Changes since R4

SubstanceReferenceInformation

SubstanceReferenceInformation.classification

deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
SubstanceReferenceInformation	TU		DomainResource	Todo Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
comment	Σ	0..1	string	Todo
gene	Σ	0..*	BackboneElement	Todo
geneSequenceOrigin	Σ	0..1	CodeableConcept	Todo
gene	Σ	0..1	CodeableConcept	Todo
source	Σ	0..*	Reference(DocumentReference)	Todo
geneElement	Σ	0..*	BackboneElement	Todo
type	Σ	0..1	CodeableConcept	Todo
element	Σ	0..1	Identifier	Todo
source	Σ	0..*	Reference(DocumentReference)	Todo
target	Σ	0..*	BackboneElement	Todo
target	Σ	0..1	Identifier	Todo
type	Σ	0..1	CodeableConcept	Todo
interaction	Σ	0..1	CodeableConcept	Todo
organism	Σ	0..1	CodeableConcept	Todo
organismType	Σ	0..1	CodeableConcept	Todo
amount[x]	Σ	0..1		Todo
amountQuantity			Quantity
amountRange			Range
amountString			string
amountType	Σ	0..1	CodeableConcept	Todo
source	Σ	0..*	Reference(DocumentReference)	Todo
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<SubstanceReferenceInformation xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <comment value="[string]"/><!-- 0..1 Todo -->
 <gene>  <!-- 0..* Todo -->
  <geneSequenceOrigin><!-- 0..1 CodeableConcept Todo --></geneSequenceOrigin>
  <gene><!-- 0..1 CodeableConcept Todo --></gene>
  <source><!-- 0..* Reference(DocumentReference) Todo --></source>
 </gene>
 <geneElement>  <!-- 0..* Todo -->
  <type><!-- 0..1 CodeableConcept Todo --></type>
  <element><!-- 0..1 Identifier Todo --></element>
  <source><!-- 0..* Reference(DocumentReference) Todo --></source>
 </geneElement>
 <target>  <!-- 0..* Todo -->
  <target><!-- 0..1 Identifier Todo --></target>
  <type><!-- 0..1 CodeableConcept Todo --></type>
  <interaction><!-- 0..1 CodeableConcept Todo --></interaction>
  <organism><!-- 0..1 CodeableConcept Todo --></organism>
  <organismType><!-- 0..1 CodeableConcept Todo --></organismType>
  <amount[x]><!-- 0..1 Quantity|Range|string Todo --></amount[x]>
  <amountType><!-- 0..1 CodeableConcept Todo --></amountType>
  <source><!-- 0..* Reference(DocumentReference) Todo --></source>
 </target>
</SubstanceReferenceInformation>

JSON Template

{
  "resourceType" : "SubstanceReferenceInformation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "comment" : "<string>", // Todo
  "gene" : [{ // Todo
    "geneSequenceOrigin" : { CodeableConcept }, // Todo
    "gene" : { CodeableConcept }, // Todo
    "source" : [{ Reference(DocumentReference) }] // Todo
  }],
  "geneElement" : [{ // Todo
    "type" : { CodeableConcept }, // Todo
    "element" : { Identifier }, // Todo
    "source" : [{ Reference(DocumentReference) }] // Todo
  }],
  "target" : [{ // Todo
    "target" : { Identifier }, // Todo
    "type" : { CodeableConcept }, // Todo
    "interaction" : { CodeableConcept }, // Todo
    "organism" : { CodeableConcept }, // Todo
    "organismType" : { CodeableConcept }, // Todo
    // amount[x]: Todo. One of these 3:
    "amountQuantity" : { Quantity },
    "amountRange" : { Range },
    "amountString" : "<string>",
    "amountType" : { CodeableConcept }, // Todo
    "source" : [{ Reference(DocumentReference) }] // Todo
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:SubstanceReferenceInformation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:comment [ string ] ; # 0..1 Todo
  fhir:gene ( [ # 0..* Todo
    fhir:geneSequenceOrigin [ CodeableConcept ] ; # 0..1 Todo
    fhir:gene [ CodeableConcept ] ; # 0..1 Todo
    fhir:source  ( [ Reference(DocumentReference) ] ... ) ; # 0..* Todo
  ] ... ) ;
  fhir:geneElement ( [ # 0..* Todo
    fhir:type [ CodeableConcept ] ; # 0..1 Todo
    fhir:element [ Identifier ] ; # 0..1 Todo
    fhir:source  ( [ Reference(DocumentReference) ] ... ) ; # 0..* Todo
  ] ... ) ;
  fhir:target ( [ # 0..* Todo
    fhir:target [ Identifier ] ; # 0..1 Todo
    fhir:type [ CodeableConcept ] ; # 0..1 Todo
    fhir:interaction [ CodeableConcept ] ; # 0..1 Todo
    fhir:organism [ CodeableConcept ] ; # 0..1 Todo
    fhir:organismType [ CodeableConcept ] ; # 0..1 Todo
    # amount[x] : 0..1 Todo. One of these 3
      fhir:amount [  a fhir:Quantity ; Quantity ]
      fhir:amount [  a fhir:Range ; Range ]
      fhir:amount [  a fhir:string ; string ]
    fhir:amountType [ CodeableConcept ] ; # 0..1 Todo
    fhir:source  ( [ Reference(DocumentReference) ] ... ) ; # 0..* Todo
  ] ... ) ;
]

Changes since Release 4

SubstanceReferenceInformation

SubstanceReferenceInformation.classification

deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

15.13.4 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

(No search parameters for this resource)