Consumer Mobile Health Application Functional Framework, Release 2
2.0.1 - CI build International flag

Consumer Mobile Health Application Functional Framework, Release 2, published by HL7 International / Mobile Health. This guide is not an authorized publication; it is the continuous build for version 2.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cmhaff-ig/ and changes regularly. See the Directory of published versions

Resource Profile: FMHeader

Official URL: http://hl7.org/ehrs/uv/cmhaffr2/StructureDefinition/FMHeader Version: 2.0.1
Standards status: Informative Maturity Level: 1 Computable Name: FMHeader

This StructureDefinition represents the base EHR-S FM Header type

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0, FMHC002, FMHC004, FMHC005, FMHC006, FMHC007, FMHC010
Requirements.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Requirements.contained 0..* Resource Contained, inline Resources
Requirements.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Requirements.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Requirements.status Base required PublicationStatus 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FMHC002 warning Requirements The header should have a name. title
FMHC004 error Requirements Header must have a statement about its purpose. purpose
FMHC005 warning Requirements Header purpose statement must end in a period. purpose.toString().endsWith('.')
FMHC006 error Requirements Header must have a description. description
FMHC007 warning Requirements Header description statement must end in a period. description.toString().endsWith('.')
FMHC010 error Requirements A Header must not have criteria statements. statement.count() = 0
cnl-0 warning Requirements 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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Requirements

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: FMHC002, FMHC004, FMHC005, FMHC006, FMHC007, FMHC010

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
FMHC002 warning Requirements The header should have a name. title
FMHC004 error Requirements Header must have a statement about its purpose. purpose
FMHC005 warning Requirements Header purpose statement must end in a period. purpose.toString().endsWith('.')
FMHC006 error Requirements Header must have a description. description
FMHC007 warning Requirements Header description statement must end in a period. description.toString().endsWith('.')
FMHC010 error Requirements A Header must not have criteria statements. statement.count() = 0
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0, FMHC002, FMHC004, FMHC005, FMHC006, FMHC007, FMHC010
Requirements.id This element is included in summaries. 0..1 id Logical id of this artifact
Requirements.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Requirements.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Requirements.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Requirements.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Requirements.contained 0..* Resource Contained, inline Resources
Requirements.extension 0..* Extension Additional content defined by implementations
Requirements.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Requirements.url This element is included in summaries. C 0..1 uri Canonical identifier for this Requirements, represented as a URI (globally unique)
Constraints: cnl-1
Requirements.identifier This element is included in summaries. 0..* Identifier Additional identifier for the Requirements (business identifier)
Requirements.version This element is included in summaries. 0..1 string Business version of the Requirements
Requirements.versionAlgorithm[x] This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
Requirements.versionAlgorithm[x].versionAlgorithmString string
Requirements.versionAlgorithm[x].versionAlgorithmCoding Coding
Requirements.name This element is included in summaries. C 0..1 string Name for this Requirements (computer friendly)
Requirements.title This element is included in summaries. 0..1 string Name for this Requirements (human friendly)
Requirements.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Requirements.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Requirements.date This element is included in summaries. 0..1 dateTime Date last changed
Requirements.publisher This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
Requirements.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Requirements.description 0..1 markdown Natural language description of the requirements
Requirements.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Requirements.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for Requirements (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Requirements.purpose 0..1 markdown Why this Requirements is defined
Requirements.copyright 0..1 markdown Use and/or publishing restrictions
Requirements.copyrightLabel 0..1 string Copyright holder and year(s)
Requirements.derivedFrom This element is included in summaries. 0..* canonical(Requirements) Other set of Requirements this builds on
Requirements.reference 0..* url External artifact (rule/document etc. that) created this set of requirements
Requirements.actor 0..* canonical(ActorDefinition) Actor for these requirements
Requirements.statement 0..* BackboneElement Actual statement as markdown
Requirements.statement.id 0..1 string Unique id for inter-element referencing
Requirements.statement.extension 0..* Extension Additional content defined by implementations
Requirements.statement.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Requirements.statement.key 1..1 id Key that identifies this statement
Requirements.statement.label 0..1 string Short Human label for this statement
Requirements.statement.conformance 0..* code SHALL | SHOULD | MAY | SHOULD-NOT
Binding: ConformanceExpectation (required)
Requirements.statement.conditionality 0..1 boolean Set to true if requirements statement is conditional
Requirements.statement.requirement 1..1 markdown The actual requirement
Requirements.statement.derivedFrom 0..1 string Another statement this clarifies/restricts ([url#]key)
Requirements.statement.parent 0..1 string A larger requirement that this requirement helps to refine and enable
Requirements.statement.satisfiedBy 0..* url Design artifact that satisfies this requirement
Requirements.statement.reference 0..* url External artifact (rule/document etc. that) created this requirement
Requirements.statement.source 0..* Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who asked for this statement

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Requirements.language Base required All Languages 📍5.0.0 FHIR Std.
Requirements.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
Requirements.status Base required PublicationStatus 📍5.0.0 FHIR Std.
Requirements.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
Requirements.statement.​conformance Base required Conformance Expectation 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FMHC002 warning Requirements The header should have a name. title
FMHC004 error Requirements Header must have a statement about its purpose. purpose
FMHC005 warning Requirements Header purpose statement must end in a period. purpose.toString().endsWith('.')
FMHC006 error Requirements Header must have a description. description
FMHC007 warning Requirements Header description statement must end in a period. description.toString().endsWith('.')
FMHC010 error Requirements A Header must not have criteria statements. statement.count() = 0
cnl-0 warning Requirements 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 Requirements.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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Requirements

Summary

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0, FMHC002, FMHC004, FMHC005, FMHC006, FMHC007, FMHC010
Requirements.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Requirements.contained 0..* Resource Contained, inline Resources
Requirements.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Requirements.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Requirements.status Base required PublicationStatus 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FMHC002 warning Requirements The header should have a name. title
FMHC004 error Requirements Header must have a statement about its purpose. purpose
FMHC005 warning Requirements Header purpose statement must end in a period. purpose.toString().endsWith('.')
FMHC006 error Requirements Header must have a description. description
FMHC007 warning Requirements Header description statement must end in a period. description.toString().endsWith('.')
FMHC010 error Requirements A Header must not have criteria statements. statement.count() = 0
cnl-0 warning Requirements 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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Requirements

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: FMHC002, FMHC004, FMHC005, FMHC006, FMHC007, FMHC010

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
FMHC002 warning Requirements The header should have a name. title
FMHC004 error Requirements Header must have a statement about its purpose. purpose
FMHC005 warning Requirements Header purpose statement must end in a period. purpose.toString().endsWith('.')
FMHC006 error Requirements Header must have a description. description
FMHC007 warning Requirements Header description statement must end in a period. description.toString().endsWith('.')
FMHC010 error Requirements A Header must not have criteria statements. statement.count() = 0

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Requirements C 0..* Requirements A set of requirements - features of systems that are necessary
Constraints: cnl-0, FMHC002, FMHC004, FMHC005, FMHC006, FMHC007, FMHC010
Requirements.id This element is included in summaries. 0..1 id Logical id of this artifact
Requirements.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Requirements.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Requirements.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Requirements.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Requirements.contained 0..* Resource Contained, inline Resources
Requirements.extension 0..* Extension Additional content defined by implementations
Requirements.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Requirements.url This element is included in summaries. C 0..1 uri Canonical identifier for this Requirements, represented as a URI (globally unique)
Constraints: cnl-1
Requirements.identifier This element is included in summaries. 0..* Identifier Additional identifier for the Requirements (business identifier)
Requirements.version This element is included in summaries. 0..1 string Business version of the Requirements
Requirements.versionAlgorithm[x] This element is included in summaries. 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
Requirements.versionAlgorithm[x].versionAlgorithmString string
Requirements.versionAlgorithm[x].versionAlgorithmCoding Coding
Requirements.name This element is included in summaries. C 0..1 string Name for this Requirements (computer friendly)
Requirements.title This element is included in summaries. 0..1 string Name for this Requirements (human friendly)
Requirements.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Requirements.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Requirements.date This element is included in summaries. 0..1 dateTime Date last changed
Requirements.publisher This element is included in summaries. 0..1 string Name of the publisher/steward (organization or individual)
Requirements.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Requirements.description 0..1 markdown Natural language description of the requirements
Requirements.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Requirements.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for Requirements (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Requirements.purpose 0..1 markdown Why this Requirements is defined
Requirements.copyright 0..1 markdown Use and/or publishing restrictions
Requirements.copyrightLabel 0..1 string Copyright holder and year(s)
Requirements.derivedFrom This element is included in summaries. 0..* canonical(Requirements) Other set of Requirements this builds on
Requirements.reference 0..* url External artifact (rule/document etc. that) created this set of requirements
Requirements.actor 0..* canonical(ActorDefinition) Actor for these requirements
Requirements.statement 0..* BackboneElement Actual statement as markdown
Requirements.statement.id 0..1 string Unique id for inter-element referencing
Requirements.statement.extension 0..* Extension Additional content defined by implementations
Requirements.statement.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Requirements.statement.key 1..1 id Key that identifies this statement
Requirements.statement.label 0..1 string Short Human label for this statement
Requirements.statement.conformance 0..* code SHALL | SHOULD | MAY | SHOULD-NOT
Binding: ConformanceExpectation (required)
Requirements.statement.conditionality 0..1 boolean Set to true if requirements statement is conditional
Requirements.statement.requirement 1..1 markdown The actual requirement
Requirements.statement.derivedFrom 0..1 string Another statement this clarifies/restricts ([url#]key)
Requirements.statement.parent 0..1 string A larger requirement that this requirement helps to refine and enable
Requirements.statement.satisfiedBy 0..* url Design artifact that satisfies this requirement
Requirements.statement.reference 0..* url External artifact (rule/document etc. that) created this requirement
Requirements.statement.source 0..* Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Who asked for this statement

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Requirements.language Base required All Languages 📍5.0.0 FHIR Std.
Requirements.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
Requirements.status Base required PublicationStatus 📍5.0.0 FHIR Std.
Requirements.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
Requirements.statement.​conformance Base required Conformance Expectation 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FMHC002 warning Requirements The header should have a name. title
FMHC004 error Requirements Header must have a statement about its purpose. purpose
FMHC005 warning Requirements Header purpose statement must end in a period. purpose.toString().endsWith('.')
FMHC006 error Requirements Header must have a description. description
FMHC007 warning Requirements Header description statement must end in a period. description.toString().endsWith('.')
FMHC010 error Requirements A Header must not have criteria statements. statement.count() = 0
cnl-0 warning Requirements 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 Requirements.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())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Requirements

Summary

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron