Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-medmorph/ and changes regularly. See the Directory of published versions

## Resource Profile: US Public Health Executable Library

Official URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-executable-library | Version: 1.0.0
Draft as of 2021-10-23 | Computable Name: USPublicHealthExecutableLibrary

This profile sets the minimum expectations for an executable CQL library. Specifically, the profile requires that the library contain one of ELM XML or JSON content, the compiled representation of the CQL logic.

Usage:

- Examples for this Resource Profile: USPublicHealthExecutableLibraryExample

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Shareable Library

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Library |  | 1..1 | Shareable Library | US Public Health Executable Library
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency |  | 0..* | RelatedArtifact | Additional documentation, citations, etc.
type | S | 1..1 | code | Required dependency Fixed Value: depends-on
display | S | 0..1 | string | Brief description of the related artifact
resource | S | 1..1 | canonical(Shareable Library | US Public Health Executable ValueSet) | What resource is being referenced
parameter | S | 0..* | ParameterDefinition | Parameters defined by the library
dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library
Slices for content | S | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:elmXmlContent |  | 0..* | Attachment | ELM XML Content
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/elm+xml
data |  | 1..1 | base64Binary | Data inline, base64ed
content:elmJsonContent |  | 0..* | Attachment | ELM JSON Content
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/elm+json
data |  | 1..1 | base64Binary | Data inline, base64ed
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Library | C | 1..1 | Shareable Library | US Public Health Executable Library
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the library
version | Σ | 1..1 | string | Business version of the library
name | Σ C | 1..1 | string | Name for this library (computer friendly)
title | S Σ | 0..1 | string | Name for this library (human friendly)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 1..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.
date | S Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the library
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency |  | 0..* | RelatedArtifact | Additional documentation, citations, etc.
type | S Σ | 1..1 | code | Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
display | S Σ | 0..1 | string | Brief description of the related artifact
resource | S Σ | 1..1 | canonical(Shareable Library | US Public Health Executable ValueSet) | What resource is being referenced
parameter | S | 0..* | ParameterDefinition | Parameters defined by the library
dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library
Slices for content | S Σ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:elmXmlContent | Σ | 0..* | Attachment | ELM XML Content
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+xml
data |  | 1..1 | base64Binary | Data inline, base64ed
content:elmJsonContent | Σ | 0..* | Attachment | ELM JSON Content
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+json
data |  | 1..1 | base64Binary | Data inline, base64ed
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Library.status | required | PublicationStatus
Library.type | extensible | LibraryType
Library.jurisdiction | extensible | Jurisdiction ValueSet
Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on
Library.content:elmXmlContent.contentType | required | Fixed Value: application/elm+xml
Library.content:elmJsonContent.contentType | required | Fixed Value: application/elm+json

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Library | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
lib-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Library | C | 1..1 | Shareable Library | US Public Health Executable Library
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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the library
version | Σ | 1..1 | string | Business version of the library
name | Σ C | 1..1 | string | Name for this library (computer friendly)
title | S Σ | 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 | Σ | 1..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.
subject[x] |  | 0..1 |  | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
date | S Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the library
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this library is defined
usage |  | 0..1 | string | Describes the clinical usage of the library
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
approvalDate |  | 0..1 | date | When the library was approved by publisher
lastReviewDate |  | 0..1 | date | When the library was last reviewed
effectivePeriod | Σ | 0..1 | Period | When the library is expected to be used
topic |  | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency |  | 0..* | RelatedArtifact | Additional documentation, citations, etc.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
label | Σ | 0..1 | string | Short label
display | S Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
url | Σ | 0..1 | url | Where the artifact can be accessed
document | Σ | 0..1 | Attachment | What document is being referenced
resource | S Σ | 1..1 | canonical(Shareable Library | US Public Health Executable ValueSet) | What resource is being referenced
parameter | S | 0..* | ParameterDefinition | Parameters defined by the library
dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library
Slices for content | S Σ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:elmXmlContent | Σ | 0..* | Attachment | ELM XML Content
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+xml
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Example General: en-AU
data |  | 1..1 | base64Binary | Data inline, base64ed
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided)
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed)
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
creation | Σ | 0..1 | dateTime | Date attachment was first created
content:elmJsonContent | Σ | 0..* | Attachment | ELM JSON Content
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+json
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Example General: en-AU
data |  | 1..1 | base64Binary | Data inline, base64ed
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided)
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed)
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
creation | Σ | 0..1 | dateTime | Date attachment was first created
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Library.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Library.status | required | PublicationStatus
Library.type | extensible | LibraryType
Library.subject[x] | extensible | SubjectType
Library.jurisdiction | extensible | Jurisdiction ValueSet
Library.topic | example | DefinitionTopic
Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on
Library.content:elmXmlContent.contentType | required | Fixed Value: application/elm+xml
Library.content:elmXmlContent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Library.content:elmJsonContent.contentType | required | Fixed Value: application/elm+json
Library.content:elmJsonContent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Shareable Library

Summary

Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

- Shareable Library (http://hl7.org/fhir/StructureDefinition/shareablelibrary)
- US Public Health Executable ValueSet (http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-executable-valueset)

Slices

This structure defines the following Slices:

- The element Library.relatedArtifact is sliced based on the value of value:type
- The element Library.content is sliced based on the value of value:contentType

Differential View

This structure is derived from Shareable Library

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Library |  | 1..1 | Shareable Library | US Public Health Executable Library
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency |  | 0..* | RelatedArtifact | Additional documentation, citations, etc.
type | S | 1..1 | code | Required dependency Fixed Value: depends-on
display | S | 0..1 | string | Brief description of the related artifact
resource | S | 1..1 | canonical(Shareable Library | US Public Health Executable ValueSet) | What resource is being referenced
parameter | S | 0..* | ParameterDefinition | Parameters defined by the library
dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library
Slices for content | S | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:elmXmlContent |  | 0..* | Attachment | ELM XML Content
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/elm+xml
data |  | 1..1 | base64Binary | Data inline, base64ed
content:elmJsonContent |  | 0..* | Attachment | ELM JSON Content
contentType | S | 0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/elm+json
data |  | 1..1 | base64Binary | Data inline, base64ed
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Library | C | 1..1 | Shareable Library | US Public Health Executable Library
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the library
version | Σ | 1..1 | string | Business version of the library
name | Σ C | 1..1 | string | Name for this library (computer friendly)
title | S Σ | 0..1 | string | Name for this library (human friendly)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 1..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.
date | S Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the library
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency |  | 0..* | RelatedArtifact | Additional documentation, citations, etc.
type | S Σ | 1..1 | code | Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
display | S Σ | 0..1 | string | Brief description of the related artifact
resource | S Σ | 1..1 | canonical(Shareable Library | US Public Health Executable ValueSet) | What resource is being referenced
parameter | S | 0..* | ParameterDefinition | Parameters defined by the library
dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library
Slices for content | S Σ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:elmXmlContent | Σ | 0..* | Attachment | ELM XML Content
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+xml
data |  | 1..1 | base64Binary | Data inline, base64ed
content:elmJsonContent | Σ | 0..* | Attachment | ELM JSON Content
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+json
data |  | 1..1 | base64Binary | Data inline, base64ed
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Library.status | required | PublicationStatus
Library.type | extensible | LibraryType
Library.jurisdiction | extensible | Jurisdiction ValueSet
Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on
Library.content:elmXmlContent.contentType | required | Fixed Value: application/elm+xml
Library.content:elmJsonContent.contentType | required | Fixed Value: application/elm+json

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Library | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Library | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
lib-0 | warning | Library | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Library | C | 1..1 | Shareable Library | US Public Health Executable Library
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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | Σ | 1..1 | uri | Canonical identifier for this library, represented as a URI (globally unique)
identifier | S Σ | 0..* | Identifier | Additional identifier for the library
version | Σ | 1..1 | string | Business version of the library
name | Σ C | 1..1 | string | Name for this library (computer friendly)
title | S Σ | 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 | Σ | 1..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.
subject[x] |  | 0..1 |  | Type of individual the library content is focused on Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
subjectCodeableConcept |  |  | CodeableConcept |
subjectReference |  |  | Reference(Group) |
date | S Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 1..1 | string | Name of the publisher (organization or individual)
contact | S Σ | 0..* | ContactDetail | Contact details for the publisher
description | Σ | 1..1 | markdown | Natural language description of the library
useContext | S Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | S Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this library is defined
usage |  | 0..1 | string | Describes the clinical usage of the library
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
approvalDate |  | 0..1 | date | When the library was approved by publisher
lastReviewDate |  | 0..1 | date | When the library was last reviewed
effectivePeriod | Σ | 0..1 | Period | When the library is expected to be used
topic |  | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
author |  | 0..* | ContactDetail | Who authored the content
editor |  | 0..* | ContactDetail | Who edited the content
reviewer |  | 0..* | ContactDetail | Who reviewed the content
endorser |  | 0..* | ContactDetail | Who endorsed the content
Slices for relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. Slice: Unordered, Open by value:type
relatedArtifact:dependency |  | 0..* | RelatedArtifact | Additional documentation, citations, etc.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
type | S Σ | 1..1 | code | Required dependency Binding: RelatedArtifactType (required): The type of relationship to the related artifact. Fixed Value: depends-on
label | Σ | 0..1 | string | Short label
display | S Σ | 0..1 | string | Brief description of the related artifact
citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact
url | Σ | 0..1 | url | Where the artifact can be accessed
document | Σ | 0..1 | Attachment | What document is being referenced
resource | S Σ | 1..1 | canonical(Shareable Library | US Public Health Executable ValueSet) | What resource is being referenced
parameter | S | 0..* | ParameterDefinition | Parameters defined by the library
dataRequirement | S | 0..* | DataRequirement | What data is referenced by this library
Slices for content | S Σ | 0..* | Attachment | Contents of the library, either embedded or referenced Slice: Unordered, Open by value:contentType
content:elmXmlContent | Σ | 0..* | Attachment | ELM XML Content
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+xml
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Example General: en-AU
data |  | 1..1 | base64Binary | Data inline, base64ed
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided)
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed)
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
creation | Σ | 0..1 | dateTime | Date attachment was first created
content:elmJsonContent | Σ | 0..* | Attachment | ELM JSON Content
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contentType | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: application/elm+json
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Example General: en-AU
data |  | 1..1 | base64Binary | Data inline, base64ed
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided)
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed)
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo
creation | Σ | 0..1 | dateTime | Date attachment was first created
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Library.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Library.status | required | PublicationStatus
Library.type | extensible | LibraryType
Library.subject[x] | extensible | SubjectType
Library.jurisdiction | extensible | Jurisdiction ValueSet
Library.topic | example | DefinitionTopic
Library.relatedArtifact:dependency.type | required | Fixed Value: depends-on
Library.content:elmXmlContent.contentType | required | Fixed Value: application/elm+xml
Library.content:elmXmlContent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Library.content:elmJsonContent.contentType | required | Fixed Value: application/elm+json
Library.content:elmJsonContent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from Shareable Library

Summary

Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

- Shareable Library (http://hl7.org/fhir/StructureDefinition/shareablelibrary)
- US Public Health Executable ValueSet (http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-executable-valueset)

Slices

This structure defines the following Slices:

- The element Library.relatedArtifact is sliced based on the value of value:type
- The element Library.content is sliced based on the value of value:contentType

Other representations of profile: CSV, Excel, Schematron