Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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 Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: Not linked to any 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:SubstanceReferenceInformation.comment [ string ]; # 0..1 Todo
  fhir:SubstanceReferenceInformation.gene [ # 0..* Todo
    fhir:SubstanceReferenceInformation.gene.geneSequenceOrigin [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.gene.gene [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.gene.source [ Reference(DocumentReference) ], ... ; # 0..* Todo
  ], ...;
  fhir:SubstanceReferenceInformation.geneElement [ # 0..* Todo
    fhir:SubstanceReferenceInformation.geneElement.type [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.geneElement.element [ Identifier ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.geneElement.source [ Reference(DocumentReference) ], ... ; # 0..* Todo
  ], ...;
  fhir:SubstanceReferenceInformation.target [ # 0..* Todo
    fhir:SubstanceReferenceInformation.target.target [ Identifier ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.type [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.interaction [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.organism [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.organismType [ CodeableConcept ]; # 0..1 Todo
    # SubstanceReferenceInformation.target.amount[x] : 0..1 Todo. One of these 3
      fhir:SubstanceReferenceInformation.target.amountQuantity [ Quantity ]
      fhir:SubstanceReferenceInformation.target.amountRange [ Range ]
      fhir:SubstanceReferenceInformation.target.amountString [ string ]
    fhir:SubstanceReferenceInformation.target.amountType [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.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.

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:SubstanceReferenceInformation.comment [ string ]; # 0..1 Todo
  fhir:SubstanceReferenceInformation.gene [ # 0..* Todo
    fhir:SubstanceReferenceInformation.gene.geneSequenceOrigin [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.gene.gene [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.gene.source [ Reference(DocumentReference) ], ... ; # 0..* Todo
  ], ...;
  fhir:SubstanceReferenceInformation.geneElement [ # 0..* Todo
    fhir:SubstanceReferenceInformation.geneElement.type [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.geneElement.element [ Identifier ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.geneElement.source [ Reference(DocumentReference) ], ... ; # 0..* Todo
  ], ...;
  fhir:SubstanceReferenceInformation.target [ # 0..* Todo
    fhir:SubstanceReferenceInformation.target.target [ Identifier ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.type [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.interaction [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.organism [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.organismType [ CodeableConcept ]; # 0..1 Todo
    # SubstanceReferenceInformation.target.amount[x] : 0..1 Todo. One of these 3
      fhir:SubstanceReferenceInformation.target.amountQuantity [ Quantity ]
      fhir:SubstanceReferenceInformation.target.amountRange [ Range ]
      fhir:SubstanceReferenceInformation.target.amountString [ string ]
    fhir:SubstanceReferenceInformation.target.amountType [ CodeableConcept ]; # 0..1 Todo
    fhir:SubstanceReferenceInformation.target.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