Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/search-results | Version: 2.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: SearchResults | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.91 | ||||
Profile of Library for Evidence Based Medicine IG. The SearchResults Profile is used to represent search results, such as for a systematic review.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library |
0..* | Library | Represents a library of quality improvement components | |
  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: asset-collection | |
 display |
1..1 | string | Representation defined by the system Fixed Value: Asset Collection | |
 Slices for subject[x] |
0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on Slice: Unordered, Open by type:$this | |
  subject[x]:subjectReference |
0..1 | Reference(SearchStrategy) | Type of individual the library content is focused on | |
| topic |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
 type |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. ele-1: All FHIR elements must have a @value or children 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: asset-collection | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Asset Collection | |
| Slices for subject[x] |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). ele-1: All FHIR elements must have a @value or children | ||
 subjectCodeableConcept |
CodeableConcept | |||
 subjectReference |
Reference(Group) | |||
| subject[x]:subjectReference |
0..1 | Reference(SearchStrategy) | Type of individual the library content is focused on ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Library.type | extensible | Pattern: asset-collection("Asset Collection")http://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | |
| Library.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| 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 | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
Σ | 0..1 | string | Business version of the library | ||||
 versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
| 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 |
1..1 | uri | Identity of 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: asset-collection | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Asset Collection | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for subject[x] |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| subject[x]:subjectReference |
0..1 | Reference(SearchStrategy) | Type of individual the library content is focused on | |||||
| 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 |
Σ | 0..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: JurisdictionValueSet (extensible): Countries and 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 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 | ||||
| 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 | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| parameter |
0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement |
0..* | DataRequirement | What data is referenced by this library | |||||
| content |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Library.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| Library.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Library.type | extensible | Pattern: asset-collection("Asset Collection")http://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | |
| Library.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-typesfrom the FHIR Standard | |
| Library.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | Library.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Differential View
This structure is derived from Library
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library |
0..* | Library | Represents a library of quality improvement components | |
| 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: asset-collection | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Asset Collection | |
| Slices for subject[x] |
0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on Slice: Unordered, Open by type:$this | |
| subject[x]:subjectReference |
0..1 | Reference(SearchStrategy) | Type of individual the library content is focused on | |
| topic |
0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. ele-1: All FHIR elements must have a @value or children 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: asset-collection | |
| display |
1..1 | string | Representation defined by the system Fixed Value: Asset Collection | |
| Slices for subject[x] |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). ele-1: All FHIR elements must have a @value or children | ||
| subjectCodeableConcept |
CodeableConcept | |||
| subjectReference |
Reference(Group) | |||
| subject[x]:subjectReference |
0..1 | Reference(SearchStrategy) | Type of individual the library content is focused on ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Library.type | extensible | Pattern: asset-collection("Asset Collection")http://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | |
| Library.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| 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 | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
| version |
Σ | 0..1 | string | Business version of the library | ||||
| versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
| 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 |
1..1 | uri | Identity of 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: asset-collection | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Asset Collection | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for subject[x] |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: ParticipantResourceTypes (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| subject[x]:subjectReference |
0..1 | Reference(SearchStrategy) | Type of individual the library content is focused on | |||||
| 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 |
Σ | 0..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: JurisdictionValueSet (extensible): Countries and 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 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 | ||||
| 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 | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| parameter |
0..* | ParameterDefinition | Parameters defined by the library | |||||
| dataRequirement |
0..* | DataRequirement | What data is referenced by this library | |||||
| content |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Library.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| Library.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithmfrom the FHIR Standard | |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Library.type | extensible | Pattern: asset-collection("Asset Collection")http://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | |
| Library.subject[x] | extensible | ParticipantResourceTypeshttp://hl7.org/fhir/ValueSet/participant-resource-typesfrom the FHIR Standard | |
| Library.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cnl-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
| cnl-1 | warning | Library.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.ebm#2.0.0-ballot based on FHIR 6.0.0-ballot2. Generated 2024-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change