Vulcan ePI FHIR Implementation Guide
0.1.0 - CI Build

Vulcan ePI FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Organization (ePI)

Official URL: http://hl7.org/fhir/uv/vulcan-epi/StructureDefinition/Organization-uv-epi Version: 0.1.0
Active as of 2022-09-02 Computable Name: OrganizationUvEpi

Organization (ePI)

Usage:

Formal Views of Profile Content

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

This structure is derived from Organization

Summary

Mandatory: 3 elements (4 nested mandatory elements)

Slices

This structure defines the following Slices:

  • The element Organization.type.coding is sliced based on the value of value:system
  • The element Organization.telecom is sliced based on the value of value:system

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... identifier 1..*IdentifierIdentifies this organization across multiple systems
.... system 1..1uriThe namespace for the identifier value
Binding: Organization identifier systems (extensible)
.... value 1..1stringThe value that is unique
... active 0..1booleanWhether this organization's record is in active use
... type
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:spor 0..*CodingSPOR (Europe)
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu
...... code 1..1codeSymbol in syntax defined by the system
... alias 0..*stringA list of alternate names for this organization
... Slices for telecom 0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... system 1..1codephone | fax | email | pager | url | sms | other
..... value 1..1stringThe actual contact point details
.... telecom:phone 0..*ContactPointPhone
..... system 0..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email 0..*ContactPointemail
..... system 0..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:url 0..*ContactPointWeb Site
..... system 0..1codephone | fax | email | pager | url | sms | other
Required Pattern: url
... address
.... use 0..1codehome | work | temp | old | billing
Required Pattern: work
.... type 0..1codepostal|physical|both
Required Pattern: physical
.... text 0..1stringText representation of the address
Example General: Brueningstrasse 50, Industriepark Höchst, 65926 Frankfurt am Main, GERMANY
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example General: Brueningstrasse 50, Industriepark Höchst
.... city 0..1stringName of city, town etc.
Example General: Frankfurt am Main
.... postalCode 0..1stringPostal code for area
Example General: 65926
.... country 0..1stringCountry (e.g. may be ISO 3166 2 or 3 letter code)
Example null: DE

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI1..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Binding: Organization identifier systems (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this organization's record is in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:spor Σ0..*CodingSPOR (Europe)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name ΣI0..1stringOrganization's legal name
... alias 0..*stringA list of alternate names for this organization
... Slices for telecom I0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone I0..*ContactPointPhone
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: phone
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email I0..*ContactPointemail
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: email
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:url I0..*ContactPointWeb Site
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: url
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address I0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing
Binding: AddressUse (required): The use of an address (home / work / etc.).


Required Pattern: work
.... type Σ0..1codepostal|physical|both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: physical
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Example General: Brueningstrasse 50, Industriepark Höchst, 65926 Frankfurt am Main, GERMANY
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: Brueningstrasse 50, Industriepark Höchst
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
Example General: Frankfurt am Main
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
Example General: 65926
.... country Σ0..1stringCountry (e.g. may be ISO 3166 2 or 3 letter code)
Example null: DE
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose

doco Documentation for this format

This structure is derived from Organization

Summary

Mandatory: 3 elements (4 nested mandatory elements)

Slices

This structure defines the following Slices:

  • The element Organization.type.coding is sliced based on the value of value:system
  • The element Organization.telecom is sliced based on the value of value:system

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... identifier 1..*IdentifierIdentifies this organization across multiple systems
.... system 1..1uriThe namespace for the identifier value
Binding: Organization identifier systems (extensible)
.... value 1..1stringThe value that is unique
... active 0..1booleanWhether this organization's record is in active use
... type
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:spor 0..*CodingSPOR (Europe)
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu
...... code 1..1codeSymbol in syntax defined by the system
... alias 0..*stringA list of alternate names for this organization
... Slices for telecom 0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... system 1..1codephone | fax | email | pager | url | sms | other
..... value 1..1stringThe actual contact point details
.... telecom:phone 0..*ContactPointPhone
..... system 0..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email 0..*ContactPointemail
..... system 0..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:url 0..*ContactPointWeb Site
..... system 0..1codephone | fax | email | pager | url | sms | other
Required Pattern: url
... address
.... use 0..1codehome | work | temp | old | billing
Required Pattern: work
.... type 0..1codepostal|physical|both
Required Pattern: physical
.... text 0..1stringText representation of the address
Example General: Brueningstrasse 50, Industriepark Höchst, 65926 Frankfurt am Main, GERMANY
.... line 0..*stringStreet name, number, direction & P.O. Box etc.
Example General: Brueningstrasse 50, Industriepark Höchst
.... city 0..1stringName of city, town etc.
Example General: Frankfurt am Main
.... postalCode 0..1stringPostal code for area
Example General: 65926
.... country 0..1stringCountry (e.g. may be ISO 3166 2 or 3 letter code)
Example null: DE

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣI1..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Binding: Organization identifier systems (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this organization's record is in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:spor Σ0..*CodingSPOR (Europe)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://spor.ema.europa.eu
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name ΣI0..1stringOrganization's legal name
... alias 0..*stringA list of alternate names for this organization
... Slices for telecom I0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone I0..*ContactPointPhone
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: phone
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email I0..*ContactPointemail
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: email
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:url I0..*ContactPointWeb Site
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: url
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address I0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing
Binding: AddressUse (required): The use of an address (home / work / etc.).


Required Pattern: work
.... type Σ0..1codepostal|physical|both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: physical
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Example General: Brueningstrasse 50, Industriepark Höchst, 65926 Frankfurt am Main, GERMANY
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: Brueningstrasse 50, Industriepark Höchst
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
Example General: Frankfurt am Main
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
Example General: 65926
.... country Σ0..1stringCountry (e.g. may be ISO 3166 2 or 3 letter code)
Example null: DE
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.identifier.systemextensibleVsOrganizationIdSystems
Organization.typeexampleOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:phone.systemrequiredPattern: phone
Organization.telecom:phone.userequiredContactPointUse
Organization.telecom:email.systemrequiredPattern: email
Organization.telecom:email.userequiredContactPointUse
Organization.telecom:url.systemrequiredPattern: url
Organization.telecom:url.userequiredContactPointUse
Organization.address.userequiredPattern: work
Organization.address.typerequiredPattern: physical
Organization.contact.purposeextensibleContactEntityType