commonprofiles-care / fhir

4 stars 2 forks source link

fhir

More info

Naming conventions

Suggestion: <Parent resource/profile>

Parent resource - This is Patient, Organization, Observation, ServiceRequest etc
Intended region - This is for which region the profile is intended to be used, options are SE (Sweden), Nord (Nordics), Eu (Europe), Int (international)
Publisher - This is who has published the profile, in our case this would be Industry as opposed to maybe HL7 Sverige
Profile type: Lite - Intended purpose is a very small resource that contains only the most important resource information. Use cases are e.g. when resources are referenced and included in other resources, or when the resource is used for simpler scenarios like populating a combo box/drop down list. Full - Intended purpose is a full resource model that contains all information related to the main resource. Use cases are to see and update the full resource.

Examples:

OrganizationSEIndustryLite
PatientSEIndustryLite
PractitionerSEIndustryLite

Parent resource - This is Patient, Organization, Observation, ServiceRequest etc Intended region - This is for which region the profile is intended to be used, options are SE (Sweden), Nord (Nordics), Eu (Europe), Int (international) Publisher - This is who has published the profile, in our case this would be Vendor as opposed to maybe HL7 Sverige. For the industry collaboration we will go with Vendor Profile type: Lite - Intended purpose is a very small resource that contains only the most important resource information. Use cases are e.g. when resources are referenced and included in other resources, or when the resource is used for simpler scenarios like populating a combo box/drop down list. Full - Intended purpose is a full resource model that contains all information related to the main resource. Use cases are to see and update the full resource.

The name will be in UpperCamelCase

OrganizationSECommonsLite PatientSECommonsLite PractitionerSECommonsLite

Canonical URL:s

Reopening just to clarify what the resulting canonical URL:s for our FHIR artifacts will look now that we have set the domain.

Suggestion: https:// commonprofiles.care/< resource type >/<profile/extension/value set name>

Examples: https://commonprofiles.care/StructureDefinition/OrganizationSECommonsLite https://commonprofiles.care/ValueSet/PerfectNameOfAPerfectValueSet https://commonprofiles.care/StructureDefinition/common-hsaHierarchy

Including the resource type follows the same pattern which is used both for the Swedish base profiles and also for the FHIR base resources and profiles. Examples: http://build.fhir.org/ig/HL7Sweden/basprofiler-r4/StructureDefinition-SEBaseOrganization.html https://www.hl7.org/fhir/bodyweight.html

Must support definition

Must Support in this implementation guide is used to indicate that if particular element is available in the source system, it SHALL be populated with data. The system consuming the data SHALL be able to save the data and act on it accordingly.

In case an element cannot be populated because it is not available in the source system, if the cardinality rules allow it, the element can be left unfilled. In case the cardinality rules require an element to be populated, the Data Absent Reason extension SHALL be used.