HL7 Electronic Health Record System Functional Model, Release 2.1.1
2.1.1-ballot - Normative Ballot

Publication Build: This will be filled in by the publication tooling

## Resource Profile: FMFunction

Official URL: http://hl7.org/ehrs/uv/ehrsfmr2/StructureDefinition/FMFunction | Version: 2.1.1-ballot
Standards status: Normative | Maturity Level: 1 | Computable Name: FMFunction

This StructureDefinition represents the base EHR-S FM Function type

Usage:

- Examples for this Resource Profile: AS_1_1_Manage_Provider_Registry_or_Directory, AS_1_2_Manage_Provider_s_Location_Within_Facility, AS_1_3_Provider_s_On_Call_Location, AS_1_4_Manage_Provider_s_Location_s__or_Office_s_... Show 301 more, AS_1_5_Team_Group_of_Providers_Registry_or_Directory, AS_1_6_Provider_Caseload_Panel, AS_1_7_Manage_Practitioner_Patient_Relationships, AS_1_8_Support_for_Provider_Credentialing, AS_2_1_Synchronize_Patient_Demographic_Data, AS_2_2_Manage_Patient_s_Location_Within_Facility, AS_2_3_Manage_Patient_s_Residence_for_the_Provision_and_Administration_of_Services, AS_2_4_Manage_Patient_Bed_Assignment, AS_2_5_Manage_Patients_in_Healthcare_Programs, AS_2_6_Manage_Patient_Privacy_Consent_Directives, AS_2_Manage_Patient_Demographics__Location_and_Synchronization, AS_3_1_Manage_Information_Exchange_with_Patient_PHR, AS_3_2_1_Manage_Consents_and_Authorizations_from_a_PHR, AS_3_2_2_Manage_PHR_End_of_Life_Documents_and_Other_Advance_Directives, AS_4_1_Manage_Registry_Communication, AS_4_2_Support_for_Communications_Within_an_Organization, AS_4_3_Support_for_Communications_Between_Organizations, AS_4_4_Support_for_Provider_Employer_Communications, AS_5_1_Clinical_Task_Creation__Assignment_and_Routing, AS_5_2_Clinical_Task_Assignment_and_Routing_for_Medication_Management___Administration, AS_5_3_Clinical_Task_Linking, AS_5_4_Clinical_Task_Status_Tracking, AS_6_1_Manage_Facility_Demographics, AS_6_2_Manage_Healthcare_Resource_Availability_Information, AS_6_3_Manage_Healthcare_Resource_Scheduling, AS_6_4_Support_Triage_Categorization, AS_6_5_Support_Waiting_Room_Management, AS_6_6_Support_Patient_Acuity_and_Severity_Determination, AS_7_1_Manage_Presentation_Filters, AS_7_2_Support_Encounter_Documentation, AS_7_3_Support_Financial_Reporting, AS_7_4_Support_Remote_Healthcare_Services, AS_7_5_Manage_Transitions_of_Care_and_Discharged_Patients, AS_8_1_Support_Rules_Driven_Clinical_Coding, AS_8_2_Support_Rules_Driven_Financial___Administrative_Coding, AS_8_3_Support_Integration_of_Cost_Financial_information_into_Patient_Care, AS_8_4_Manage_Healthcare_Facility_Performance_Information, AS_8_5_Support_for_Provider_Training, AS_9_1_Support_Financial_Plan_Enrollment, AS_9_2_Support_Financial_Eligibility_Verification, AS_9_3_Support_Service_Authorizations, AS_9_4_Support_Service_Requests_and_Claims, AS_9_5_Support_Financial_Claims___Encounter_Reports, CP_1_1_Manage_Patient_History, CP_1_2_Manage_Allergy__Intolerance_and_Adverse_Reaction_List, CP_1_3_Manage_Medication_List, CP_1_4_Manage_Problem_List, CP_1_5_Manage_Health_Related_Factors_List, CP_1_6_Manage_Immunization_List, CP_1_7_Manage_Medical_Equipment__Prosthetic_Orthotic__Device_List, CP_1_8_Manage_Patient_and_Family_Preferences, CP_1_9_Manage_Adverse_Events, CP_2_1_Render_externally_sourced_Clinical_Documents, CP_2_2_Render_externally_sourced_Data, CP_2_3_Render_Emergency_Medical_System_Originated_Data, CP_2_4_Render_externally_sourced_Clinical_Images, CP_2_5_Manage_Patient_Originated_Data, CP_2_Render_externally_sourced_Information, CP_3_1_Conduct_Assessments, CP_3_2_Manage_Patient_Clinical_Measurements, CP_3_3_Manage_Clinical_Documents_and_Notes, CP_3_4_Manage_Patient_Specific_Care_and_Treatment_Plans, CP_3_5_Acknowledge_Amend_Other_Provider_Documentation, CP_4_1_Use_Order_Sets, CP_4_2_1_Medication_Interaction_and_Allergy_Checking, CP_4_2_2_Patient_Specific_Medication_Dosing_and_Warnings, CP_4_2_3_Medication_Order_Efficiencies, CP_4_2_4_Medication_Alert_Overrides, CP_4_2_Manage_Medication_Orders, CP_4_3_Manage_Non_Medication_Patient_Care_Orders, CP_4_4_Manage_Orders_for_Diagnostic_Screening_Tests, CP_4_5_Manage_Orders_for_Blood_Products_and_Other_Biologics, CP_4_6_Manage_Orders_for_Referral, CP_4_Manage_Orders, CP_5_1_Manage_Results_of_Diagnostic_Tests, CP_5_Manage_Results , CP_6_1_Manage_Medication_Administration, CP_6_2_Manage_Immunization_Administration, CP_6_3_Manage_Treatment_Administration, CP_7_1_Present_Guidelines_and_Protocols_for_Planning_Care, CP_7_2_Manage_Recommendations_for_Future_Care, CP_8_1_Generate__Record_and_Distribute_Patient_Specific_Instructions, CP_9_1_Produce_a_Summary_Record_of_Care, CP_9_2_Capture_Health_Service_Report_Information, CPS_1_1_Manage_a_Patient_Record, CPS_1_2_Manage_Patient_Demographics, CPS_1_3_Capture_Quick_Registration, CPS_1_4_Capture_Referral_Request, CPS_1_5_Manage_Patient_Encounter, CPS_1_6_1_Related_by_Genealogy, CPS_1_6_2_Related_by_Insurance, CPS_1_6_3_Related_by_Living_Situation, CPS_1_6_4_Related_by_Other_Means, CPS_1_7_1_Support_for_Patient_and_Family_Preferences, CPS_1_7_2_Manage_Patient_Advance_Directives, CPS_1_7_3_Manage_Consents_and_Authorizations, CPS_1_7_Preferences__Directives__Consents_and_Authorizations, CPS_10_Manage_User_Help, CPS_2_1_Support_externally_sourced_Clinical_Documents, CPS_2_2_Support_externally_sourced_Clinical_Data, CPS_2_3_Support_Emergency_Medical_System_Originated_Data, CPS_2_4_Support_externally_sourced_Clinical_Images, CPS_2_5_Support_patient_originated_Data, CPS_2_6_Support_Patient_Health_Data_Derived_from_Administrative_and_Financial_Data_and_Documentation, CPS_2_7_Support_Patient_Data_Derived_from_Eligibility__Formulary_and_Benefit_Documentation_for_Electronic_Prescribing, CPS_2_8_Support_Medical_Device_Originated_Data, CPS_2_Support_externally_sourced_Information, CPS_3_1_Support_for_Standard_Assessments, CPS_3_10_Support_for_Identification_of_Potential_Problems_and_Trends, CPS_3_11_Support_Other_Encounter_and_Episode_of_Care_Documentation, CPS_3_12_Manage_Health_Information_Record_Quality, CPS_3_2_Support_for_Patient_Context__Driven_Assessments, CPS_3_3_Support_for_Standard_Care_Plans__Guidelines__Protocols, CPS_3_4_Support_for_Context_Sensitive_Care_Plans__Guidelines__Protocols, CPS_3_5_Support_for_Research_Protocols_Relative_to_Individual_Patient_Care, CPS_3_6_Support_Self_Care, CPS_3_7_Capture_Guidelines_and_Standards_from_External_Sources, CPS_3_8_Manage_Documentation_of_Clinician_Response_to_Decision_Support_Prompts, CPS_3_9_Clinical_Decision_Support_System_Guidelines_Updates, CPS_4_1_Manage_Order_Set_Templates, CPS_4_2_1_Support_for_Medication_Interaction_and_Allergy_Checking, CPS_4_2_2_Support_for_patient_specific_Dosing_and_Warnings, CPS_4_2_3_Support_for_Medication_Ordering_Efficiencies, CPS_4_2_4_Support_for_Medication_Recommendations, CPS_4_2_5_Support_for_Medication_Reconciliation, CPS_4_2_Support_for_Medication_and_Immunization_Ordering, CPS_4_3_Support_for_Non_Medication_Ordering, CPS_4_6_1_Support_for_Referral_Process, CPS_4_6_2_Support_for_Referral_Recommendations, CPS_4_6_3_Support_for_Electronic_Referral_Ordering, CPS_5_Support_for_Results, CPS_6_1_Support_for_Medication_Administration, CPS_6_2_Support_for_Immunization_Administration, CPS_6_3_Support_for_Safe_Blood_Administration, CPS_6_4_Support_for_Accurate_Specimen_Collection, CPS_7_1_Access_Healthcare_Guidance, CPS_8_1_Patient_Knowledge_Access, CPS_8_2_Patient_Education_Material_Updates, CPS_8_3_Patient_Reminder_Information_Updates, CPS_8_4_Support_for_Communications_Between_Provider_and_Patient__and_or_the_Patient_Representative, CPS_8_5_Patient__Family_and_Care_Giver_Education, CPS_8_6_Communication_with_Personal_Health_Record_Systems, CPS_9_1_Clinical_Communication_Management_and_Support, CPS_9_2_1_Manage_Consultation_Requests_and_Responses, CPS_9_2_2_Support_for_Provider_to_Professional_Communication, CPS_9_2_3_Support_for_Provider__Pharmacy_Communication, CPS_9_2_Support_for_Inter_Provider_Communication, CPS_9_3_Health_Record_Output, CPS_9_4_Standard_Report_Generation, CPS_9_5_Ad_Hoc_Query_and_Rendering, CPS_9_6_Information_View, OV_1_Overarching_Criteria, POP_1_1_Present_Alerts_for_Preventative_Services_and_Wellness, POP_1_2_Present_Notifications_and_Reminders_for_Preventative_Services_and_Wellness, POP_10_Manage_Population_Health_Study_Related_Identifiers, POP_2_1_Support_for_Epidemiological_Investigation_Surveillance_Data_Collection , POP_2_2_Support_for_Epidemiologic_Data_Analysis, POP_2_3_Support_for_Cohort_and_Aggregate_Data_Sharing, POP_3_Support_for_Notification_and_Response, POP_4_Support_for_Monitoring_Response_Notifications_Regarding_a_Specific_Patient_s_Health, POP_5_Donor_Management_Support, POP_6_1_Outcome_Measures_and_Analysis, POP_6_2_Quality__Performance_and_Accountability_Measures, POP_6_3_Support_for_Process_Improvement, POP_6_4_Support_for_Care_System_Performance_Indicators__Dashboards_, POP_7_Public_Health_Related_Updates, POP_8_De_Identified_Data_Request_Management, POP_9_Support_Consistent_Healthcare_Management_of_Patient_Groups_or_Populations, RI_1_1_1_1_Evidence_of_Record_Entry_Originate_Retain_Event, RI_1_1_1_Originate_Retain_Record_Lifecycle_Event, RI_1_1_10_1_Evidence_of_Record_Entry_De_Identification_Event, RI_1_1_10_De_Identify__Anononymize__Record_Lifecycle_Event, RI_1_1_11_1_Evidence_of_Record_Entry_Pseudomynization_Event, RI_1_1_11_Pseudonymize_Record_Lifecycle_Event, RI_1_1_12_1_Evidence_of_Record_Entry_Re_Identification_Event, RI_1_1_12_Re_identify_Record_Lifecycle_Event, RI_1_1_13_1_Evidence_of_Record_Entry_Extraction_Event, RI_1_1_13_Extract_Record_Lifecycle_Event, RI_1_1_14_1_Evidence_of_Record_Entry_Archive_Event, RI_1_1_14_Archive_Record_Lifecycle_Event, RI_1_1_15_1_Evidence_of_Record_Entry_Restore_Event, RI_1_1_15_Restore_Record_Lifecycle_Event, RI_1_1_16_1_Evidence_of_Record_Entry_Destruction_Event, RI_1_1_16_Destroy_Delete_Record_Lifecycle_Event, RI_1_1_17_1_Evidence_of_Record_Entry_Deprecation_Retraction_Event, RI_1_1_17_Deprecate_Record_Lifecycle_Event, RI_1_1_18_1_Evidence_of_Record_Entry_Re_Activation_Event, RI_1_1_18_Re_activate_Record_Lifecycle_Event, RI_1_1_19_1_Evidence_of_Record_Entry_Merge_Event, RI_1_1_19_Merge_Record_Lifecycle_Event, RI_1_1_2_1_Evidence_of_Record_Entry_Amendment_Event, RI_1_1_2_Amend__Update__Record_Lifecycle_Event, RI_1_1_20_1_Evidence_of_Record_Entry_Unmerge_Event, RI_1_1_20_Unmerge_Record_Lifecycle_Event, RI_1_1_21_1_Evidence_of_Record_Entry_Link_Event, RI_1_1_21_Link_Record_Lifecycle_Event, RI_1_1_22_1_Evidence_of_Record_Entry_Unlink_Event, RI_1_1_22_Unlink_Record_Lifecycle_Event, RI_1_1_23_1_Evidence_of_Record_Entry_Legal_Hold_Event, RI_1_1_23_Add_Legal_Hold_Record_Lifecycle_Event, RI_1_1_24_1_Evidence_of_Record_Entry_Legal_Hold_Removal_Event, RI_1_1_24_Remove_Legal_Hold_Record_Lifecycle_Event, RI_1_1_25_1_Evidence_of_Record_Entry_Verification_Event, RI_1_1_25_Verify_Record_Entries, RI_1_1_26_1_Evidence_of_Record_Entry_Encryption_Event, RI_1_1_26_Encrypt_Record_Entries, RI_1_1_27_1_Evidence_of_Record_Entry_Decryption_Event, RI_1_1_27_Decrypt_Record_Entries, RI_1_1_3_1_Evidence_of_Record_Entry_Translate_Event, RI_1_1_3_Transform_Translate_Record_Lifecycle_Event, RI_1_1_4_1_Evidence_of_Record_Entry_Attestation_Event, RI_1_1_4_Attest_Record_Lifecycle_Event, RI_1_1_5_1_Evidence_of_Record_Entry_View_Access_Event, RI_1_1_5_Access_View_Record_Lifecycle_Event, RI_1_1_6_1_Evidence_of_Record_Entry_Output_Report_Event, RI_1_1_6_Report__Output__Record_Lifecycle_Event, RI_1_1_7_1_Evidence_of_Record_Entry_Disclosure_Event, RI_1_1_7_Disclose_Record_Lifecycle_Event, RI_1_1_8_1_Evidence_of_Record_Entry_Transmit_Event, RI_1_1_8_Transmit_Record_Lifecycle_Event, RI_1_1_9_1_Evidence_of_Record_Entry_Receive_Retain_Event, RI_1_1_9_Receive_Retain_Record_Lifecycle_Event, RI_1_1_Record_Lifecycle, RI_1_2_1_Manage_Record_Entries, RI_1_2_2_Manage_Record_Entries_for_Legal_Hold, RI_1_3_1_Manage_Record_Pending_State, RI_1_3_2_Manage_Record_Entry_Amended__Corrected_and_Augmented_State, RI_1_3_3_Manage_Record_Entry_Succession_and_Version_Control, RI_1_3_4_Manage_Record_Entry_Retraction, RI_1_4_Record_Completeness, RI_2_Record_Synchronization, RI_3_Record_Archive_and_Restore, TI_1_1_Entity_Authentication, TI_1_10_Service_Availability, TI_1_11_Trusted_Information_Exchange_Environment, TI_1_2_Entity_Authorization , TI_1_3_1_Emergency_Access_Control, TI_1_3_Entity_Access_Control, TI_1_4_Patient_Access_Management, TI_1_5_Non_Repudiation, TI_1_6_Secure_Data_Exchange, TI_1_7_Secure_Data_Routing, TI_1_8_1_Redact_Patient_Identifying_Information, TI_1_8_2_Protect_Individual_Patient_Identity, TI_1_8_Patient_Privacy_and_Confidentiality, TI_1_9_System_Operation_Measurements, TI_10_1_Standard_or_Preferred_Clinical_Models, TI_10_2_Maintenance_and_Versioning_of_Standard_or_Preferred_Clinical_Models, TI_10_3_Clinical_Model_Mapping, TI_2_1_1_Record_Entry_Audit_Triggers, TI_2_1_2_1_Security_Event_Security_Audit_Trigger, TI_2_1_2_2_User_Authentication_to_the_System__Start_user_session__Security_Audit_Trigger, TI_2_1_2_3_User_Authentication__System_Prompt_for_Password_Change__Security_Audit_Trigger, TI_2_1_2_4_User_Request_to_Change_Password_Security_Audit_Trigger, TI_2_1_2_5_User_Log_Out__End_user_session__Security_Audit_Trigger, TI_2_1_2_6_User_Access__Successful__Security_Audit_Trigger, TI_2_1_2_7_User_Attempts_to_Access_Data__Unsuccessful___Access_Denied__Security_Audit_Trigger, TI_2_1_2_8_Extraordinary_User_Access__Break_the_Glass__Security_Audit_Trigger, TI_2_1_2_9_User_Permissions__Authorization__Security_Audit_Trigger, TI_2_1_2_Security_Audit_Triggers, TI_2_1_3_1_System_Event_System_Audit_Trigger, TI_2_1_3_10_Maintenance_Completed_System_Audit_Trigger, TI_2_1_3_11_Resource_Usage_System_Audit_Trigger, TI_2_1_3_12_System_Maintenance_Events__Local_Access_System_Audit_Trigger, TI_2_1_3_13_System_Maintenance_Events__Remote_Access_System_Audit_Trigger, TI_2_1_3_14_System_Maintenance___EHR_or_Clinical_Software_System_Audit_Trigger, TI_2_1_3_15_System_Maintenance___Codes__Vocabulary__Knowledge__Rules_System_Audit_Trigger, TI_2_1_3_16_Data_Corruption_System_Audit_Trigger, TI_2_1_3_2_System_Started_System_Audit_Trigger, TI_2_1_3_3_Back_Up_Started_System_Audit_Trigger, TI_2_1_3_4_Back_Up_Completed_System_Audit_Trigger, TI_2_1_3_5_Back_Up_Recovery_Started_System_Audit_Trigger, TI_2_1_3_6_Back_Up_Recovery_Completed_System_Audit_Trigger, TI_2_1_3_7_Batch_Job_Started_System_Audit_Trigger, TI_2_1_3_8_Batch_Job_Completed_System_Audit_Trigger, TI_2_1_3_9_Maintenance_Started_System_Audit_Trigger, TI_2_1_3_System_Audit_Triggers, TI_2_1_4_1_Clinical_Alerts_Clinical_Audit_Trigger, TI_2_1_4_2_Acknowledgements_of_Clinically_Significant_Report_Changes_Clinical_Audit_Trigger, TI_2_1_4_3_Disable_Decision_Support_Alerts_Clinical_Audit_Trigger, TI_2_1_4_Clinical_Audit_Triggers, TI_2_1_Audit_Triggers, TI_2_2_1_Audit_Log_Indelibility, TI_2_2_Audit_Log_Management, TI_2_3_Audit_Notification_and_Review, TI_2_Audit, TI_3_Registry_and_Directory_Services, TI_4_1_Standard_Terminology_and_Terminology_Models, TI_4_2_Maintenance_and_Versioning_of_Standard_Terminologies, TI_4_3_Terminology_Mapping, TI_5_1_1_Application_Interchange_Standards, TI_5_1_2_Structured_Document_Interchange_Standards, TI_5_1_3_Structured_Message_Interchange_Standards, TI_5_2_Interchange_Standards_Versioning_and_Maintenance, TI_5_3_Standards_Based_Application_Integration, TI_5_4_Interchange_Agreements, TI_5_5_System_Integration, TI_6_Business_Rules_Management, TI_7_Workflow_Management, TI_8_Database_Backup_and_Recovery and TI_9_System_Management_Operations_and_Performance

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Requirements | C | 0..* | Requirements | A set of requirements - features of systems that are necessary cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation FMFLC08: Function names must not end with a period. FMFLC09: Function must have a statement about its purpose. FMFLC10: Function purpose statement must end in a period. FMFLC11: Function must have a description. FMFLC12: Function description statement must end in a period. FMFLC13: Function must have one or more conformance criteria statements.
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 ext-1: Must have either extensions or value[x], not both
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
statement | C | 0..* | BackboneElement | Actual statement as markdown ele-1: All FHIR elements must have a @value or children FMTSR03: The text is not single spaced (there are multiple spaces). FMCC001: The Conditional Criteria is not structured correctly. FMCC002: The Criteria is structured as conditional but conditional is not indicated. FMSVR08: Optionality attribute does not match the optionality in the text. FMFLC15: Criterion must have a textual description.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
key |  | 1..1 | id | Key that identifies this statement ele-1: All FHIR elements must have a @value or children
requirement |  | 1..1 | markdown | The actual requirement ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Requirements.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
FMCC001 | warning | Requirements.statement | The Conditional Criteria is not structured correctly. : (conditionality and requirement.toString().startsWith('IF ').not()).not() |
FMCC002 | warning | Requirements.statement | The Criteria is structured as conditional but conditional is not indicated. : (conditionality.not() and requirement.toString().startsWith('IF ')).not() |
FMFLC08 | warning | Requirements | Function names must not end with a period. : title.endsWith('.').not() |
FMFLC09 | error | Requirements | Function must have a statement about its purpose. : purpose |
FMFLC10 | warning | Requirements | Function purpose statement must end in a period. : purpose.toString().endsWith('.') |
FMFLC11 | error | Requirements | Function must have a description. : description |
FMFLC12 | warning | Requirements | Function description statement must end in a period. : description.toString().endsWith('.') |
FMFLC13 | error | Requirements | Function must have one or more conformance criteria statements. : statement.count() > 0 |
FMFLC15 | error | Requirements.statement | Criterion must have a textual description. : requirement.hasValue() |
FMSVR08 | warning | Requirements.statement | Optionality attribute does not match the optionality in the text. : requirement.toString().contains(conformance.first()) |
FMTSR03 | warning | Requirements.statement | The text is not single spaced (there are multiple spaces). : requirement.toString().contains(' ').not() |
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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Requirements | C | 0..* | Requirements | A set of requirements - features of systems that are necessary FMFLC08: Function names must not end with a period. FMFLC09: Function must have a statement about its purpose. FMFLC10: Function purpose statement must end in a period. FMFLC11: Function must have a description. FMFLC12: Function description statement must end in a period. FMFLC13: Function must have one or more conformance criteria statements.
statement | C | 0..* | BackboneElement | Actual statement as markdown FMTSR03: The text is not single spaced (there are multiple spaces). FMCC001: The Conditional Criteria is not structured correctly. FMCC002: The Criteria is structured as conditional but conditional is not indicated. FMSVR08: Optionality attribute does not match the optionality in the text. FMFLC15: Criterion must have a textual description.
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
FMCC001 | warning | Requirements.statement | The Conditional Criteria is not structured correctly. : (conditionality and requirement.toString().startsWith('IF ').not()).not() |
FMCC002 | warning | Requirements.statement | The Criteria is structured as conditional but conditional is not indicated. : (conditionality.not() and requirement.toString().startsWith('IF ')).not() |
FMFLC08 | warning | Requirements | Function names must not end with a period. : title.endsWith('.').not() |
FMFLC09 | error | Requirements | Function must have a statement about its purpose. : purpose |
FMFLC10 | warning | Requirements | Function purpose statement must end in a period. : purpose.toString().endsWith('.') |
FMFLC11 | error | Requirements | Function must have a description. : description |
FMFLC12 | warning | Requirements | Function description statement must end in a period. : description.toString().endsWith('.') |
FMFLC13 | error | Requirements | Function must have one or more conformance criteria statements. : statement.count() > 0 |
FMFLC15 | error | Requirements.statement | Criterion must have a textual description. : requirement.hasValue() |
FMSVR08 | warning | Requirements.statement | Optionality attribute does not match the optionality in the text. : requirement.toString().contains(conformance.first()) |
FMTSR03 | warning | Requirements.statement | The text is not single spaced (there are multiple spaces). : requirement.toString().contains(' ').not() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Requirements | C | 0..* | Requirements | A set of requirements - features of systems that are necessary cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation FMFLC08: Function names must not end with a period. FMFLC09: Function must have a statement about its purpose. FMFLC10: Function purpose statement must end in a period. FMFLC11: Function must have a description. FMFLC12: Function description statement must end in a period. FMFLC13: Function must have one or more conformance criteria statements.
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
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 Requirements, 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 Requirements (business identifier)
version | Σ | 0..1 | string | Business version of the Requirements
versionAlgorithm[x] | Σ | 0..1 |  | How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString |  |  | string |
versionAlgorithmCoding |  |  | Coding |
name | Σ C | 0..1 | string | Name for this Requirements (computer friendly)
title | Σ | 0..1 | string | Name for this Requirements (human friendly)
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
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 requirements
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for Requirements (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this Requirements is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
copyrightLabel |  | 0..1 | string | Copyright holder and year(s)
derivedFrom | Σ | 0..* | canonical(Requirements) | Other set of Requirements this builds on
reference |  | 0..* | url | External artifact (rule/document etc. that) created this set of requirements
actor |  | 0..* | canonical(ActorDefinition) | Actor for these requirements
statement | C | 0..* | BackboneElement | Actual statement as markdown FMTSR03: The text is not single spaced (there are multiple spaces). FMCC001: The Conditional Criteria is not structured correctly. FMCC002: The Criteria is structured as conditional but conditional is not indicated. FMSVR08: Optionality attribute does not match the optionality in the text. FMFLC15: Criterion must have a textual description.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
key |  | 1..1 | id | Key that identifies this statement
label |  | 0..1 | string | Short Human label for this statement
conformance |  | 0..* | code | SHALL | SHOULD | MAY | SHOULD-NOT Binding: ConformanceExpectation (required)
conditionality |  | 0..1 | boolean | Set to true if requirements statement is conditional
requirement |  | 1..1 | markdown | The actual requirement
derivedFrom |  | 0..1 | string | Another statement this clarifies/restricts ([url#]key)
parent |  | 0..1 | string | A larger requirement that this requirement helps to refine and enable
satisfiedBy |  | 0..* | url | Design artifact that satisfies this requirement
reference |  | 0..* | url | External artifact (rule/document etc. that) created this requirement
source |  | 0..* | Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who asked for this statement
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Requirements.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` from the FHIR Standard
Requirements.versionAlgorithm[x] | extensible | VersionAlgorithm `http://hl7.org/fhir/ValueSet/version-algorithm` from the FHIR Standard
Requirements.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` from the FHIR Standard
Requirements.jurisdiction | extensible | JurisdictionValueSet `http://hl7.org/fhir/ValueSet/jurisdiction` from the FHIR Standard
Requirements.statement.conformance | required | ConformanceExpectation `http://hl7.org/fhir/ValueSet/conformance-expectation|5.0.0` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
FMCC001 | warning | Requirements.statement | The Conditional Criteria is not structured correctly. : (conditionality and requirement.toString().startsWith('IF ').not()).not() |
FMCC002 | warning | Requirements.statement | The Criteria is structured as conditional but conditional is not indicated. : (conditionality.not() and requirement.toString().startsWith('IF ')).not() |
FMFLC08 | warning | Requirements | Function names must not end with a period. : title.endsWith('.').not() |
FMFLC09 | error | Requirements | Function must have a statement about its purpose. : purpose |
FMFLC10 | warning | Requirements | Function purpose statement must end in a period. : purpose.toString().endsWith('.') |
FMFLC11 | error | Requirements | Function must have a description. : description |
FMFLC12 | warning | Requirements | Function description statement must end in a period. : description.toString().endsWith('.') |
FMFLC13 | error | Requirements | Function must have one or more conformance criteria statements. : statement.count() > 0 |
FMFLC15 | error | Requirements.statement | Criterion must have a textual description. : requirement.hasValue() |
FMSVR08 | warning | Requirements.statement | Optionality attribute does not match the optionality in the text. : requirement.toString().contains(conformance.first()) |
FMTSR03 | warning | Requirements.statement | The text is not single spaced (there are multiple spaces). : requirement.toString().contains(' ').not() |
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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Requirements | C | 0..* | Requirements | A set of requirements - features of systems that are necessary cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation FMFLC08: Function names must not end with a period. FMFLC09: Function must have a statement about its purpose. FMFLC10: Function purpose statement must end in a period. FMFLC11: Function must have a description. FMFLC12: Function description statement must end in a period. FMFLC13: Function must have one or more conformance criteria statements.
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 ext-1: Must have either extensions or value[x], not both
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
statement | C | 0..* | BackboneElement | Actual statement as markdown ele-1: All FHIR elements must have a @value or children FMTSR03: The text is not single spaced (there are multiple spaces). FMCC001: The Conditional Criteria is not structured correctly. FMCC002: The Criteria is structured as conditional but conditional is not indicated. FMSVR08: Optionality attribute does not match the optionality in the text. FMFLC15: Criterion must have a textual description.
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
key |  | 1..1 | id | Key that identifies this statement ele-1: All FHIR elements must have a @value or children
requirement |  | 1..1 | markdown | The actual requirement ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Requirements.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
FMCC001 | warning | Requirements.statement | The Conditional Criteria is not structured correctly. : (conditionality and requirement.toString().startsWith('IF ').not()).not() |
FMCC002 | warning | Requirements.statement | The Criteria is structured as conditional but conditional is not indicated. : (conditionality.not() and requirement.toString().startsWith('IF ')).not() |
FMFLC08 | warning | Requirements | Function names must not end with a period. : title.endsWith('.').not() |
FMFLC09 | error | Requirements | Function must have a statement about its purpose. : purpose |
FMFLC10 | warning | Requirements | Function purpose statement must end in a period. : purpose.toString().endsWith('.') |
FMFLC11 | error | Requirements | Function must have a description. : description |
FMFLC12 | warning | Requirements | Function description statement must end in a period. : description.toString().endsWith('.') |
FMFLC13 | error | Requirements | Function must have one or more conformance criteria statements. : statement.count() > 0 |
FMFLC15 | error | Requirements.statement | Criterion must have a textual description. : requirement.hasValue() |
FMSVR08 | warning | Requirements.statement | Optionality attribute does not match the optionality in the text. : requirement.toString().contains(conformance.first()) |
FMTSR03 | warning | Requirements.statement | The text is not single spaced (there are multiple spaces). : requirement.toString().contains(' ').not() |
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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Requirements | C | 0..* | Requirements | A set of requirements - features of systems that are necessary FMFLC08: Function names must not end with a period. FMFLC09: Function must have a statement about its purpose. FMFLC10: Function purpose statement must end in a period. FMFLC11: Function must have a description. FMFLC12: Function description statement must end in a period. FMFLC13: Function must have one or more conformance criteria statements.
statement | C | 0..* | BackboneElement | Actual statement as markdown FMTSR03: The text is not single spaced (there are multiple spaces). FMCC001: The Conditional Criteria is not structured correctly. FMCC002: The Criteria is structured as conditional but conditional is not indicated. FMSVR08: Optionality attribute does not match the optionality in the text. FMFLC15: Criterion must have a textual description.
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
FMCC001 | warning | Requirements.statement | The Conditional Criteria is not structured correctly. : (conditionality and requirement.toString().startsWith('IF ').not()).not() |
FMCC002 | warning | Requirements.statement | The Criteria is structured as conditional but conditional is not indicated. : (conditionality.not() and requirement.toString().startsWith('IF ')).not() |
FMFLC08 | warning | Requirements | Function names must not end with a period. : title.endsWith('.').not() |
FMFLC09 | error | Requirements | Function must have a statement about its purpose. : purpose |
FMFLC10 | warning | Requirements | Function purpose statement must end in a period. : purpose.toString().endsWith('.') |
FMFLC11 | error | Requirements | Function must have a description. : description |
FMFLC12 | warning | Requirements | Function description statement must end in a period. : description.toString().endsWith('.') |
FMFLC13 | error | Requirements | Function must have one or more conformance criteria statements. : statement.count() > 0 |
FMFLC15 | error | Requirements.statement | Criterion must have a textual description. : requirement.hasValue() |
FMSVR08 | warning | Requirements.statement | Optionality attribute does not match the optionality in the text. : requirement.toString().contains(conformance.first()) |
FMTSR03 | warning | Requirements.statement | The text is not single spaced (there are multiple spaces). : requirement.toString().contains(' ').not() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Requirements | C | 0..* | Requirements | A set of requirements - features of systems that are necessary cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation FMFLC08: Function names must not end with a period. FMFLC09: Function must have a statement about its purpose. FMFLC10: Function purpose statement must end in a period. FMFLC11: Function must have a description. FMFLC12: Function description statement must end in a period. FMFLC13: Function must have one or more conformance criteria statements.
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
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 Requirements, 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 Requirements (business identifier)
version | Σ | 0..1 | string | Business version of the Requirements
versionAlgorithm[x] | Σ | 0..1 |  | How to compare versions Binding: VersionAlgorithm (extensible)
versionAlgorithmString |  |  | string |
versionAlgorithmCoding |  |  | Coding |
name | Σ C | 0..1 | string | Name for this Requirements (computer friendly)
title | Σ | 0..1 | string | Name for this Requirements (human friendly)
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
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 requirements
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for Requirements (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this Requirements is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
copyrightLabel |  | 0..1 | string | Copyright holder and year(s)
derivedFrom | Σ | 0..* | canonical(Requirements) | Other set of Requirements this builds on
reference |  | 0..* | url | External artifact (rule/document etc. that) created this set of requirements
actor |  | 0..* | canonical(ActorDefinition) | Actor for these requirements
statement | C | 0..* | BackboneElement | Actual statement as markdown FMTSR03: The text is not single spaced (there are multiple spaces). FMCC001: The Conditional Criteria is not structured correctly. FMCC002: The Criteria is structured as conditional but conditional is not indicated. FMSVR08: Optionality attribute does not match the optionality in the text. FMFLC15: Criterion must have a textual description.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
key |  | 1..1 | id | Key that identifies this statement
label |  | 0..1 | string | Short Human label for this statement
conformance |  | 0..* | code | SHALL | SHOULD | MAY | SHOULD-NOT Binding: ConformanceExpectation (required)
conditionality |  | 0..1 | boolean | Set to true if requirements statement is conditional
requirement |  | 1..1 | markdown | The actual requirement
derivedFrom |  | 0..1 | string | Another statement this clarifies/restricts ([url#]key)
parent |  | 0..1 | string | A larger requirement that this requirement helps to refine and enable
satisfiedBy |  | 0..* | url | Design artifact that satisfies this requirement
reference |  | 0..* | url | External artifact (rule/document etc. that) created this requirement
source |  | 0..* | Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who asked for this statement
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Requirements.language | required | AllLanguages `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` from the FHIR Standard
Requirements.versionAlgorithm[x] | extensible | VersionAlgorithm `http://hl7.org/fhir/ValueSet/version-algorithm` from the FHIR Standard
Requirements.status | required | PublicationStatus `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` from the FHIR Standard
Requirements.jurisdiction | extensible | JurisdictionValueSet `http://hl7.org/fhir/ValueSet/jurisdiction` from the FHIR Standard
Requirements.statement.conformance | required | ConformanceExpectation `http://hl7.org/fhir/ValueSet/conformance-expectation|5.0.0` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
FMCC001 | warning | Requirements.statement | The Conditional Criteria is not structured correctly. : (conditionality and requirement.toString().startsWith('IF ').not()).not() |
FMCC002 | warning | Requirements.statement | The Criteria is structured as conditional but conditional is not indicated. : (conditionality.not() and requirement.toString().startsWith('IF ')).not() |
FMFLC08 | warning | Requirements | Function names must not end with a period. : title.endsWith('.').not() |
FMFLC09 | error | Requirements | Function must have a statement about its purpose. : purpose |
FMFLC10 | warning | Requirements | Function purpose statement must end in a period. : purpose.toString().endsWith('.') |
FMFLC11 | error | Requirements | Function must have a description. : description |
FMFLC12 | warning | Requirements | Function description statement must end in a period. : description.toString().endsWith('.') |
FMFLC13 | error | Requirements | Function must have one or more conformance criteria statements. : statement.count() > 0 |
FMFLC15 | error | Requirements.statement | Criterion must have a textual description. : requirement.hasValue() |
FMSVR08 | warning | Requirements.statement | Optionality attribute does not match the optionality in the text. : requirement.toString().contains(conformance.first()) |
FMTSR03 | warning | Requirements.statement | The text is not single spaced (there are multiple spaces). : requirement.toString().contains(' ').not() |
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