Guide d'implémentation Fr Core
2.1.0 - trial-use
Guide d'implémentation Fr Core
2.1.0 - trial-use
Guide d'implémentation Fr Core, published by Interop'Santé. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Interop-Sante/hl7.fhir.fr.core/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-pole | Version: 2.1.0 | |||
| Active as of 2024-10-29 | Computable Name: FRCoreOrganizationPoleProfile | |||
FR Core Organization Pole Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization |
0..* | Organization | A grouping of people or organizations with a common purpose | |
  meta |
||||
   Slices for profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
   profile:fr-canonical |
0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-pole | |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 shortName |
0..1 | string | FR Core Organization Short Name Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-short-name | |
| description |
0..1 | string | FR Core Organization Description Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-description | |
| budgetLetter |
0..1 | string | FR Core Organization Budget Letter Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-budget-letter | |
| usePeriod |
0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
| identifier |
||||
 use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Organization identifier type (extensible) | |
| system |
1..1 | uri | The namespace for the identifier value | |
 value |
1..1 | string | The value that is unique | |
| type |
0..1 | CodeableConcept | Kind of organization Binding: FR Core ValueSet Organization type (extensible) | |
 partOf |
0..1 | Reference(FR Core Organization Profile) | The organization of which this organization forms a part | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: FR Core ValueSet Organization type (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-usefrom the FHIR Standard | |
| Organization.identifier.type | extensible | FRCoreValueSetOrganizationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-identifier-typefrom this IG | |
| Organization.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | |
| Organization.partOf.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| shortName |
0..1 | string | FR Core Organization Short Name Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-short-name | |
| description |
0..1 | string | FR Core Organization Description Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-description | |
| budgetLetter |
0..1 | string | FR Core Organization Budget Letter Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-budget-letter | |
| usePeriod |
0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
 type |
Σ | 0..1 | CodeableConcept | Kind of organization Binding: FR Core ValueSet Organization type (extensible) |
| partOf |
Σ | 0..1 | Reference(FR Core Organization Profile) | The organization of which this organization forms a part |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: FR Core ValueSet Organization type (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | |
| Organization.partOf.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
| profile:fr-canonical |
Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-pole | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| shortName |
0..1 | string | FR Core Organization Short Name Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-short-name | |||||
| description |
0..1 | string | FR Core Organization Description Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-description | |||||
| budgetLetter |
0..1 | string | FR Core Organization Budget Letter Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-budget-letter | |||||
| usePeriod |
0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Organization identifier type (extensible) | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| type |
Σ | 0..1 | CodeableConcept | Kind of organization Binding: FR Core ValueSet Organization type (extensible) | ||||
| name |
ΣC | 0..1 | string | Name used for the organization | ||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom |
C | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
| address |
C | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
| partOf |
Σ | 0..1 | Reference(FR Core Organization Profile) | The organization of which this organization forms a part | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: FR Core ValueSet Organization type (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| 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 | ||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name |
0..1 | HumanName | A name associated with the contact | |||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-usefrom the FHIR Standard | ||||
| Organization.identifier.type | extensible | FRCoreValueSetOrganizationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-identifier-typefrom this IG | ||||
| Organization.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | ||||
| Organization.partOf.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from Organization
Summary
Mandatory: 0 element(3 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization |
0..* | Organization | A grouping of people or organizations with a common purpose | |
| meta |
||||
| Slices for profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
| profile:fr-canonical |
0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-pole | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| shortName |
0..1 | string | FR Core Organization Short Name Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-short-name | |
| description |
0..1 | string | FR Core Organization Description Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-description | |
| budgetLetter |
0..1 | string | FR Core Organization Budget Letter Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-budget-letter | |
| usePeriod |
0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
| identifier |
||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Organization identifier type (extensible) | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| type |
0..1 | CodeableConcept | Kind of organization Binding: FR Core ValueSet Organization type (extensible) | |
| partOf |
0..1 | Reference(FR Core Organization Profile) | The organization of which this organization forms a part | |
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: FR Core ValueSet Organization type (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-usefrom the FHIR Standard | |
| Organization.identifier.type | extensible | FRCoreValueSetOrganizationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-identifier-typefrom this IG | |
| Organization.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | |
| Organization.partOf.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| shortName |
0..1 | string | FR Core Organization Short Name Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-short-name | |
| description |
0..1 | string | FR Core Organization Description Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-description | |
| budgetLetter |
0..1 | string | FR Core Organization Budget Letter Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-budget-letter | |
| usePeriod |
0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| type |
Σ | 0..1 | CodeableConcept | Kind of organization Binding: FR Core ValueSet Organization type (extensible) |
| partOf |
Σ | 0..1 | Reference(FR Core Organization Profile) | The organization of which this organization forms a part |
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: FR Core ValueSet Organization type (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | |
| Organization.partOf.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
| profile:fr-canonical |
Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-pole | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| shortName |
0..1 | string | FR Core Organization Short Name Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-short-name | |||||
| description |
0..1 | string | FR Core Organization Description Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-description | |||||
| budgetLetter |
0..1 | string | FR Core Organization Budget Letter Extension URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-organization-budget-letter | |||||
| usePeriod |
0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: FR Core ValueSet Organization identifier type (extensible) | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| type |
Σ | 0..1 | CodeableConcept | Kind of organization Binding: FR Core ValueSet Organization type (extensible) | ||||
| name |
ΣC | 0..1 | string | Name used for the organization | ||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom |
C | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
| address |
C | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
| partOf |
Σ | 0..1 | Reference(FR Core Organization Profile) | The organization of which this organization forms a part | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: FR Core ValueSet Organization type (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| 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 | ||||
| purpose |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name |
0..1 | HumanName | A name associated with the contact | |||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-usefrom the FHIR Standard | ||||
| Organization.identifier.type | extensible | FRCoreValueSetOrganizationIdentifierTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-identifier-typefrom this IG | ||||
| Organization.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | ||||
| Organization.partOf.type | extensible | FRCoreValueSetOrganizationTypehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-organization-typefrom this IG | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | 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() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from Organization
Summary
Mandatory: 0 element(3 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron