Library - FHIR Resource (r4)

This Library Resource uses the FHIR API standard for access and structure.

Validate an Library FHIR Resource (r4)

Library Attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this library, represented as a URI (globally unique)

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url":

Learn more about the (Library) url FHIR attribute

Description: Additional identifier for the library

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "use": "official",
    "value": "ChalmydiaScreening_Common"
  }
]

Learn more about the (Library) identifier FHIR attribute

Description: Business version of the library

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version": "2.0.0"

Learn more about the (Library) version FHIR attribute

Description: C? Name for this library (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name":

Learn more about the (Library) name FHIR attribute

Description: Name for this library (human friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title": "Chlamydia Screening Common Library"

Learn more about the (Library) title FHIR attribute

Description: Subordinate title of the library

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subtitle":

Learn more about the (Library) subtitle FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (Library) status FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental":

Learn more about the (Library) experimental FHIR attribute

Description: logic-library | model-definition | asset-collection | module-definition

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": {
  "coding": [
    {
      "code": "logic-library"
    }
  ]
}

Learn more about the (Library) type FHIR attribute

Description:

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"subject[x]":

Learn more about the (Library) subject[x] FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2015-07-22"

Learn more about the (Library) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher":

Learn more about the (Library) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact":

Learn more about the (Library) contact FHIR attribute

Description: Natural language description of the library

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "Common Logic for adherence to Chlamydia Screening guidelines"

Learn more about the (Library) description FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext":

Learn more about the (Library) useContext FHIR attribute

Description: Intended jurisdiction for library (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction":

Learn more about the (Library) jurisdiction FHIR attribute

Description: Why this library is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose":

Learn more about the (Library) purpose FHIR attribute

Description: Describes the clinical usage of the library

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"usage":

Learn more about the (Library) usage FHIR attribute

Description: Use and/or publishing restrictions

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"copyright":

Learn more about the (Library) copyright FHIR attribute

Description: When the library was approved by publisher

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"approvalDate":

Learn more about the (Library) approvalDate FHIR attribute

Description: When the library was last reviewed

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"lastReviewDate":

Learn more about the (Library) lastReviewDate FHIR attribute

Description: When the library is expected to be used

FHIR Version: r4

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"effectivePeriod":

Learn more about the (Library) effectivePeriod FHIR attribute

Description: E.g. Education, Treatment, Assessment, etc.

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"topic": [
  {
    "text": "Chlamydia Screening"
  }
]

Learn more about the (Library) topic FHIR attribute

Description: Who authored the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"author":

Learn more about the (Library) author FHIR attribute

Description: Who edited the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"editor":

Learn more about the (Library) editor FHIR attribute

Description: Who reviewed the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reviewer":

Learn more about the (Library) reviewer FHIR attribute

Description: Who endorsed the content

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"endorser":

Learn more about the (Library) endorser FHIR attribute

Description: Additional documentation, citations, etc.

FHIR Version: r4

Attribute Type : RelatedArtifact

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"relatedArtifact": [
  {
    "type": "depends-on",
    "resource": "Library/library-quick-model-definition"
  }
]

Learn more about the (Library) relatedArtifact FHIR attribute

Description: Parameters defined by the library

FHIR Version: r4

Attribute Type : ParameterDefinition

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"parameter":

Learn more about the (Library) parameter FHIR attribute

Description: What data is referenced by this library

FHIR Version: r4

Attribute Type : DataRequirement

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"dataRequirement": [
  {
    "type": "Condition",
    "codeFilter": [
      {
        "path": "code",
        "valueSet": "urn:oid:2.16.840.1.113883.3.464.1003.111.12.1006"
      }
    ]
  }
]

Learn more about the (Library) dataRequirement FHIR attribute

Description: Contents of the library, either embedded or referenced

FHIR Version: r4

Attribute Type : Attachment

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"content": [
  {
    "contentType": "text/cql",
    "url": "library-example-content.cql"
  }
]

Learn more about the (Library) content FHIR attribute

Library Example

{
  "resourceType": "Library",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Id: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">Library/example</td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Identifier: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <b>value: </b>\n                  <span>ChalmydiaScreening_Common</span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Version: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">2.0.0</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Title: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">Chlamydia Screening Common Library</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Type: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-right: 25px;\">\n                  <span>\n                     <span>\n                        <span style=\"padding-left: 25px;\">\n                           <b>code: </b>\n                           <span>logic-library</span>\n                        </span>\n                     </span>\n                  </span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Status: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">draft</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Description: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">Common Logic for adherence to Chlamydia Screening guidelines</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Topic: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-right: 25px;\">\n                  <span style=\"padding-left: 25px;\">\n                     <b>text: </b>\n                     <span>Chlamydia Screening</span>\n                  </span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Related: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <p style=\"margin-bottom: 5px;\">\n                     <b>type: </b>\n                     <span>depends-on</span>\n                  </p>\n                  <p style=\"margin-bottom: 5px;\">\n                     <b>Resource: </b>\n                     <br/>\n                     <span>\n                        <span style=\"padding-left: 25px;\">\n                           <b>reference: </b>\n                           <span>Library/library-quick-model-definition</span>\n                        </span>\n                     </span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Data Requirements: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <div>\n                     <p style=\"margin-bottom: 5px;\">\n                        <b>type: </b>\n                        <span>Condition</span>\n                     </p>\n                     <p style=\"margin-bottom: 5px;\">\n                        <b>code filter:</b>\n                        <br/>\n                        <span style=\"padding-left: 25px;\">\n                           <b>path: </b>\n                           <span>code</span>\n                        </span>\n                        <br/>\n                        <span style=\"padding-left: 25px;\">\n                           <b>valueset: </b>\n                           <span>Other Female Reproductive Conditions</span>\n                        </span>\n                     </p>\n                  </div>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Content: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <p style=\"margin-bottom: 5px;\">\n                     <b>type: </b>\n                     <span>text/cql</span>\n                  </p>\n                  <p style=\"margin-bottom: 5px;\">\n                     <b>url: </b>\n                     <span>library-example-content.cql</span>\n                  </p>\n               </td>\n            </tr>\n         </table>\n      </div>"
  },
  "identifier": [
    {
      "use": "official",
      "value": "ChalmydiaScreening_Common"
    }
  ],
  "version": "2.0.0",
  "title": "Chlamydia Screening Common Library",
  "status": "draft",
  "type": {
    "coding": [
      {
        "code": "logic-library"
      }
    ]
  },
  "date": "2015-07-22",
  "description": "Common Logic for adherence to Chlamydia Screening guidelines",
  "topic": [
    {
      "text": "Chlamydia Screening"
    }
  ],
  "relatedArtifact": [
    {
      "type": "depends-on",
      "resource": "Library/library-quick-model-definition"
    }
  ],
  "dataRequirement": [
    {
      "type": "Condition",
      "codeFilter": [
        {
          "path": "code",
          "valueSet": "urn:oid:2.16.840.1.113883.3.464.1003.111.12.1006"
        }
      ]
    }
  ],
  "content": [
    {
      "contentType": "text/cql",
      "url": "library-example-content.cql"
    }
  ]
}

Library Structure

{
  "resourceType" : "Library",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this library, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the library
  "version" : "<string>", // Business version of the library
  "name" : "<string>", // C? Name for this library (computer friendly)
  "title" : "<string>", // Name for this library (human friendly)
  "subtitle" : "<string>", // Subordinate title of the library
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "type" : { CodeableConcept }, // R!  logic-library | model-definition | asset-collection | module-definition
  // subject[x]: Type of individual the library content is focused on. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the library
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for library (if applicable)
  "purpose" : "<markdown>", // Why this library is defined
  "usage" : "<string>", // Describes the clinical usage of the library
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the library was approved by publisher
  "lastReviewDate" : "<date>", // When the library was last reviewed
  "effectivePeriod" : { Period }, // When the library is expected to be used
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "parameter" : [{ ParameterDefinition }], // Parameters defined by the library
  "dataRequirement" : [{ DataRequirement }], // What data is referenced by this library
  "content" : [{ Attachment }] // Contents of the library, either embedded or referenced
}

Library Search Parameters

The following search parameters can be used to query Library resources. Just submit them like so:

https://api.1up.health/fhir/r4/Library?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`composed-of`	`reference`	`relatedArtifact.where`
`content-type`	`text`	`content.contentType`
`context`	`text`	`useContext.value`
`context-quantity`	`quantity`	`useContext.value`
`context-type`	`text`	`useContext.code`
`context-type-quantity`	`composite`	`useContext`
`context-type-value`	`composite`	`useContext`
`date`	`date`	`date`
`depends-on`	`reference`	`relatedArtifact.where`
`derived-from`	`reference`	`relatedArtifact.where`
`description`	`text`	`description`
`effective`	`date`	`effectivePeriod`
`identifier`	`text`	`identifier`
`jurisdiction`	`text`	`jurisdiction`
`name`	`text`	`name`
`predecessor`	`reference`	`relatedArtifact.where`
`publisher`	`text`	`publisher`
`status`	`text`	`status`
`successor`	`reference`	`relatedArtifact.where`
`title`	`text`	`title`
`topic`	`text`	`topic`
`type`	`text`	`type`
`url`	`uri`	`url`
`version`	`text`	`version`