Release 4

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). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.9.9.2 StructureDefinition: Synthesis

Clinical Decision Support Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/synthesis

Explanation of what this profile contains/is for.

This profile was published on Wed, Oct 31, 2018 00:00+1100 as a draft by Health Level Seven, Inc. - Clinical Decision Support Workgroup.

14.9.9.2.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Evidence.

Summary

Mandatory: 4 elements

This structure is derived from Evidence.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Evidence 0..*
... url Σ0..1uriCanonical identifier for this evidence, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the evidence
... version Σ0..1stringBusiness version of the evidence
... title Σ0..1stringName for this evidence (human friendly)
... shortTitle 0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the Evidence
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the evidence
... note 0..*AnnotationUsed for footnotes or explanatory notes
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the evidence was approved by publisher
... lastReviewDate 0..1dateWhen the evidence was last reviewed
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... exposureBackground 1..1Reference(EvidenceVariable)What population?
... exposureVariant 1..2Reference(EvidenceVariable)What exposure?
... outcome 1..*Reference(EvidenceVariable)What outcome?

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Evidence I0..*A research context or question
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this evidence, represented as a URI (globally unique)
... identifier ΣI0..*IdentifierAdditional identifier for the evidence
... version ΣI0..1stringBusiness version of the evidence
... name ΣI0..1stringName for this evidence (computer friendly)
... title ΣI0..1stringName for this evidence (human friendly)
... shortTitle I0..1stringTitle for use in informal contexts
... subtitle I0..1stringSubordinate title of the Evidence
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... date ΣI0..1dateTimeDate last changed
... publisher ΣI0..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description ΣI0..1markdownNatural language description of the evidence
... note I0..*AnnotationUsed for footnotes or explanatory notes
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for evidence (if applicable)
Binding: Jurisdiction (extensible)
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the evidence was approved by publisher
... lastReviewDate I0..1dateWhen the evidence was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the evidence is expected to be used
... topic I0..*CodeableConceptThe category of the Evidence, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations, etc.
... exposureBackground ΣI1..1Reference(EvidenceVariable)What population?
... exposureVariant ΣI1..2Reference(EvidenceVariable)What exposure?
... outcome ΣI1..*Reference(EvidenceVariable)What outcome?

doco Documentation for this format
<!-- Evidence Synthesis Profile -->doco

<Evidence xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id><!-- 0..1 string Logical id of this artifact --></id>
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 0..1 Canonical identifier for this evidence, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the evidence --></identifier>
 <version value="[string]"/><!-- ?? 0..1 Business version of the evidence -->
 <name value="[string]"/><!-- ?? 0..1 Name for this evidence (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this evidence (human friendly) -->
 <shortTitle value="[string]"/><!-- ?? 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the Evidence -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the evidence -->
 <note><!-- ?? 0..* Annotation Used for footnotes or explanatory notes --></note>
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for evidence (if applicable)   --></jurisdiction>
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the evidence was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the evidence was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the evidence is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept The category of the Evidence, such as Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <exposureBackground><!-- ?? 1..1 Reference(EvidenceVariable) What population? --></exposureBackground>
 <exposureVariant><!-- ?? 1..2 Reference(EvidenceVariable) What exposure? --></exposureVariant>
 <outcome><!-- ?? 1..* Reference(EvidenceVariable) What outcome? --></outcome>
</Evidence>

{ // Evidence Synthesis Profile
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C?Canonical identifier for this evidence, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the evidence
    "version" : "<string>", // C?Business version of the evidence
    "name" : "<string>", // C?Name for this evidence (computer friendly)
    "title" : "<string>", // C?Name for this evidence (human friendly)
    "shortTitle" : "<string>", // C?Title for use in informal contexts
    "subtitle" : "<string>", // C?Subordinate title of the Evidence
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C?Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C?Natural language description of the evidence
    "note" : [{ Annotation }], // C?Used for footnotes or explanatory notes
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for evidence (if applicable)
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the evidence was approved by publisher
    "lastReviewDate" : "<date>", // C?When the evidence was last reviewed
    "effectivePeriod" : { Period }, // C?When the evidence is expected to be used
    "topic" : [{ CodeableConcept }], // C?The category of the Evidence, such as Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "exposureBackground" : { Reference(EvidenceVariable) }, // C? R! What population?
    "exposureVariant" : { Reference(EvidenceVariable) }, // C? R! What exposure?
    "outcome" : [{ Reference(EvidenceVariable) }] // C? R! What outcome?
  }

This structure is derived from Evidence.

Summary

Mandatory: 4 elements

Differential View

This structure is derived from Evidence.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Evidence 0..*
... url Σ0..1uriCanonical identifier for this evidence, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the evidence
... version Σ0..1stringBusiness version of the evidence
... title Σ0..1stringName for this evidence (human friendly)
... shortTitle 0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the Evidence
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the evidence
... note 0..*AnnotationUsed for footnotes or explanatory notes
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the evidence was approved by publisher
... lastReviewDate 0..1dateWhen the evidence was last reviewed
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... exposureBackground 1..1Reference(EvidenceVariable)What population?
... exposureVariant 1..2Reference(EvidenceVariable)What exposure?
... outcome 1..*Reference(EvidenceVariable)What outcome?

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Evidence I0..*A research context or question
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... url ΣI0..1uriCanonical identifier for this evidence, represented as a URI (globally unique)
... identifier ΣI0..*IdentifierAdditional identifier for the evidence
... version ΣI0..1stringBusiness version of the evidence
... name ΣI0..1stringName for this evidence (computer friendly)
... title ΣI0..1stringName for this evidence (human friendly)
... shortTitle I0..1stringTitle for use in informal contexts
... subtitle I0..1stringSubordinate title of the Evidence
... status ?!ΣI1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... date ΣI0..1dateTimeDate last changed
... publisher ΣI0..1stringName of the publisher (organization or individual)
... contact ΣI0..*ContactDetailContact details for the publisher
... description ΣI0..1markdownNatural language description of the evidence
... note I0..*AnnotationUsed for footnotes or explanatory notes
... useContext ΣI0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣI0..*CodeableConceptIntended jurisdiction for evidence (if applicable)
Binding: Jurisdiction (extensible)
... copyright I0..1markdownUse and/or publishing restrictions
... approvalDate I0..1dateWhen the evidence was approved by publisher
... lastReviewDate I0..1dateWhen the evidence was last reviewed
... effectivePeriod ΣI0..1PeriodWhen the evidence is expected to be used
... topic I0..*CodeableConceptThe category of the Evidence, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author I0..*ContactDetailWho authored the content
... editor I0..*ContactDetailWho edited the content
... reviewer I0..*ContactDetailWho reviewed the content
... endorser I0..*ContactDetailWho endorsed the content
... relatedArtifact I0..*RelatedArtifactAdditional documentation, citations, etc.
... exposureBackground ΣI1..1Reference(EvidenceVariable)What population?
... exposureVariant ΣI1..2Reference(EvidenceVariable)What exposure?
... outcome ΣI1..*Reference(EvidenceVariable)What outcome?

doco Documentation for this format

XML Template

<!-- Evidence Synthesis Profile -->doco

<Evidence xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id><!-- 0..1 string Logical id of this artifact --></id>
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- ?? 0..1 Canonical identifier for this evidence, represented as a URI (globally unique) -->
 <identifier><!-- ?? 0..* Identifier 
     Additional identifier for the evidence --></identifier>
 <version value="[string]"/><!-- ?? 0..1 Business version of the evidence -->
 <name value="[string]"/><!-- ?? 0..1 Name for this evidence (computer friendly) -->
 <title value="[string]"/><!-- ?? 0..1 Name for this evidence (human friendly) -->
 <shortTitle value="[string]"/><!-- ?? 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- ?? 0..1 Subordinate title of the Evidence -->
 <status value="[code]"/><!-- ?? 1..1 draft | active | retired | unknown   -->
 <date value="[dateTime]"/><!-- ?? 0..1 Date last changed -->
 <publisher value="[string]"/><!-- ?? 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- ?? 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the evidence -->
 <note><!-- ?? 0..* Annotation Used for footnotes or explanatory notes --></note>
 <useContext><!-- ?? 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- ?? 0..* CodeableConcept Intended jurisdiction for evidence (if applicable)   --></jurisdiction>
 <copyright value="[markdown]"/><!-- ?? 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- ?? 0..1 When the evidence was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- ?? 0..1 When the evidence was last reviewed -->
 <effectivePeriod><!-- ?? 0..1 Period 
     When the evidence is expected to be used --></effectivePeriod>
 <topic><!-- ?? 0..* CodeableConcept The category of the Evidence, such as Education, Treatment, Assessment, etc.   --></topic>
 <author><!-- ?? 0..* ContactDetail Who authored the content --></author>
 <editor><!-- ?? 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- ?? 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- ?? 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- ?? 0..* RelatedArtifact 
     Additional documentation, citations, etc. --></relatedArtifact>
 <exposureBackground><!-- ?? 1..1 Reference(EvidenceVariable) What population? --></exposureBackground>
 <exposureVariant><!-- ?? 1..2 Reference(EvidenceVariable) What exposure? --></exposureVariant>
 <outcome><!-- ?? 1..* Reference(EvidenceVariable) What outcome? --></outcome>
</Evidence>

JSON Template

{ // Evidence Synthesis Profile
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "url" : "<uri>", // C?Canonical identifier for this evidence, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // C?Additional identifier for the evidence
    "version" : "<string>", // C?Business version of the evidence
    "name" : "<string>", // C?Name for this evidence (computer friendly)
    "title" : "<string>", // C?Name for this evidence (human friendly)
    "shortTitle" : "<string>", // C?Title for use in informal contexts
    "subtitle" : "<string>", // C?Subordinate title of the Evidence
    "status" : "<code>", // C? R! draft | active | retired | unknown
    "date" : "<dateTime>", // C?Date last changed
    "publisher" : "<string>", // C?Name of the publisher (organization or individual)
    "contact" : [{ ContactDetail }], // C?Contact details for the publisher
    "description" : "<markdown>", // C?Natural language description of the evidence
    "note" : [{ Annotation }], // C?Used for footnotes or explanatory notes
    "useContext" : [{ UsageContext }], // C?The context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // C?Intended jurisdiction for evidence (if applicable)
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<date>", // C?When the evidence was approved by publisher
    "lastReviewDate" : "<date>", // C?When the evidence was last reviewed
    "effectivePeriod" : { Period }, // C?When the evidence is expected to be used
    "topic" : [{ CodeableConcept }], // C?The category of the Evidence, such as Education, Treatment, Assessment, etc.
    "author" : [{ ContactDetail }], // C?Who authored the content
    "editor" : [{ ContactDetail }], // C?Who edited the content
    "reviewer" : [{ ContactDetail }], // C?Who reviewed the content
    "endorser" : [{ ContactDetail }], // C?Who endorsed the content
    "relatedArtifact" : [{ RelatedArtifact }], // C?Additional documentation, citations, etc.
    "exposureBackground" : { Reference(EvidenceVariable) }, // C? R! What population?
    "exposureVariant" : { Reference(EvidenceVariable) }, // C? R! What exposure?
    "outcome" : [{ Reference(EvidenceVariable) }] // C? R! What outcome?
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

14.9.9.2.2 Terminology Bindings

PathNameConformanceValueSet
Evidence.languageCommon LanguagespreferredCommon Languages
Evidence.statusPublicationStatusrequiredPublicationStatus
Evidence.jurisdictionJurisdictionextensibleJurisdiction
Evidence.topicDefinitionTopicexampleDefinitionTopic
.