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-03-14 Computable Name: Lens

Lens Profile

Usage:

  • Refer to this Resource Profile: Lenses

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..*LibraryRepresents a library of quality improvement components
... identifier S1..*IdentifierAdditional identifier for the library
... version S1..1stringBusiness version of the library
... name S1..1stringName for this library (computer friendly)
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logical-library
... description S1..1markdowndocumentation
... jurisdiction S1..*CodeableConceptregion
... purpose S1..1markdownIntent
... usage S1..1markdownexplanation
... copyright S1..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed by the publisher
... author S0..*ContactDetailWho authored the content
... relatedArtifact S0..*RelatedArtifactalternative
... parameter S1..*ParameterDefinitionParameters defined by the library
... content S1..*AttachmentThe code of the lens - base64

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C0..*LibraryRepresents 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..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... version SΣ1..1stringBusiness version of the library
... name SΣC1..1stringName for this library (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logical-library
... description SΣ1..1markdowndocumentation
... jurisdiction SΣ1..*CodeableConceptregion
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownIntent
... usage S1..1markdownexplanation
... copyright S1..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed by the publisher
... author S0..*ContactDetailWho authored the content
... relatedArtifact S0..*RelatedArtifactalternative
... parameter S1..*ParameterDefinitionParameters defined by the library
... content SΣ1..*AttachmentThe code of the lens - base64

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
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.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C0..*LibraryRepresents 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this library, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC1..1stringName for this library (computer friendly)
... title Σ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system0..1uriIdentity of the terminology system
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logical-library
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdowndocumentation
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ1..*CodeableConceptregion
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownIntent
... usage S1..1markdownexplanation
... copyright S1..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactalternative
... parameter S1..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content SΣ1..*AttachmentThe code of the lens - base64

doco Documentation for this format

Terminology Bindings

This structure is derived from Library

Summary

Mandatory: 10 elements
Must-Support: 14 elements

Differential View

This structure is derived from Library

PathConformanceValueSet / CodeURI
Library.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library 0..*LibraryRepresents a library of quality improvement components
... identifier S1..*IdentifierAdditional identifier for the library
... version S1..1stringBusiness version of the library
... name S1..1stringName for this library (computer friendly)
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logical-library
... description S1..1markdowndocumentation
... jurisdiction S1..*CodeableConceptregion
... purpose S1..1markdownIntent
... usage S1..1markdownexplanation
... copyright S1..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed by the publisher
... author S0..*ContactDetailWho authored the content
... relatedArtifact S0..*RelatedArtifactalternative
... parameter S1..*ParameterDefinitionParameters defined by the library
... content S1..*AttachmentThe code of the lens - base64

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C0..*LibraryRepresents 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..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... version SΣ1..1stringBusiness version of the library
... name SΣC1..1stringName for this library (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logical-library
... description SΣ1..1markdowndocumentation
... jurisdiction SΣ1..*CodeableConceptregion
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownIntent
... usage S1..1markdownexplanation
... copyright S1..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed by the publisher
... author S0..*ContactDetailWho authored the content
... relatedArtifact S0..*RelatedArtifactalternative
... parameter S1..*ParameterDefinitionParameters defined by the library
... content SΣ1..*AttachmentThe code of the lens - base64

doco Documentation for this format

Terminology Bindings

Snapshot View

PathConformanceValueSet / CodeURI
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.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C0..*LibraryRepresents 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this library, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier SΣ1..*IdentifierAdditional identifier for the library
... version SΣ1..1stringBusiness version of the library
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC1..1stringName for this library (computer friendly)
... title Σ0..1stringName for this library (human friendly)
... subtitle 0..1stringSubordinate title of the library
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... type Σ1..1CodeableConceptlogic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system0..1uriIdentity of the terminology system
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: logical-library
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... subject[x] 0..1Type 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.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdowndocumentation
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ1..*CodeableConceptregion
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S1..1markdownIntent
... usage S1..1markdownexplanation
... copyright S1..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate S0..1dateWhen the library was approved by publisher
... lastReviewDate S0..1dateWhen the library was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodWhen the library is expected to be used
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactalternative
... parameter S1..*ParameterDefinitionParameters defined by the library
... dataRequirement 0..*DataRequirementWhat data is referenced by this library
... content SΣ1..*AttachmentThe code of the lens - base64

doco Documentation for this format

Terminology Bindings

This structure is derived from Library

Summary

Mandatory: 10 elements
Must-Support: 14 elements

 

Other representations of profile: CSV, Excel, Schematron

PathConformanceValueSet / CodeURI
Library.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
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