Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). 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 GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

Todo.

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.

XML Template

<SubstanceReferenceInformation xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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 from both R4 and R4B

SubstanceReferenceInformation
SubstanceReferenceInformation.classification
  • Deleted (attributes moved to SubstanceDefinition resource, then subtype removed (use classification), source renamed to informationSource)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

XML Template

<SubstanceReferenceInformation xmlns="http://hl7.org/fhir"> doco
 <!-- 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

{doco
  "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/> .doco


[ 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 from both R4 and R4B

SubstanceReferenceInformation
SubstanceReferenceInformation.classification
  • Deleted (attributes moved to SubstanceDefinition resource, then subtype removed (use classification), source renamed to informationSource)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B 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

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)