Release 4 R5 Final QA

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-draft-final: Final QA Preview for R5 - Mixed Normative and STU see ballot notes ) 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 . Page versions: R5 R4B R4 R3 R2

10.3.7 14.15.13.2 Resource DiagnosticReport - Examples StructureDefinition: LogicLibrary

Orders and Observations Clinical Decision Support icon Work Group   Maturity Level : N/A 0 Standards Status : Informative Trial Use Security Category : Patient Compartments Use Context : Device , Encounter , Patient , Practitioner Country: World

The canonical URL for this profile is: 


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

The logic library profile sets the minimum expectations for computable and/or executable libraries, including support for terminology and dependency declaration, parameters, and data requirements

This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

10.3.7.1

14.15.13.2.1 Laboratory Results Formal Views of Profile Content

The following examples of DiagnosticReport resources show examples Description of laboratory reports: Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .

This structure is derived from ShareableLibrary .

Summary

Mandatory: 1 element (+1 nested mandatory element)
Must-Support: 11 elements
Fixed Value: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices :

  • The element Library.relatedArtifact is sliced based on the value of value:type

This indicates the differences between this profile and the base ShareableLibrary structure.

Name Flags Card. Type Description & Constraints doco
.. Library 1 .. 1 ShareableLibrary Represents a report library of quality improvement components
... directReferenceCode S 0..* Coding A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... type 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: module-definition
... subject[x] S 0 .. 1 CodeableConcept , Reference ( Group ) Type of individual the library content is focused on
.... relatedArtifact:dependency S 0..* RelatedArtifact Additional documentation, citations, etc
..... type S 1 .. 1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Fixed Value: depends-on
..... resource S 1..1 canonical ( CodeSystem | ValueSet | Library ) What artifact is being referenced
... parameter S 0 .. * ParameterDefinition Parameters defined by the library
... dataRequirement S 0 .. * DataRequirement What data is referenced by this library
... content S 0 .. * Attachment Contents of the library, either embedded or referenced
.... contentType S 0 .. 1 code Mime type of the content, with multiple specimen and panels charset etc.
.... data 10.3.7.1.1 S Micro Isolate(Culture) and Susceptibility 0 .. 1 base64Binary Data inline, base64ed

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableLibrary structure.

Name Flags Card. Type Description & Constraints doco
.. Library C icon 1..1 ShareableLibrary Represents a library of quality improvement components
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages ( required ): IETF language tag for a human language

... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability ( required )
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... directReferenceCode S 0..* Coding A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
... url S Σ C icon 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the library
... version S Σ 1..1 string Business version of the library
... versionAlgorithm[x] S Σ 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name S Σ C icon 0..1 string Name for this library (computer friendly)
... title S Σ 1..1 string Name for this library (human friendly)
... subtitle 0..1 string Subordinate title of the library
... status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

... experimental S Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type ( extensible ): The type of knowledge asset this library contains.


Required Pattern: At least the following 2 examples
. . . . id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of DiagnosticReport resources show example the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: module-definition
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject[x] S 0..1 Type of individual the library content is focused on
Binding: Participant Resource Types ( extensible ): The possible types of subjects for a complex Micro Isolate library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference ( Group )
... date Σ 0..1 dateTime Date last changed
... publisher S Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S Σ 1..1 markdown Natural language description of the library
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet ( extensible ): Countries and Sensitivities with both 1 regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this library is defined
... usage 0..1 markdown Describes the clinical usage of the library
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and 2 levels year(s)
... approvalDate 0..1 date When the library was approved by publisher
... lastReviewDate 0..1 date When the library was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the library is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( example ): High-level categorization of nested Organism the definition, used for searching, sorting, and Susceptibilty panels using filtering.


... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... Slices for relatedArtifact S 0 .. * RelatedArtifact Additional documentation, citations, etc
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S 0..* RelatedArtifact Additional documentation, citations, etc
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type S Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType ( required ): The type of relationship to the related Observation Structure Micro Isolate and Sensitivities-1: artifact.


Fixed Value: depends-on
..... classifier An Σ 0..* CodeableConcept Additional classifiers
Binding: Citation Artifact Classifier ( example ): Additional classifiers for the related artifact.


..... label Σ 0..1 string Short label
..... display Σ 0..1 string Brief description of the related artifact
..... citation Σ 0..1 markdown Bibliographic citation for the artifact
..... document Σ 0..1 Attachment What document is being referenced
..... resource S Σ 1..1 canonical ( CodeSystem | ValueSet | Library ) What artifact is being referenced
..... resourceReference Σ 0..1 Reference ( Resource ) What artifact, if not a complex Micro Isolate and Sensitivities conformance resource
..... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): Publication status of an artifact being referred to.

..... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
... parameter S 0..* ParameterDefinition Parameters defined by the library
... dataRequirement S 0..* DataRequirement What data is referenced by this library
... content S Σ 0..* Attachment Contents of the library, either embedded or referenced
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType S Σ C icon 0..1 code Mime type of the content, with 2 level nested Organism charset etc.
Binding: Mime Types ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and Susceptibilty panels using 2049)


Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the related Observation Structure. The following diagram is provided above content (BCP-47)
Binding: All Languages ( required ): IETF language tag for a human language.


Example General: en-AU
.... data S C icon 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 integer64 Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to help teh reader navigate display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
.... height TU 0..1 positiveInt Height of the image in pixels (photo/video)
.... width TU 0..1 positiveInt Width of the image in pixels (photo/video)
.... frames TU 0..1 positiveInt Number of frames if > 1 (photo)
.... duration TU 0..1 decimal Length in seconds (audio / video)
.... pages TU 0..1 positiveInt Number of printed pages

doco Documentation for this format icon

<!-- LogicLibrary -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the library -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage -->
 <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the library -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined -->
 <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser>
 <-- relatedArtifact sliced by value:type  in the specified orderOpen-->

 <relatedArtifact> I 0..* RelatedArtifact  <!-- I 0..* Additional documentation, citations, etc -->
  <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as   -->
  <classifier><!-- I 0..* CodeableConcept Additional classifiers   --></classifier>
  <label value="[string]"/><!-- I 0..1 Short label -->
  <display value="[string]"/><!-- I 0..1 Brief description of the related artifact -->
  <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact -->
  <document><!-- I 0..1 Attachment 
      What document is being referenced --></document>
  <resource value="[canonical]"/><!-- I 1..1 What artifact is being referenced -->
  <resourceReference><!-- I 0..1 Reference(Resource) 
      What artifact, if not a conformance resource --></resourceReference>
  <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
  <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to -->
 </relatedArtifact>
 <parameter><!-- I 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- I 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content> I 0..* Attachment  <!-- I 0..* Contents of the library, either embedded or referenced -->
  <contentType value="[code]"/><!-- I 0..1 Mime type of the content, with charset etc.   -->
  <language value="[code]"/><!-- I 0..1 Human language of the content (BCP-47)   -->
  <data value="[base64Binary]"/><!-- I 0..1 Data inline, base64ed -->
  <url value="[url]"/><!-- I 0..1 Uri where the data can be found -->
  <size value="[integer64]"/><!-- I 0..1 Number of bytes of content (if url provided) -->
  <hash value="[base64Binary]"/><!-- I 0..1 Hash of the data (sha-1, base64ed) -->
  <title value="[string]"/><!-- I 0..1 Label to display in place of the data -->
  <creation value="[dateTime]"/><!-- I 0..1 Date attachment was first created -->
  <height value="[positiveInt]"/><!-- I 0..1 Height of the image in pixels (photo/video) -->
  <width value="[positiveInt]"/><!-- I 0..1 Width of the image in pixels (photo/video) -->
  <frames value="[positiveInt]"/><!-- I 0..1 Number of frames if > 1 (photo) -->
  <duration value="[decimal]"/><!-- I 0..1 Length in seconds (audio / video) -->
  <pages value="[positiveInt]"/><!-- I 0..1 Number of printed pages -->
 </content>
</Library>


{ // LogicLibrary
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // shareable | computable | publishable | executable // I
        // from Element: extension
      },
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Additional documentation, review, or usage guidance // I
        // from Element: extension
      },
      { // A code directly referenced by the artifact // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the library
    "version" : "<string>", // I R! Business version of the library
  // value[x]: How to compare versions. One of these 2:

    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this library (computer friendly)
    "title" : "<string>", // I R! Name for this library (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the library
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // IFor testing purposes, not real usage
    "type" : { CodeableConcept }, // I R! logic-library | model-definition | asset-collection | module-definition
  // value[x]: Type of individual the library content is focused on. One of these 2:

    "subjectCodeableConcept" : { CodeableConcept }, // IType of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the library
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // IWhy this library is defined
    "usage" : "<markdown>", // IDescribes the clinical usage of the library
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the library was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the library was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the library is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [ //  sliced by value:type  in the specified order, Open 
      { // Additional documentation, citations, etc // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "type" : "depends-on", // I R! 
        "classifier" : [{ CodeableConcept }], // IAdditional classifiers
        "label" : "<string>", // IShort label
        "display" : "<string>", // IBrief description of the related artifact
        "citation" : "<markdown>", // IBibliographic citation for the artifact
        "document" : { Attachment }, // IWhat document is being referenced
        "resource" : "<canonical>", // I R! What artifact is being referenced
        "resourceReference" : { Reference(Resource) }, // IWhat artifact, if not a conformance resource
        "publicationStatus" : "<code>", // Idraft | active | retired | unknown
        "publicationDate" : "<date>" // IDate of publication of the artifact being referred to
      }
    ],
    "parameter" : [{ ParameterDefinition }], // IParameters defined by the library
    "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library
    "content" : [{ Attachment }], // IContents of the library, either embedded or referenced
  }

This structure is derived from ShareableLibrary .

Summary

Mandatory: 1 element (+1 nested structures. mandatory element)
Must-Support: 11 elements
Fixed Value: 1 element

Extensions

Micro Isolate and Sensitivities-2: This structure refers to these extensions:

Slices

This structure defines the following Slices :

  • The element Library.relatedArtifact is sliced based on the HL7 V2 Lab Reports Interface (LRI) example. value of value:type

Differential View

This example has indicates the differences between this profile and the base ShareableLibrary structure.

10.3.7.2
Name Flags Card. Type Description & Constraints doco
.. Library 1 .. 1 ShareableLibrary Represents a single level nested Organism panels using library of quality improvement components
... directReferenceCode S 0..* Coding A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... type 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Required Pattern: At least the related Observation Structure. The following diagram
. . . . coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: module-definition
... subject[x] S 0 .. 1 CodeableConcept , Reference ( Group ) Type of individual the library content is provided to help focused on
.... relatedArtifact:dependency S 0..* RelatedArtifact Additional documentation, citations, etc
..... type S 1 .. 1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Fixed Value: depends-on
..... resource S 1..1 canonical ( CodeSystem | ValueSet | Library ) What artifact is being referenced
... parameter S 0 .. * ParameterDefinition Parameters defined by the reader navigate library
... dataRequirement S 0 .. * DataRequirement What data is referenced by this library
... content S 0 .. * Attachment Contents of the nested structures. library, either embedded or referenced
. . . . contentType S Imaging Studies 0 .. 1 code The following examples Mime type of DiagnosticReport resources show examples the content, with charset etc.
.... data S 0 .. 1 base64Binary Data inline, base64ed

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of various imaging reports: the profile after applying the changes in this profile to the base ShareableLibrary structure.

Real-world patient example Format 101 XML JSON 72ac8493-52ac-41bd-8d5d-7258c289b5ea XML Turtle f001 JSON f201 JSON f202 102 micro XML JSON lri-example XML ultrasound XML ghp XML Turtle pap XML JSON gingival-mass XML JSON lipids XML JSON
Name Imaging Example (Bone Density DXA) Flags Abdominal Ultrasound example Card. 10.3.7.3 Type Description & Constraints doco Genomics
. . Library The following examples C icon 1..1 ShareableLibrary Represents a library of DiagnosticReport resources show examples quality improvement components
... id Σ 0..1 id Logical id of genomics studies: An example this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?! Σ 0..1 uri A set of a genetics test report with Family member history rules under which this content was created
... language An example 0..1 code Language of the resource content
Binding: All Languages ( required ): IETF language tag for a HLA genotyping results report human language

... text An example 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: Knowledge Capability ( required )
... knowledgeRepresentationLevel S 0..* code narrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level ( required )
... artifactComment S 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... directReferenceCode S 0..* Coding A code directly referenced by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-directReferenceCode
... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
... url S Σ C icon 1..1 uri Canonical identifier for this library, represented as a comprehensive bone marrow report URI (globally unique)
... identifier An example Σ 0..* Identifier Additional identifier for the library
... version S Σ 1..1 string Business version of a PGx haplotype report the library
... versionAlgorithm[x] 10.3.7.4 S Anatomic Pathology Σ 0..1 How to compare versions
Binding: Version Algorithm ( extensible )
. . . . versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name S Σ C icon 0..1 string Name for this library (computer friendly)
... title S Σ 1..1 string Name for this library (human friendly)
... subtitle 0..1 string Subordinate title of the library
... status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact.

... experimental S Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type ( extensible ): The type of knowledge asset this library contains.


Required Pattern: At least the following examples
. . . . id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of DiagnosticReport resources show examples the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/library-type
..... version 0..1 string Version of anatomic pathology reports: An example the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: module-definition
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of a presented form anatomic pathology report the concept
... subject[x] An example S 0..1 Type of a principally narrative anatomic pathology report individual the library content is focused on
Binding: Participant Resource Types ( extensible ): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

Example
. . . . subjectCodeableConcept CodeableConcept
.... subjectReference Reference ( Group )
... date Σ 0..1 dateTime Date last changed
... publisher S Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact id Σ 0..* ContactDetail Contact details for the publisher
General Laboratory Report Example . . . description S Σ 1..1 markdown Natural language description of the library
. . . useContext Turtle Σ 0..* UsageContext The context that the content is intended to support
. Various reports gathered from v2 messages . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
JSON Binding: Jurisdiction ValueSet ( extensible ): Countries and regions within which this artifact is targeted for use.


. . . purpose 0..1 markdown Why this library is defined
. Real-world patient example . . usage 0..1 XML markdown Describes the clinical usage of the library
. . . copyright Turtle 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
. Real-world patient example . . approvalDate 0..1 XML date When the library was approved by publisher
. . . lastReviewDate Turtle 0..1 date When the library was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the library is expected to be used
. Real-world patient . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: Definition Topic ( example ): High-level categorization of the definition, used for searching, sorting, and filtering.


. . . author XML 0..* ContactDetail Who authored the content
JSON
. . . editor Turtle 0..* ContactDetail Who edited the content
. Imaging Example (Bone Density DXA) . . reviewer 0..* XML ContactDetail Who reviewed the content
JSON
. . . endorser Turtle 0..* ContactDetail Who endorsed the content
. An . . Slices for relatedArtifact S 0 .. * RelatedArtifact Additional documentation, citations, etc
Slice: Unordered, Open by value:type
.... relatedArtifact:dependency S 0..* RelatedArtifact Additional documentation, citations, etc
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type S Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType ( required ): The type of relationship to the related artifact.


Fixed Value: depends-on
..... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: Citation Artifact Classifier ( example ): Additional classifiers for the related artifact.


..... label Σ 0..1 string Short label
..... display Σ 0..1 string Brief description of a complex Micro Isolate and Sensitivities. the related artifact
..... citation Σ 0..1 markdown Bibliographic citation for the artifact
. . . . . document Turtle Σ 0..1 Attachment What document is being referenced
. . . . . resource S Σ 1..1 canonical ( CodeSystem | ValueSet | Library ) What artifact is being referenced
. An collection Bundle showing . . . . resourceReference Σ 0..1 Reference ( Resource ) What artifact, if not a conformance resource
..... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus ( required ): Publication status of an example artifact being referred to.

..... publicationDate Σ 0..1 date Date of a complex Micro Isolate and Sensitivities publication of the artifact being referred to
... parameter S 0..* ParameterDefinition Parameters defined by the library
JSON
. . . dataRequirement Turtle S 0..* DataRequirement What data is referenced by this library
. Abdominal Ultrasound example . . content S Σ 0..* Attachment Contents of the library, either embedded or referenced
JSON
. . . . id Turtle 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. An Example . . . contentType S Σ C icon 0..1 code Mime type of a report the content, with multiple specimen charset etc.
Binding: Mime Types ( required ): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and panels 2049)


Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
JSON Binding: All Languages ( required ): IETF language tag for a human language.


Example General: en-AU
. . . . data S C icon 0..1 base64Binary Data inline, base64ed
. An example . . . url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 integer64 Number of a principally narrative anatomic pathology report bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
. . . . title Turtle Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
. An example . . . creation Σ 0..1 dateTime Date attachment was first created
.... height TU 0..1 positiveInt Height of a presented form anatomic pathology report the image in pixels (photo/video)
.... width TU 0..1 positiveInt Width of the image in pixels (photo/video)
. . . . frames Turtle TU 0..1 positiveInt Number of frames if > 1 (photo)
. Lipid profile . . . duration TU 0..1 decimal Length in seconds (audio / video)
. . . . pages Turtle TU 0..1 positiveInt Number of printed pages

doco Documentation for Profile Example Lipid Profile this format icon

XML Template 


<!-- LogicLibrary -->doco

<Library xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <url value="[uri]"/><!-- I 1..1 Canonical identifier for this library, represented as a URI (globally unique) -->
 <identifier><!-- I 0..* Identifier Additional identifier for the library --></identifier>
 <version value="[string]"/><!-- I 1..1 Business version of the library -->
 <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions   --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this library (computer friendly) -->
 <title value="[string]"/><!-- I 1..1 Name for this library (human friendly) -->
 <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the library -->
 <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown   -->
 <experimental value="[boolean]"/><!-- I 0..1 For testing purposes, not real usage -->
 <type><!-- I 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition   --></type>
 <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group) Type of individual the library content is focused on   --></subject[x]>
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 1..1 Natural language description of the library -->
 <useContext><!-- I 0..* UsageContext 
     The context that the content is intended to support --></useContext>
 <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for library (if applicable)   --></jurisdiction>
 <purpose value="[markdown]"/><!-- I 0..1 Why this library is defined -->
 <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the library -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- I 0..1 When the library was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the library was last reviewed by the publisher -->
 <effectivePeriod><!-- I 0..1 Period 
     When the library is expected to be used --></effectivePeriod>
 <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc   --></topic>
 <author><!-- I 0..* ContactDetail Who authored the content --></author>
 <editor><!-- I 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser>
 <-- relatedArtifact sliced by value:type  in the specified orderOpen-->

 <relatedArtifact> I 0..* RelatedArtifact  <!-- I 0..* Additional documentation, citations, etc -->
  <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as   -->
  <classifier><!-- I 0..* CodeableConcept Additional classifiers   --></classifier>
  <label value="[string]"/><!-- I 0..1 Short label -->
  <display value="[string]"/><!-- I 0..1 Brief description of the related artifact -->
  <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact -->
  <document><!-- I 0..1 Attachment 
      What document is being referenced --></document>
  <resource value="[canonical]"/><!-- I 1..1 What artifact is being referenced -->
  <resourceReference><!-- I 0..1 Reference(Resource) 
      What artifact, if not a conformance resource --></resourceReference>
  <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown   -->
  <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to -->
 </relatedArtifact>
 <parameter><!-- I 0..* ParameterDefinition 
     Parameters defined by the library --></parameter>
 <dataRequirement><!-- I 0..* DataRequirement 
     What data is referenced by this library --></dataRequirement>
 <content> I 0..* Attachment  <!-- I 0..* Contents of the library, either embedded or referenced -->
  <contentType value="[code]"/><!-- I 0..1 Mime type of the content, with charset etc.   -->
  <language value="[code]"/><!-- I 0..1 Human language of the content (BCP-47)   -->
  <data value="[base64Binary]"/><!-- I 0..1 Data inline, base64ed -->
  <url value="[url]"/><!-- I 0..1 Uri where the data can be found -->
  <size value="[integer64]"/><!-- I 0..1 Number of bytes of content (if url provided) -->
  <hash value="[base64Binary]"/><!-- I 0..1 Hash of the data (sha-1, base64ed) -->
  <title value="[string]"/><!-- I 0..1 Label to display in place of the data -->
  <creation value="[dateTime]"/><!-- I 0..1 Date attachment was first created -->
  <height value="[positiveInt]"/><!-- I 0..1 Height of the image in pixels (photo/video) -->
  <width value="[positiveInt]"/><!-- I 0..1 Width of the image in pixels (photo/video) -->
  <frames value="[positiveInt]"/><!-- I 0..1 Number of frames if > 1 (photo) -->
  <duration value="[decimal]"/><!-- I 0..1 Length in seconds (audio / video) -->
  <pages value="[positiveInt]"/><!-- I 0..1 Number of printed pages -->
 </content>
</Library>

JSON Template 


{ // LogicLibrary
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // shareable | computable | publishable | executable // I
        // from Element: extension
      },
      { // narrative | semi-structured | structured | executable // I
        // from Element: extension
      },
      { // Additional documentation, review, or usage guidance // I
        // from Element: extension
      },
      { // A code directly referenced by the artifact // I
        // from Element: extension
      }
    ],
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "url" : "<uri>", // I R! Canonical identifier for this library, represented as a URI (globally unique)
    "identifier" : [{ Identifier }], // IAdditional identifier for the library
    "version" : "<string>", // I R! Business version of the library
  // value[x]: How to compare versions. One of these 2:

    "versionAlgorithmString" : "<string>", // IHow to compare versions
    "versionAlgorithmCoding" : { Coding }, // IHow to compare versions
    "name" : "<string>", // IName for this library (computer friendly)
    "title" : "<string>", // I R! Name for this library (human friendly)
    "subtitle" : "<string>", // ISubordinate title of the library
    "status" : "<code>", // I R! draft | active | retired | unknown
    "experimental" : <boolean>, // IFor testing purposes, not real usage
    "type" : { CodeableConcept }, // I R! logic-library | model-definition | asset-collection | module-definition
  // value[x]: Type of individual the library content is focused on. One of these 2:

    "subjectCodeableConcept" : { CodeableConcept }, // IType of individual the library content is focused on
    "subjectReference" : { Reference(Group) }, // IType of individual the library content is focused on
    "date" : "<dateTime>", // IDate last changed
    "publisher" : "<string>", // IName of the publisher/steward (organization or individual)
    "contact" : [{ ContactDetail }], // IContact details for the publisher
    "description" : "<markdown>", // I R! Natural language description of the library
    "useContext" : [{ UsageContext }], // IThe context that the content is intended to support
    "jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for library (if applicable)
    "purpose" : "<markdown>", // IWhy this library is defined
    "usage" : "<markdown>", // IDescribes the clinical usage of the library
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "copyrightLabel" : "<string>", // ICopyright holder and year(s)
    "approvalDate" : "<date>", // IWhen the library was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the library was last reviewed by the publisher
    "effectivePeriod" : { Period }, // IWhen the library is expected to be used
    "topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
    "author" : [{ ContactDetail }], // IWho authored the content
    "editor" : [{ ContactDetail }], // IWho edited the content
    "reviewer" : [{ ContactDetail }], // IWho reviewed the content
    "endorser" : [{ ContactDetail }], // IWho endorsed the content
    "relatedArtifact" : [ //  sliced by value:type  in the specified order, Open 
      { // Additional documentation, citations, etc // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "type" : "depends-on", // I R! 
        "classifier" : [{ CodeableConcept }], // IAdditional classifiers
        "label" : "<string>", // IShort label
        "display" : "<string>", // IBrief description of the related artifact
        "citation" : "<markdown>", // IBibliographic citation for the artifact
        "document" : { Attachment }, // IWhat document is being referenced
        "resource" : "<canonical>", // I R! What artifact is being referenced
        "resourceReference" : { Reference(Resource) }, // IWhat artifact, if not a conformance resource
        "publicationStatus" : "<code>", // Idraft | active | retired | unknown
        "publicationDate" : "<date>" // IDate of publication of the artifact being referred to
      }
    ],
    "parameter" : [{ ParameterDefinition }], // IParameters defined by the library
    "dataRequirement" : [{ DataRequirement }], // IWhat data is referenced by this library
    "content" : [{ Attachment }], // IContents of the library, either embedded or referenced
  }

 

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

14.15.13.2.2 Terminology Bindings

An example of a comprehensive bone marrow report XML Turtle An example of a PGx haplotype report XML Turtle An XML Turtle  
An example of a genetics test report with Family member history Path dg2 Name XML Conformance JSON ValueSet
Library.language All Languages required Turtle All Languages
Library.versionAlgorithm[x] for Profile DiagnosticReport-Genetics Version Algorithm extensible Version Algorithm
Library.status PublicationStatus required report PublicationStatus
Library.type Library Type extensible JSON Library Type
Library.subject[x] Participant Resource Types extensible for Profile DiagnosticReport-Genetics Participant Resource Types
Library.jurisdiction Jurisdiction ValueSet extensible example-pgx Jurisdiction ValueSet
Library.topic Definition Topic example JSON Definition Topic
Library.relatedArtifact.type RelatedArtifactType required for Profile DiagnosticReport-Genetics RelatedArtifactType
Library.relatedArtifact.classifier Citation Artifact Classifier example of a HLA genotyping results report hla-1 Citation Artifact Classifier
Library.relatedArtifact.publicationStatus PublicationStatus required JSON PublicationStatus
Library.content.contentType Mime Types required for Profile Profile for HLA Genotyping Results Mime Types
Library.content.language All Languages required All Languages
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification. . .