Gravitate Health FHIR Implementation Guide
0.1.0 - CI Build

Gravitate Health FHIR Implementation Guide, published by Gravitate Health Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/gravitate-health/ and changes regularly. See the Directory of published versions

Resource Profile: Lens Profile

Official URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/lens Version: 0.1.0
Active as of 2024-11-22 Computable Name: Lens

Lens Profile

Usage:

Formal Views of Profile Content

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

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 0..* Library Represents a library of quality improvement components
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... lee-version 1..1 string LEE version - string
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/lee-version
... Slices for identifier S 1..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:gravitateIdentifier 0..1 Identifier Additional identifier for the library
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://gravitate-health.lst.tfo.upm.es
..... value 0..1 string The value that is unique
Binding: LensCategories (extensible)
... version S 1..1 string Business version of the library
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... 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)
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: logical-library
... subject[x] S 0..1 CodeableConcept, Reference(Group) Type of individual the library content is focused on
... description S 1..1 markdown documentation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... jurisdiction S 1..* CodeableConcept region
... purpose S 1..1 markdown Intent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... usage S 1..1 markdown explanation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... copyright S 1..1 markdown Use and/or publishing restrictions
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... approvalDate S 0..1 date When the library was approved by publisher
... lastReviewDate S 0..1 date When the library was last reviewed by the publisher
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... author S 0..* ContactDetail Who authored the content
... relatedArtifact S 0..* RelatedArtifact alternative
... parameter S 1..* ParameterDefinition Parameters defined by the library
.... documentation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... content S 1..* Attachment The code of the lens - base64
.... contentType S 0..1 code Mime type of the content, with charset etc.
.... language S 0..1 code Human language of the content (BCP-47)
.... data S 0..1 base64Binary Data inline, base64ed
.... url S 0..1 url Uri where the data can be found
.... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title S 0..1 string Label to display in place of the data
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... creation S 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Library.identifier:gravitateIdentifier.valueextensibleLensCategories (a valid code from LensCategoriesCodes)
http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... lee-version 1..1 string LEE version - string
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/lee-version
... Slices for identifier SΣ 1..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:gravitateIdentifier Σ 0..1 Identifier Additional identifier for the library
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://gravitate-health.lst.tfo.upm.es
..... value ΣC 0..1 string The value that is unique
Binding: LensCategories (extensible)
Example General: 123456
... version SΣ 1..1 string Business version of the library
... name SΣC 1..1 string Name for this library (computer friendly)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: logical-library
... subject[x] S 0..1 Type of individual the library content is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... description SΣ 1..1 markdown documentation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... jurisdiction SΣ 1..* CodeableConcept region
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 1..1 markdown Intent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... usage S 1..1 markdown explanation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... copyright S 1..1 markdown Use and/or publishing restrictions
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... approvalDate S 0..1 date When the library was approved by publisher
... lastReviewDate S 0..1 date When the library was last reviewed by the publisher
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 0..* ContactDetail Who authored the content
... relatedArtifact S 0..* RelatedArtifact alternative
... parameter S 1..* ParameterDefinition Parameters defined by the library
.... use Σ 1..1 code in | out
Binding: OperationParameterUse (required): Whether the parameter is input or output.

.... documentation Σ 0..1 string A brief description of the parameter
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... type Σ 1..1 code What type of value
Binding: FHIRTypes (required): List of FHIR types (resources, data types).

... content SΣ 1..* Attachment The code of the lens - base64
.... contentType SΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


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

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
.... data SC 0..1 base64Binary Data inline, base64ed
.... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.identifier:gravitateIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Library.identifier:gravitateIdentifier.valueextensibleLensCategories (a valid code from LensCategoriesCodes)
http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories
from this IG
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Library.typeextensiblePattern: logical-library
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Library.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Library.parameter.userequiredOperationParameterUse
http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0
from the FHIR Standard
Library.parameter.typerequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Library.content.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Library.content.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... lee-version 1..1 string LEE version - string
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/lee-version
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... Slices for identifier SΣ 1..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:gravitateIdentifier Σ 0..1 Identifier Additional identifier for the library
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://gravitate-health.lst.tfo.upm.es
..... value ΣC 0..1 string The value that is unique
Binding: LensCategories (extensible)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version SΣ 1..1 string Business version of the library
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this library (computer friendly)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 string Primitive value for string
Max Length:1048576
... title Σ 0..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 Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... 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 0..1 uri Identity of the terminology system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: logical-library
..... 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: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 1..1 markdown documentation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 1..* CodeableConcept region
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 1..1 markdown Intent
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... usage S 1..1 markdown explanation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... copyright S 1..1 markdown Use and/or publishing restrictions
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate S 0..1 date When the library was approved by publisher
... lastReviewDate S 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 S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 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
... relatedArtifact S 0..* RelatedArtifact alternative
... parameter S 1..* ParameterDefinition Parameters defined by the library
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ 0..1 code Name used to access the parameter value
.... use Σ 1..1 code in | out
Binding: OperationParameterUse (required): Whether the parameter is input or output.

.... min Σ 0..1 integer Minimum cardinality
.... max Σ 0..1 string Maximum cardinality (a number of *)
.... documentation Σ 0..1 string A brief description of the parameter
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... type Σ 1..1 code What type of value
Binding: FHIRTypes (required): List of FHIR types (resources, data types).

.... profile Σ 0..1 canonical(StructureDefinition) What profile the value is expected to be
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content SΣ 1..* Attachment The code of the lens - base64
.... 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 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


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

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
.... data SC 0..1 base64Binary Data inline, base64ed
.... url SΣ 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 SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... creation SΣ 0..1 dateTime Date attachment was first created
.... height 0..1 positiveInt Height of the image in pixels (photo/video)
.... width 0..1 positiveInt Width of the image in pixels (photo/video)
.... frames 0..1 positiveInt Number of frames if > 1 (photo)
.... duration 0..1 decimal Length in seconds (audio / video)
.... pages 0..1 positiveInt Number of printed pages

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Library.identifier:gravitateIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Library.identifier:gravitateIdentifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Library.identifier:gravitateIdentifier.valueextensibleLensCategories (a valid code from LensCategoriesCodes)
http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories
from this IG
Library.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Library.typeextensiblePattern: logical-library
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Library.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Library.parameter.userequiredOperationParameterUse
http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0
from the FHIR Standard
Library.parameter.typerequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Library.content.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Library.content.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

This structure is derived from Library

Summary

Mandatory: 12 elements(1 nested mandatory element)
Must-Support: 31 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Library.identifier

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 0..* Library Represents a library of quality improvement components
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... lee-version 1..1 string LEE version - string
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/lee-version
... Slices for identifier S 1..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:gravitateIdentifier 0..1 Identifier Additional identifier for the library
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://gravitate-health.lst.tfo.upm.es
..... value 0..1 string The value that is unique
Binding: LensCategories (extensible)
... version S 1..1 string Business version of the library
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... 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)
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: logical-library
... subject[x] S 0..1 CodeableConcept, Reference(Group) Type of individual the library content is focused on
... description S 1..1 markdown documentation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... jurisdiction S 1..* CodeableConcept region
... purpose S 1..1 markdown Intent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... usage S 1..1 markdown explanation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... copyright S 1..1 markdown Use and/or publishing restrictions
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... approvalDate S 0..1 date When the library was approved by publisher
... lastReviewDate S 0..1 date When the library was last reviewed by the publisher
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
... author S 0..* ContactDetail Who authored the content
... relatedArtifact S 0..* RelatedArtifact alternative
... parameter S 1..* ParameterDefinition Parameters defined by the library
.... documentation
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... content S 1..* Attachment The code of the lens - base64
.... contentType S 0..1 code Mime type of the content, with charset etc.
.... language S 0..1 code Human language of the content (BCP-47)
.... data S 0..1 base64Binary Data inline, base64ed
.... url S 0..1 url Uri where the data can be found
.... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title S 0..1 string Label to display in place of the data
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... creation S 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Library.identifier:gravitateIdentifier.valueextensibleLensCategories (a valid code from LensCategoriesCodes)
http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... lee-version 1..1 string LEE version - string
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/lee-version
... Slices for identifier SΣ 1..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:gravitateIdentifier Σ 0..1 Identifier Additional identifier for the library
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://gravitate-health.lst.tfo.upm.es
..... value ΣC 0..1 string The value that is unique
Binding: LensCategories (extensible)
Example General: 123456
... version SΣ 1..1 string Business version of the library
... name SΣC 1..1 string Name for this library (computer friendly)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: logical-library
... subject[x] S 0..1 Type of individual the library content is focused on
Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... description SΣ 1..1 markdown documentation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... jurisdiction SΣ 1..* CodeableConcept region
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 1..1 markdown Intent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... usage S 1..1 markdown explanation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... copyright S 1..1 markdown Use and/or publishing restrictions
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... approvalDate S 0..1 date When the library was approved by publisher
... lastReviewDate S 0..1 date When the library was last reviewed by the publisher
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 0..* ContactDetail Who authored the content
... relatedArtifact S 0..* RelatedArtifact alternative
... parameter S 1..* ParameterDefinition Parameters defined by the library
.... use Σ 1..1 code in | out
Binding: OperationParameterUse (required): Whether the parameter is input or output.

.... documentation Σ 0..1 string A brief description of the parameter
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... type Σ 1..1 code What type of value
Binding: FHIRTypes (required): List of FHIR types (resources, data types).

... content SΣ 1..* Attachment The code of the lens - base64
.... contentType SΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


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

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
.... data SC 0..1 base64Binary Data inline, base64ed
.... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.identifier:gravitateIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Library.identifier:gravitateIdentifier.valueextensibleLensCategories (a valid code from LensCategoriesCodes)
http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories
from this IG
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Library.typeextensiblePattern: logical-library
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Library.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Library.parameter.userequiredOperationParameterUse
http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0
from the FHIR Standard
Library.parameter.typerequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Library.content.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Library.content.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... lee-version 1..1 string LEE version - string
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/lee-version
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... Slices for identifier SΣ 1..* Identifier Additional identifier for the library
Slice: Unordered, Open by value:system
.... identifier:gravitateIdentifier Σ 0..1 Identifier Additional identifier for the library
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://gravitate-health.lst.tfo.upm.es
..... value ΣC 0..1 string The value that is unique
Binding: LensCategories (extensible)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... version SΣ 1..1 string Business version of the library
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this library (computer friendly)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 string Primitive value for string
Max Length:1048576
... title Σ 0..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 Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... 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 0..1 uri Identity of the terminology system
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: logical-library
..... 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: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 1..1 markdown documentation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 1..* CodeableConcept region
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S 1..1 markdown Intent
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... usage S 1..1 markdown explanation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... copyright S 1..1 markdown Use and/or publishing restrictions
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1 markdown Primitive value for markdown
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate S 0..1 date When the library was approved by publisher
... lastReviewDate S 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 S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 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
... relatedArtifact S 0..* RelatedArtifact alternative
... parameter S 1..* ParameterDefinition Parameters defined by the library
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... name Σ 0..1 code Name used to access the parameter value
.... use Σ 1..1 code in | out
Binding: OperationParameterUse (required): Whether the parameter is input or output.

.... min Σ 0..1 integer Minimum cardinality
.... max Σ 0..1 string Maximum cardinality (a number of *)
.... documentation Σ 0..1 string A brief description of the parameter
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... type Σ 1..1 code What type of value
Binding: FHIRTypes (required): List of FHIR types (resources, data types).

.... profile Σ 0..1 canonical(StructureDefinition) What profile the value is expected to be
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content SΣ 1..* Attachment The code of the lens - base64
.... 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 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


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

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
.... data SC 0..1 base64Binary Data inline, base64ed
.... url SΣ 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 SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title SΣ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... translation S 0..* (Complex) Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... creation SΣ 0..1 dateTime Date attachment was first created
.... height 0..1 positiveInt Height of the image in pixels (photo/video)
.... width 0..1 positiveInt Width of the image in pixels (photo/video)
.... frames 0..1 positiveInt Number of frames if > 1 (photo)
.... duration 0..1 decimal Length in seconds (audio / video)
.... pages 0..1 positiveInt Number of printed pages

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Library.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Library.identifier:gravitateIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Library.identifier:gravitateIdentifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Library.identifier:gravitateIdentifier.valueextensibleLensCategories (a valid code from LensCategoriesCodes)
http://hl7.eu/fhir/ig/gravitate-health/ValueSet/LensCategories
from this IG
Library.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Library.typeextensiblePattern: logical-library
http://hl7.org/fhir/ValueSet/library-type
from the FHIR Standard
Library.subject[x]extensibleParticipantResourceTypes
http://hl7.org/fhir/ValueSet/participant-resource-types
from the FHIR Standard
Library.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
Library.parameter.userequiredOperationParameterUse
http://hl7.org/fhir/ValueSet/operation-parameter-use|5.0.0
from the FHIR Standard
Library.parameter.typerequiredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|5.0.0
from the FHIR Standard
Library.content.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
Library.content.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

This structure is derived from Library

Summary

Mandatory: 12 elements(1 nested mandatory element)
Must-Support: 31 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Library.identifier

 

Other representations of profile: CSV, Excel, Schematron