This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v5.0.0-snapshot1:
R5
Snapshot
#1).
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
Biomedical
Research
and
Regulation
Work
Group
|
Maturity Level : 0 | Trial Use | Security Category : Anonymous | Compartments : Not linked to any defined compartments |
Todo.
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
This
resource
is
referenced
by
SubstanceSpecification
SubstanceDefinition
.
This resource does not implement any patterns.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
DomainResource |
Todo
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..1 | string | Todo |
|
Σ | 0..* | BackboneElement |
Todo
|
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..* | Reference ( DocumentReference ) |
Todo
|
|
Σ | 0..* | BackboneElement |
Todo
|
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | Identifier | Todo |
|
Σ | 0..* | Reference ( DocumentReference ) |
Todo
|
|
Σ | 0..* | BackboneElement |
Todo
|
|
Σ |
|
|
Todo |
|
Σ | 0..1 |
|
Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 |
|
Todo |
|
Quantity | |||
|
Range | |||
|
string | |||
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..* | Reference ( DocumentReference ) |
Todo
|
Documentation
for
this
format
|
||||
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>
< <</domain> <</classification> <</subtype> <</source> </classification><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: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: fhir: fhir: fhir: fhir: ], ...;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 R3
| SubstanceReferenceInformation | |
| SubstanceReferenceInformation.classification |
|
This
resource
did
not
exist
in
Release
2
See
the
Full
Difference
for
further
information
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
|
DomainResource |
Todo
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..1 | string | Todo |
|
Σ | 0..* | BackboneElement |
Todo
|
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..* | Reference ( DocumentReference ) |
Todo
|
|
Σ | 0..* | BackboneElement |
Todo
|
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | Identifier | Todo |
|
Σ | 0..* | Reference ( DocumentReference ) |
Todo
|
|
Σ | 0..* | BackboneElement |
Todo
|
|
Σ |
|
|
Todo |
|
Σ | 0..1 |
|
Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..1 |
|
Todo |
|
Quantity | |||
|
Range | |||
|
string | |||
|
Σ | 0..1 | CodeableConcept | Todo |
|
Σ | 0..* | Reference ( DocumentReference ) |
Todo
|
Documentation
for
this
format
|
||||
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>
< <</domain> <</classification> <</subtype> <</source> </classification><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: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: fhir: fhir: fhir: fhir: ], ...;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 3
| SubstanceReferenceInformation | |
| SubstanceReferenceInformation.classification |
|
This
resource
did
not
exist
in
Release
2
See
the
Full
Difference
for
further
information
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis a